Search loading...


Explore and Make use of Nationally Defined Messaging APIs



The Access page shows developers and users of the API how to access and call the API

What is API Access?

API access is the process of ensuring that calls to APIs with authenticated logins are able to access the APIs. API products are also a good way to control access to a specific bundle of resources/Profiles or aspects of information.

This implementation guide identifies the need to manage any exposed APIs. When access control and monitoring is combined while creating an API, this can empower API implementing organisations to improve, control, limit and deny access to APIs and therefore the underlying data in a consistent mechanism. When APIs are the central mechanism for authorization and access control to your APIs.

API access control measures need to be defined alongside API creation and need to look for:

  • enforcement of authorisation
  • security of Payload and access
  • matching security with scope of use
  • access and approval for particular resources

A possible mechanism for providing access to APIs is the provision of API keys for access to the APIs being provided. Please contribute for other common access methods and add to the Case Studies to show various access mechanisms to APIs.

Access and ITK3 Messaging Distributions

Access to APIs needs to considered at the design phase to include the process of managing and maintaing valid and consistant APIs. The following design considerations become increasingly important as an accessible API moves through Test to Assure to Deployed.

  • Endpoints
  • Report & Monitoring
  • Traffic Management
  • Transformation
  • Versioning

For more information on the wider design decisions involved in providing safe access to information please see:

  • Case Studies illustrates access decisions used to solve the challenges faced within the context and design patterns encountered.

API Considerations

Other API consideration are shown below. Please click on the parts of the API process to continue your API creation journey.

Page-1 Sheet.10 Circle.3 Circle.2 Rectangle Key: Key: Circle.16 Circle.17 Circle.18 Rectangle.19 Provided Provided Rectangle.20 Explained Explained Rectangle.21 Local Decision Local Decision ITK3 Messaging Solution ITK3 Messaging Solution MessagingSolution Endpoint Endpoint Endpoint Transform Transform Transform Traffic Management Traffic Management TrafficManagement Versioning Versioning Versioning Engage Engage Engage ITK3 Messaging Solution Documentation ITK3 Messaging Solution Documentation MessagingSolutionDocumentation Report & Monitor Report & Monitor Report & Monitor Patterns / Topology Patterns / Topology Patterns / Topology Access Access Access Security Security Security
Tags: design

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