Skip to main content

This is a new service. Help us improve it by giving feedback.

Our API technologies

The technologies used to build and publish HMCTS APIs.

REST
All HMCTS APIs on the marketplace are RESTful HTTP APIs returning JSON.
OpenAPI 3.x
Every published API has a machine-readable OpenAPI specification, which powers the documentation shown in the API catalogue.
OAuth 2.0 with JWT bearer tokens
The standard authentication method across all marketplace APIs. See the glossary for more detail.
GitHub and GitHub Pages
Producer teams host their OpenAPI specification and documentation in a public GitHub repository, published via GitHub Pages, in line with the producer standards.
GOV.UK Design System
The marketplace is built on the GOV.UK Design System, so its forms, error handling and typography will be familiar from other government services.
Spectral linting
Producer API specifications are linted against the standard OAS3 ruleset before being listed, to keep documentation quality and consistency up.