id stringlengths 2 36 | c stringlengths 1 901 ⌀ | x float64 |
|---|---|---|
h1 | About APIs | null |
para1 | Find out what an API can do to improve your customer’s experience. | null |
part1 | null | null |
part1-title | What is an API? | null |
part1-para1 | Application Programming Interfaces (APIs) define the ways in which applications and software components communicate with each other. | null |
part1-para2 | The term usually refers to web-based APIs, which underpin digital ecosystems by making services and information easily available within and across organisations. | null |
part2 | null | null |
part2-title | Benefits of an API | null |
part2-para1 | APIs allow: | null |
part2-para1-1 | open or appropriately secured information and data to flow within government | null |
part2-para1-2 | government and non-government systems to interact with each other | null |
part2-para1-3 | information to be held in 1 place but used and reused in many places | null |
part2-para1-4 | active support for the principles for open and transparent government. | null |
part2-para2 | An API: | null |
part2-para2-1 | saves time — updated information is available through the API automatically | null |
part2-para2-2 | helps to make information more reliable as it managed from 1 source | null |
part2-para2-3 | makes it possible to share information through many sources in a consistent way | null |
part2-para2-4 | increases the focus on customer needs by enabling agencies to share information and deliver multi-agency or ‘joined-up’ services more efficiently. | null |
h1 | API guidelines | null |
para1 | <em>Learn about how government agencies are implementing APIs to their systems and what the benefits are of doing this.</em> | null |
para2 | The API guidelines 2022 provide government agencies context for API standards, focused design and implementation guidance, and API best practices. This is intended to help agencies achieve a consistent and common approach to developing and delivering APIs. | null |
part1 | null | null |
part1-title | The API guidelines 2022 | null |
part1-para1 | The guidelines are split into the following 3 parts: | null |
part1-section1 | null | null |
part1-section1-title | <a href="https://docref.digital.govt.nz/nz/dia-apis-parta/1/en/">Part A: API concepts and management 2022</a> | null |
part1-section1-para1 | Part A contains the business context for APIs within government. It describes the principles and considerations that creating APIs could impact an agency, across government and public services, and commercial innovation. This replaces the version published in 2016 called API standard and guidelines — Part A: Business. | null |
part1-section2 | null | null |
part1-section2-title | <a href="https://docref.digital.govt.nz/nz/dia-apis-partb/1/en/">Part B: API security 2022</a> | null |
part1-section2-para1 | Part B contains the API security reference architecture and technical details for implementing API security. This replaces the 2016 version called API standard and guidelines — Part B: Technical, which has been split into 2 parts for the 2022 version — Part B: API security and Part C: API development. | null |
part1-section3 | null | null |
part1-section3-title | <a href="https://docref.digital.govt.nz/nz/dia-apis-partc/1/en/">Part C: API development 2022</a> | null |
part1-section3-para1 | Part C contains the technical details for API development, including general API implementation standards for API developers and consuming application developers. | null |
part1-section3-para1-ex1 | null | null |
part1-section3-para1-ex1-exl1 | <strong>Note:</strong> | null |
part1-section3-para1-ex1-exl2 | These guidelines: | null |
part1-section3-para1-ex1-exl2-1 | are intended to apply for all API standards and protocols, however much of the guidance is oriented to REST (Representative State Transfer) APIs | null |
part1-section3-para1-ex1-exl2-2 | use hypothetical or actual use cases with a government context to illustrate practical application of the concepts described. Examples do not represent recommended API design and / or data content requirements for the NZ government. | null |
part2 | null | null |
part2-title | Target audience | null |
part2-section1 | null | null |
part2-section1-title | Part A: API concepts and management | null |
part2-section1-para1 | The target audience for part A is primarily technical business people who need to understand the value and benefit of APIs and gain an appreciation of what is involved and needs to be in place. | null |
part2-section1-para2 | Part A also provides the context for parts B and C for enterprise architects, solution architects and API developers in agencies. | null |
part2-section1-para3 | It may be of interest to commercial entities, non-governmental organisations (NGOs) or other third parties who are developing, or planning to develop, applications that use government APIs. | null |
part2-section2 | null | null |
part2-section2-title | Part B: API security and Part C: API development | null |
part2-section2-para1 | The target audience for parts B and C is primarily solution designers and API developers in agencies and organisations within the public service. | null |
part2-section2-para2 | Additionally, compliance and assurance personnel may be interested in terms of assessing alignment with the standards and guidelines. | null |
part3 | null | null |
part3-title | Application of the guidelines | null |
part3-para1 | The main reason for these guidelines is to give agencies and vendors some common, default guidance on API implementation to help accelerate the development of government APIs. | null |
part3-para2 | Therefore, most of the specific technical guidance is marked as ‘recommended’ rather than mandatory. Exceptions tend to be in areas of security, authorisation and referenced standards compliance. | null |
part3-para3 | It is recognised that many sectors or industries will have existing APIs and associated standards, which may be established and governed outside an agency’s control. In such cases, industry standards will prevail, but agencies are encouraged to review their existing use of APIs against these guidelines and consider whe... | null |
part3-para4 | Agencies that have their own existing APIs will also need to balance the risk and cost of the change against the benefits of conforming with these guidelines — a phased approach may be appropriate. | null |
part4 | null | null |
part4-title | Feedback welcomed | null |
part4-para1 | Agencies are asked to provide feedback on these updated guidelines, about their usability, effectiveness and any areas of ambiguity, to the Agency Standards and Integration team at <a href="mailto:gcdo@dia.govt.nz">gcdo@dia.govt.nz</a>. | null |
part5 | null | null |
part5-title | Acknowledgements | null |
part5-para1 | The API guidelines were initially commissioned and endorsed jointly by the Government Enterprise Architecture Group and the ICT Partnership Framework Technology Working Group in 2016. | null |
part5-para2 | In 2022, these guidelines were updated to reflect current API practice. | null |
part5-para3 | Te Tari Taiwhenua Department of Internal Affairs would like to thank the many agency representatives and <a href="https://www.middleware.co.nz/#/">Middleware NZ</a> who helped to produce these guidelines. | null |
part6 | null | null |
part6-title | Related advice | null |
part6-para1 | One of the key drivers of APIs is to unlock government data sources, so APIs need to be as easy as possible for developers to discover, understand and develop against. They need to be simple to understand and well described. | null |
part6-para1-1 | <a href="/standards-and-guidance/governance/copyright-and-licensing">Copyright and licensing (NZ-GOAL)</a> | null |
part6-para1-2 | <a href="/standards-and-guidance/data">Data</a> | null |
part6-para1-3 | <a href="https://www.ict.govt.nz/guidance-and-resources/open-government/new-zealand-data-and-information-management-principles/">Data and information management principles — Data.govt.nz</a> | null |
part6-para1-4 | <a href="/standards-and-guidance/technology-and-architecture/government-enterprise-architecture">Government enterprise architecture</a> | null |
part6-para1-5 | <a href="/standards-and-guidance/governance/managing-online-channels/web-information-and-data-lifecycle/content-re-use">High-level advice about content reuse</a> | null |
part6-para1-6 | <a href="/digital-government/international-partnerships/international-open-data-charter">Open data charter</a> | null |
part6-para1-7 | <a href="https://www.govt.nz/about/about-this-website/api/">Re-using Govt.nz content and data — Govt.nz</a> | null |
h1 | API guidelines — Part A: API concepts and management 2022 | null |
para1 | APIs (Application Programming Interfaces) enable reuse of data, transactions and rules. This creates an opportunity for greater cooperation and interoperability between agencies to dramatically improve service design and delivery. | null |
part1 | null | null |
part1-title | 1. API concepts | null |
part1-section1 | null | null |
part1-section1-title | 1.1. Why an API | null |
part1-section1-para1 | Interoperability between government agency systems and customers today involves a wide complex range of mechanisms, protocols, standards, technology and so on, and the idea of using APIs is to decouple the interface from this complexity as much as possible. | null |
part1-section1-para2 | A clearly defined API specification provides a common language and ensures a common understanding of the interaction. So, with APIs, the consuming application only needs to understand the interface and does not need to understand the underlying technologies. This greatly simplifies the interaction and encourages intero... | null |
part1-section2 | null | null |
part1-section2-title | 1.2. What is an API | null |
part1-section2-para1 | An API is a computing interface that defines a shared boundary across which 2 or more components exchange information. In practice, an API is generally a piece of software that provides a way for other disparate pieces of software (applications, systems) to talk to one another. It can be considered as a: | null |
part1-section2-para1-1 | means of requesting and retrieving information from a system or server so that it can then be presented to the user in a context / process-specific way — for example, in a mobile application or web application | null |
part1-section2-para1-2 | way of de-coupling system-to-system interactions | null |
part1-section2-para1-3 | contract between the application developer and the provider describing what information or functionality they can gain access to and how that access is provided. | null |
part1-section2-para2 | APIs are commonly categorised as shown in table 1: | null |
part1-section2-para2-tb1 | null | null |
part1-section2-para2-tb1-caption | Table 1: Common categories of API | null |
part1-section2-para2-tb1-tc1 | null | null |
part1-section2-para2-tb1-tc2 | null | null |
part1-section2-para2-tb1-thr1 | null | null |
part1-section2-para2-tb1-thr1-th1 | API category | null |
part1-section2-para2-tb1-thr1-th2 | Description | null |
part1-section2-para2-tb1-tr1 | null | null |
part1-section2-para2-tb1-tr1-td1 | Internal API | null |
part1-section2-para2-tb1-tr1-td2 | An API that is used solely within your organisation by known internal personnel (employees or contractors). For example, an API that provides revenue forecasting information. | null |
part1-section2-para2-tb1-tr2 | null | null |
part1-section2-para2-tb1-tr2-td1 | External API | null |
End of preview. Expand in Data Studio
README.md exists but content is empty.
- Downloads last month
- 7