Overview
This demonstration API is provided to allow any user to test the process of subscribing and connecting to an API using the Find and Use an API service.
Access to this API is secured by:
- Subscription key
- Native OAuth application flow
Documents
- FaUAPI-Demo-Function.json
- Uploaded schema
Who can use this API
Anyone who signs in to the Find and Use an API service using a GOV.UK One Login account.
Service level
This is an example service and has no SLA
Technologies
C# .NET
Environments
| Environment | Base URL |
|---|---|
| Dev | https://dev-api.education.gov.uk/dev/fauapi-demo-api-public-oauth/2 |
You need to sign in to subscribe to an API environment or view your existing subscriptions.
Groups
API groups allow you to connect to multiple APIs or versions of an API with a single set of credentials. This API is a member of the following groups:
| Group name | Description |
|---|---|
| example-api-group | This is an example API group which contains a set of APIs demonstrating the features of Find and Use an API |
Current release
| Release name | Available from |
|---|---|
| 1.0 | 18 September 2024 |
Other releases
| Release name | Available from | Available to |
|---|---|---|
| 0.9 | 10 August 2024 | 17 September 2024 |
Operations
GET Download
- Description
-
Downloads a file specified by the file name
- URL template
- /Download/{filename}
GET List
- Description
-
Lists all files which have been uploaded
- URL template
- /List
POST Upload
- Description
-
Uploads a file
- URL template
- /Upload
POST Echo-Post
- Description
-
Simple POST endpoint which echos all the requested data into JSON format including a plain text body
- URL template
- /Echo-Post
Back to top