FMS API Integration with Fau API - Supplier Test Environment (STE) & Production Environment (Prod)
FMS Supplier General GuidanceThis article sits within the FMS Supplier General Guidance sectionAPI Portal
This is the link to access the Find and Use an API portal for STE and Production environments.
https://beta-find-and-use-an-api.education.gov.uk/
Create an account or login with credentials via GOV.UK One Login
Creating GOV.UK One Login Account -
API Subscription
After logging into the API catalogue portal, click the Find an API card
On the Find an API page, enter the keywords ‘Academies FMS’ in the search box.
Press ‘Enter’ on keyboard to search.
Click on Academies FMS Accounts Return (STE) in the search result
For Production search -
Click on Academies FMS Accounts Return in the search result
Users must subscribe to the API (STE) and subscribe to the API (Production)
This will navigate users to a page to submit access request.
The following details must be entered on the Subscribe to an API page
•Subscription Name
•Justification for usage
•OAuth Redirect URI (https://jwt.ms can be used when using Postman)
Approval requests are sent to the relevant team.
API Credentials
Login and navigate to My Subscriptions where approved subscription are displayed
Click on Manage Subscription link
Click on View link on the next page
Here you can see your subscription and credential details
USAGE Steps
1. Get API Code (STE)
Start URL (STE) : https://fauapib2c.b2clogin.com/fauapib2c.onmicrosoft.com/oauth2/v2.0/authorize?p=B2C_1A_CONSENT_DFE_STE&client_id=<client_id>&nonce=defaultNonce&redirect_uri=https%3A%2F%2Fjwt.ms&scope=openid&response_type=code&upin=<Upin>&prompt=login&apiFamily=bfrp-ar
Update the following query params value in the URL:
•client_id – OAuth Client ID on API Subscription Page: Native OAuth Application-flow section
•Upin or Companies House Number (Please note that UPIN will not be available as a trust identifier from AR 26/27, and all FMS software will only be able to use Companies House Number) •
Can update the params value in notepad or postman
Get API Code (PROD)
Start URL (Production) : https://fauapib2c.b2clogin.com/fauapib2c.onmicrosoft.com/oauth2/v2.0/authorize?p=B2C_1A_CONSENT_DFE&client_id=<client_id>&nonce=defaultNonce&redirect_uri=https%3A%2F%2Fjwt.ms&scope=openid&response_type=code&upin=<Upin>&prompt=login&apiFamily=bfrp-ar
Update the following query params value in the URL:
•client_id – OAuth Client ID on API Subscription Page: Native OAuth Application-flow section
•Upin and Companies House Number (Please note that UPIN will not be available as a trust identifier from AR 26/27, and all FMS software will only be able to use Companies House Number)
Can update the params value in notepad or postman
Using a new/private browser window, paste the updated link to access the DfE Sign In (DSI) and log in with email and password. You will be redirected to the Consent page.
On successful consent acceptance, user will be redirected to the Redirect URIs set on subscription for the API with the code as query param value
2. Get Bearer Token
•The code is from last step
•The others are from the API subscription details
•client_id is ‘OAuth Client ID’
•client_secret is ‘Primary key’
•scope is ‘OAuth Scope’
•redirect_uri is the one set at API subscription
•access_token in the response is the Bearer Token to be used for the submission API call
Token Endpoint (STE): https://fauapib2c.b2clogin.com/fauapib2c.onmicrosoft.com/oauth2/v2.0/token?p=B2C_1A_CONSENT_DFE_STE
Token Endpoint (Production):
https://fauapib2c.b2clogin.com/fauapib2c.onmicrosoft.com/oauth2/v2.0/token?p=B2C_1A_CONSENT_DFE
3. Submission
The subscription endpoint is the Base URL from the API subscription details appended with ‘/api/subscriptions’
(STE) - https://api.education.gov.uk/fms-ste/1/api/submissions
(Production) - https://api.education.gov.uk/fms/1/api/submissions
Headers
•Ocp-Apim-Subscription-Key – Primary key value on Subscription key details
•Enable-Dev-Error-Details - true/false (For error details returned in response)
Final Submission using Postman/ supplier application
Update Body with raw json data.
Check COA Version.
Check Academies allowed for trust.
Submit request.
Submission completed successfully using Submissions API.
4. Verification
Login to online forms and verify submission status
•(STE) - https://onlinecollections-ste.education.gov.uk/
•(Production) - https://onlinecollections.education.gov.uk/
Last updated on