About
HMPPS External API (formerly HMPPS Integration API) is a RESTFul API that provides a single point of entry for organisations to access data about a person within the prison and probation services of Ministry of Justice (MOJ) such as the National Offender Management Information System (NOMIS). It uses a HMPPS ID for a person.
Additionally the API is supported by an event notification system that can inform consumers when data exposed by the API endpoints they have access to has changed. Only notifications related to endpoints that consumers have access to will be sent, and the notifications are sent via an AWS SQS queue.
Diagrams
The C4 model is used for visualising the technical architecture of the service.
Context diagram
The context diagram provides a high-level overview of the current systems that make up HMPPS Integration API as well as those that are yet to be implemented.
Container diagram
The API container diagram provides a more in-depth view of the different upstreams APIs that are used to retrieve data from the HMPPS systems such as the Prison API for NOMIS.