API

As part of the drive to open up the wealth of resources available via the Excellence gateway the project team has developed and opened up an Application Programme Interfaces (APIs) to third parties. This allows any third party access to the repository underpinning the Excellence gateway and all of the associated data, allowing the sector true open access to their own data. This approach we hope will help deliver full transparency and allow the sector to innovatively use the resources available.

The Excellence Gateway Read API provides a simple, REST-like way to access the resources on the Excellence Gateway. It provides metadata about each resource and search functionality to discover relevant resources.

The Excellence Gateway is a repository of resources. These are categorized according to several controlled vocabularies of terms. Resources are either documents that can be downloaded, or small self-contained online resources that can be accessed via a web browsed. Documents are described by a set of metadata, and searches against content and against metadata are available using a standard SOLR search URL syntax.

The design of the read API is REST-like, so the sections following describe the entity types that can be accessed, and the syntax of the URLs for their discovery.

For full details of the Excellence Gateway Read API please review the full documentation. If you have any questions, please contact us.

You can find a wealth of information on what API's are and how to use them via this GOV.UK article.