This guide will help you collaborate, publish, maintain, and administer DfE's APIs accessed by the public through the Find and Use API Consumption Portal.
The core concept behind the DfE Find and Use an API Management Portal is that of Workspaces. With workspaces, you can collaborate with other users to publish and maintain APIs. Everything is configured, managed and contained within a workspace.
A user can own and be part of multiple workspaces. This means you can create workspaces of your own, or be invited to workspaces owned by other users.
This guide will help you get started with:
- Signing in
- Creating a new workspace
- Managing a workspace
- Managing workspace approval requests
- Administering a workspace
- Getting help and support
If you're a brand new user to the DfE's Find and Use an API Management Portal, the next step after you have created an account is to Request a new workspace.
The Department of Education (DfE) API Management Portal is only accessible using a DfE Azure Entra ID and requires multi-factor authentication (MFA).
You will need to sign in to access and view any of authentication protected pages within the Find and Use an API Management Portal.
If you are not signed in, you will only be able to view the standard static content and site information including accessibility policy, terms and conditions, privacy policy, cookie policy, and link to the contact us form. Any attempt to view any authentication protected pages will redirect you to the Sign-in page.