There are 2 types of APIs listed within the Department for Education (DfE) Find and Use an API catalogue.
1. Linked APIs
These are APIs which are:
- Listed within the Department for Education (DfE) Find and Use an API catalogue but links to another service or location where those APIs are managed.
- Added to the Department for Education (DfE) API catalogue for audit and reporting purposes
- Added for discovery but users cannot directly subscribe to them.
2. Hosted APIs
These are APIs which are:
- Fully managed through the Department for Education (DfE) Find and Use an API service
- Directly accessed via the Department for Education (DfE) Find and Use an API service
- Users can directly subscribe and unsubscribe to these APIs through the Find and Use an API Consumption Portal.
Linked APIs provide awareness and discovery whilst Hosted APIs offer discovery, direct access and control.