| Term | Definition |
|---|---|
| API | Application Programming Interface. A set of rules or protocols that enables software applications to communicate and exchange data, features and other functionalities. |
| API type | This refers to the different types and classification of APIs within DfE's Find and Use an API catalogue. There are either of Linked or Hosted API type. |
| Authentication | |
| Automation token | |
| Backend type | This specifies the type of protocol, or rules used between the API service and client to send requests and receive responses. The option can include HTTP, SOAP or GraphQL. |
| Base URL | The location address of the backend server for the hosted API environment. Required for Hosted APIs only- another difference between the required configuration for a Hosted and that for a Linked API. |
| Bearer token | |
| Beta | Beta testing release is the release after the alpha releaseand can be considered a form of external user acceptance. It is usually versions released to a limited external audience or public to increase the feedback. |
| CDDO | Central Digital and Data Office, part of the Cabinet Office responsible for the digital transformation of services. It leads the Government Digital and Data function for the UK government. |
| Data Exposure classification | These classifications control who can access, view, subscribe to an API and the level of data exposed when consuming the API. |
| DfE | Department for Education |
| Documents | |
| Environments | |
| FaUAPI | Find and Use an API |
| Filtering | |
| JPG | |
| Metadata | Information about an API which will be presented to users of the Find and Use an API Consumption Portal. |
| Operations | |
| Overview | |
| Pagination | |
| PNG | |
| Policies | AAAAA |
| Project URL | |
| Release tag | |
| Schema type | |
| Service level | |
| Status | |
| Subscriptions | |
| Tags | |
| Visibility |
Exclusion path A specific use case for this, is that of OpenAI integration where they want to expose the chatGPT API through APIM, however some of the tools that you use it from do not support open authentication and some do. It was important to be able to segregate them and allow those that do.
That way, a set of users can be sent through one path and others through another path, thereby creating a tidy split.