IOMG Technical Standard: Application Programming Interface (API) Integration
The Isle of Man Government has decided to standardise for its data, functions and processes to be wholly driven using Application Programming Interfaces (API). GTS believe that by allowing systems to both consume and expose functions across the organisation, the Isle of Man Government can begin to almost immediately realise the following outcomes:
- De-duplication of data, functions and processes across the organisation
- The ability for rapid business reconfiguration
- Better documented processes and procedures for better supplier engagement
- Ensure value for money in the systems that are developed and procured
With this in mind, any new system that is being developed internally, externally or is subject to procurement, must conform the following high level principles:
-
The system needs to be able to publish a function as an API (REST) to be consumed in a B2B capacity
- Web Service (SOAP) is also acceptable if approved by GTS
-
The system must be able to subscribe to external data sources using RESTful (XML/JSON)
- Web Service (SOAP) is also acceptable if approved by GTS
It is expected that any system that exposes API's, as a point of entry into that system, that its associated API's adhere to the following:
- Conformance to the Isle of Man Government Technology strategies, standards and guidelines
- Be scalable in accordance to demand to meet expected and predefined Service Level Agreements
- Be deployable independently with minimal impact to existing dependencies
- Implement versioning with the capability of side by side execution as and when required
- To handle unexpected events in a controlled manner including quality error handling
- To take into account Open Standard principles.
Whilst this document details preferred methods, patterns and practices, there are alternative options that may be considered as part of a requested GTS review. Such reviews will be carried out on a case by case basis and take into consideration factors pertinent to the review case.