This guide will help you collaborate, publish, maintain, and administer DfE's APIs accessed by the public through the Find and Use an 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
- Managing workspace APIs
- Managing workspace members
- Managing workspace automation
- Managing workspace named values
- Managing workspace reporting
- 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 Creating a new workspace.
The Department of Education (DfE) Find and Use an API Management Portal is only accessible using a DfE Azure Entra ID and requires multi-factor authentication (MFA).
You will need to sign in using your DfE Azure Entra ID in other to access and view any of the protected pages within the Find and Use an API Management Portal.
If you are not signed in, you will be able to view the standard static content and site information only, including accessibility policy, terms and conditions, privacy policy, cookie policy, and the link to the contact us form. Any attempt to view any protected pages requiring authentication, will redirect you to the Sign-in page.