Apprenticeship Service API Standards
Introduction
The Apprenticeship Service API Standards draw influence from the following.
- API technical and data standards (v2 - 2019)
- Technology Code of Practice
- DfE API Strategy - May 2019, V3.0 (no link available)
This guide provides the standards which are to be applied to any new APIs developed within the Apprenticeship Service.
The guide is split into the following sections.
| Section | Description |
|---|---|
| Aims and objectives | Describes the aims and objectives of standardising the approach to APIs across the service |
| API Patterns | Describes how APIs fit into the bigger picture of building Digital Services and the selected patterns |
| API Design | Provides guidance and details of specific standards to use when building your API. Any new API will be reviewed against these standards before being allowed to go-live |
| Iterating your API | Provides guidance and standards of how to evolve your API. Includes details of how to version, and how to ensure your API is resilient to change |
| External APIs | Provides specific guidance for delivering external APIs (those APIs which are consumed by clients outside of the Apprenticeship Service) |
| Governance Process | Provides details about how your new API will be |