APIs for the API platform itself

5 votes

Provide APIs that allow API producers and/or API consumers to perform "platform" functions through an API. This might include API deployment, monitoring, analytics, config management etc. We're not sure exactly what would be useful so if you have a specific suggestion, make a comment.

Under consideration api make-design-and-build-easier platform platform-phase-3 Suggested by: Tony Heap (10 Nov, '22) • Upvoted: 15 Nov, '22 • Comments: 5

Comments: 5

10 Nov, '22
Joel Klinger
one-step api to return mock auth header field for testing?
14 Nov, '22
Don't wish to disclose
Stop using dinosaur era protocols and methodologies. Stick to industry standard JSON, REST and stop asking us to run one static server on a static IP to be able to use this server. We live in the cloud now, none of us have a server room in the basement.
14 Nov, '22
Emile Axelrad
Whilst the policy is "you must create one app in the API Management platform for every healthcare organisation customer" then all software suppliers will end up with hundreds if not thousands of API Management apps. This is very very hard to maintain.

Therefore the APIs required would be:
1. List all API Management apps (e.g. one for each healthcare organisation)
2. Create a new API Management app
3. Update the details of an API Management app including updating which APIs/interactions are enabled (e.g. "PDS Application Restricted")
4. Retrieve the details of an API Management app (including what API interactions are already activated, what URL is specified for JWKS, etc)
5. Health-check to see that the associated ASID has the correct interactions enabled which match the API Management API interactions which are enabled - this is a very common problem and causes many hours of lost time between NHSD & the Software Supplier
18 Nov, '22
Tony Heap Admin
Emile, thanks for the suggestion. In fact we are planning to solve the "thousands of apps" problem another way. At some point it should be possible for you to have a single app registered and use it for all your end user orgs. The PDS FHIR API will, as ever, be an exemplar for this.
18 Nov, '22
Tony Heap Admin
Hi there "don't wish to disclose". We are very much working on moving all out APIs to REST, JSON and the cloud, as per our API management vision (https://digital.nhs.uk/developer/guides-and-documentation/api-management-vision).