This is a new service - your feedback (opens in a new tab) will help us to improve it.

  1. Home
  2. APIs
  3. DfEInformationAPI_V1

DfE Information API

Lifecycle stageLive
Open API fileView Open API file
GuidelineDownload guideline
Supported Authorisation types
  • Open-Information
  • Application Restricted
  • User-Restricted
  1. Overview
  2. Versioning
  3. API browser and Open API file
  4. HTTP status codes
  5. Request rate limit
  6. Endpoints

Overview

We have created the DfE Information API to show users what the Developer Hub can do. It allows software developers to connect with the Developer Hub and access some basic information about DfE. This shows the developers they can access:

  • low restricted endpoint APIs - for example, open-info
  • application restricted endpoint APIs - for example, application-info
  • user restricted endpoint APIs - for example, user-info

For more details about the different access levels, read the authorisation section.

For more information about how to develop your own client applications, including example clients for this API, see our tutorials.

Versioning

When an API changes, we will make backwards compatible changes where we can. When this is not possible, we will add a note about deprecated endpoints and make a new endpoint available.

The current live version of the DfE Information API is 1.0.

API browser and Open API file

For more details about the DfE Information API, open an API browser like Swagger Editor and copy the Open API file content into it.

You can also generate a client library from the Open API file using Swagger Editor.

HTTP status codes

The DfE Information API uses standard HTTP response code conventions:

  • 100 codes give information
  • 200 codes mean success
  • 300 codes mean a redirection
  • 400 codes mean a client-side error
  • 500 codes mean a server-side error

Common status codes are:

  • 200 - OK - the request has been processed successfully
  • 400 - bad request - the incoming request body or parameters do not conform with the Open API document that describes the API
  • 403 - Service Unavailable - the service is currently unavailable
  • 429 - Too Many Requests - the client’s limit has been exceeded
  • 504 - Gateway Timeout - there is a network connection problem within the layers of the API fulfilment stack

We use HTTP status codes instead of API error codes.

Request rate limit

We limit how many API requests you can make each minute.

If you go over the limit, you will receive a 429 Too Many Requests HTTP status code for each request you make within the remainder of the time.

Each minute, you can make up to 10 GET requests for each endpoint.

Endpoints

/dfe/open-info
GET
/dfe/application-info
GET
/dfe/user-info
GET