Policy Requirements
API policy requirements are as follows:
-
Understand the evolving API technology environment
The development approach and design decision should be informed by an understanding of current and emerging API development best practice.
-
Develop a comprehensive understanding of non-functional requirements and considerations
Before commencing any technology investigation, entities should analyse and assess their specific needs and determine requirements for their API solution.
-
Utilise api.gov.au as a central resource
api.gov.au is maintained for Whole of Government (WofG) API development and distribution, providing guidance, related templates, and visibility of new API releases. The site provides guidance on what is already expected as the minimum standard for API development and maintains a repository that should be published where suitable.
-
Adhere to reuse principles
Analyse the current API technology environment against your requirements, identifying gaps and opportunities for reuse. Ensure the ongoing viability of API solutions through continual improvement of processes, and features, data, security, technology, skills, and cost.
-
Lower development and maintenance complexity of API solutions
Low-code/no-code documented process and business rules logic that may be utilised across the development of multiple API channels and interfaces.
-
Determine an appropriate API release, fair use, and distribution strategy
API owners have discretion over how, and to whom, they release APIs that facilitate interfacing with their systems. A transparent approach to availability for release, conditions of use and the distribution mechanism, is encouraged.
-
Ensure the sustainability of API solutions
Continual improvement of processes, and features, data, security, technology, skills, and cost should remain a focus to maximise functionality, reduce risk, and minimise accumulation of technical debt.