Understanding the Find and Use an API Consumption Portal Home page is important. It is the first page you see when you arrive at the Portal, and helps you navigate easily across all other pages and parts of the portal.

The Home page is laid out in a familiar and easy to navigate configuration comprising of the following sections:

  • Header - The blue area (comprising of dark and gradient blue) found at the top of the home page.
  • Main body - The larger white area in the middle of the page for the main content.
  • Footer - The grey area found at the bottom of the home page.

Header section

As part of the header section are the following elements:

  • Department for Education logo and service name located at the top left. It informs you of the location you are visiting, so you are sure you are at the right place. The hyperlinked logo and service name when selected brings you back to the Home page as the default starting page.

  • Sign in link at the top right of the page allows you to sign in with your education.gov.uk credentials, so you can access more authenticated protected pages of the portal.

  • Top navigation area with tab menu options:

    • Home - This always takes you to the Home page as the default starting page when selected.
    • Find an API - Takes you to the Find an API Search page.
    • Getting started - Takes you to the Getting started guide to help you get started with finding and using any available API within the DfE API catalogue.
    • Support - Takes you to the Support page with information on how to get support for the service.

Below the navigation menu is some text advising on the release tag and a link to our feedback form where you can give any suggestions to help improve the service.

Finally, within this section you will find the:

  • Page tile - The page title indicate what the page is about, together with a welcome message.
  • Caption - A summary on what to expect with the service provided by the portal.

Main body section

Within the main body of the Home page is the Upcoming Maintenance windows information. This shows you details of any upcoming maintenance windows and any areas of the service that will be impacted.

Below the Upcoming maintenance windows information is the main page section service feature menu options including:

  • Getting started - Provides you with a guide on understanding key concepts of the service including the process of finding, using and testing DfE APIs.
  • Find an API - This shows you to the Search page to help you find the API you need within the DfE API catalogue.
  • Help and support - Shows you the documentation and guides you need to help you use the Find and Use an API service.

This is the final section at the bottom of the Home page with Site information which you can view and read without the need to sign in including:

  • Terms and conditions - Provides you with the terms and conditions for using the Department for Education's (DfE) Find and Use an API website and material relating to government information, products and services (or to third party information, products and services).
  • Accessibility statement - Shows you the accessibility statement outlining what has been done to make it possible for a diverse range of people to be able to use the Find and Use an API Consumption Portal and website.
  • Privacy policy - Shows you the privacy policy relating to the information that is stored and processed about you as a Find and Use an API user.
  • Cookie policy - Shows you the cookie policy relating to small files (known as 'cookies') that are put onto your computer to collect information when you access and use the Find and Use an API service.
  • Contact us - A form that allows you to report a problem, ask a question, or suggest an improvement.