Overview
This API can be used or demo purposes or to test connectivity to APIs hosted in Find and Use and API. This API has two GET operations that both return a simple JSON response. One of the operations is protected by OAuth and a Bearer token must be provided when making calls to it.
Documents
- FaUAPI-Example-API.json
- Uploaded schema
Environments
| Environment | Base URL |
|---|---|
| Live | https://api.education.gov.uk/example |
You need to sign in to subscribe to an API environment.
Current release
| Release name | Available from |
|---|---|
| 1 | 14th December 2024 |
Operations
GET Basic GET request
- Description
-
Provides a sample piece of text in response to a GET request. This operation does not require an Authorization header.
- URL template
- /getInformation
GET Basic GET request requiring OAuth authentication
- Description
-
An OAuth protected operation. Provides a sample piece of text in response to a GET request when a suitable Bearer token is included in the Authorization header.
- URL template
- /getInformationOauth
Back to top