• API Hub
  • Search loading...

    API Hub

    Explore and Make use of Nationally Defined Messaging APIs

     

    Design

    The following pages and posts are tagged with

    TitleTypeExcerpt
    Directory Service (SDS) Page The Spine Directory Service provides details of organisations, people and systems registered with the Spine
    Spine Endpoints Page SDS allows details of registered system endpoints to be looked up
    Endpoint Lookup Example - Spine FHIR Endpoints Page Worked example of looking up a Spine endpoint from SDS for Spine FHIR APIs
    Endpoint Lookup Example - SSP Page Worked example of looking up a Spine endpoint from SDS for calls brokered through SSP
    Overview | Design & Build Page Describes the steps required to design & build an API using the profiles described in Explore
    GP Connect Integration Example Page Illustration of the use of the GP Connect API showing all interactions required - both with Spine services and GP Connect endpoint API calls.
    Visitors and Migrants Integration Example Page Illustration of the use of the Visitors and Migrants API showing all interactions required with Spine services.
    Personal Demographic Service Page Overview of the role of the Personal Demographic Services (PDS) and ways of accessing it.
    Authenticating End-Users of APIs Page Requirements for how users should be authenticated when accessing Spine APIs.
    Authorising Access to APIs Page Details of the approached for authorising API access.
    Access Tokens and Audit (JWT) Page Overview of how authorisation information is used and passed in APIs for audit and provenance.
    Role Based Access Controls Page Details of the national Role Based Access Control model.
    Using Scopes for Authorisation Page Use of Scopes in Authorisation Requests and links to the national RBAC model.
    System-to-System Trust (PKI) Page Details of how system-to-system trust is managed through the Spine PKI.
    Spine Secure Proxy Implementation Guide Page Technical specification for the Spine Secure Proxy (SSP).
    Spine Secure Proxy Page Overview of the role of the Spine Secure Proxy (SSP) to broker calls to other health and social care systems.
    Registering a provider endpoint Page Requirements for systems wanting to register an API endpoint for consumers to call through the SSP
    System Topologies Page Overview of the different types of deployment topologies for brokering API calls through the SSP

    All content is available under the Open Government Licence v3.0, except where otherwise stated