To explore and use an API:

  1. Sign in with your GOV.UK One Login account(as detailed in the Creating an account section).
  2. Find the API you wish to use.
  3. Select the name of the API you wish to use from the search result. This will show you the API details page. The information on this page is grouped into sections depending on the API and the details supplied by the API provider including:

  • Header - Located at the top of the page with details including:

    • API Name
    • API description
    • API Version
    • Release version
    • API type

  • Overview - Gives you a summary of the purpose of the API.

  • Documents - Gives you information relating to any technical documents supplied by the API provider including:

    • Data structure information
    • Uploaded schema (JSON Format)

  • Environments - Gives you information relating to the available environments for the API including:

    • Environment (Dev, Staging or Live)
    • Base URL
    • Action (View or Subscribe)

  • Operations - Gives you information relating to available operations and URL template for an API including:

    • Operation Method (GET, POST, etc)
    • Description
    • URL template

If you are already subscribed to an API, the Action link within the Environments section will be displayed as View. This means you can view any subscriptions to the API. If you are not already subscribed, the Action link will be displayed as Subscribe, allowing you to subscribe to the API.

You can view and manage subscriptions as detailed in Managing your API subscriptions.