Providing an RESTful API for the first time is a journey. This page explains a starting point of the work involved in providing an API and also the part be concentrated on by Care Connect

How to provide an API

The diagram below explains the parts involded in providing APIs. This implementation guide provides :

  • the starting point of providing APIs (in white);
  • descriptions and pointers of elements to getting working APIs within various infrastructures (in green); and
  • considerations when managing live API services (in yellow)
provide_api Local decision Explained Provided Key: API Security Transform Traffic Management Versioning Engage API Docs Report & Monitor Patterns / Topology Access Endpoint

NHS Digital is contributing to progressing the profile development as described below. Invitations are open for the INTEROPen community to get involved and progress the wider developer ecosystem as defined above.

Please see the explanation of the complete development roadmap.

Approach to developing an API

The current site focuses on a typical API Developer’s Journey as highlighted by the green boxes below in the developer journey:

NHS Digital is contributing to progressing the profile developmenet, the testing process and invitations are open for the INTEROPen community to get involved and progress the wider developer ecosystem.

Please see the explanation of the complete development roadmap.

Tags: