Sign in ☰API Usage Guide
ℹ️ The APIs published in this Gateway have certain pro-forma requirements for usage. This Guide covers things such as headers, authentication, version-targeting, and environment-targeting requirements.
API Test UI
This portal offers API specification documentation and a generic Test Harness UI available for each subscribed API.
The UI may not automatically include required Request Headers, and you may have to manually impute them to the UI when submitting a request.
Authentication Headers
When make a request to the API Gateway, you must provide your Subscription Key to use an API. This key is issued to you under the Subscription Manage area of each Product.
Some APIs may also require (or allow) the use of an OAuth2 Token, as a secondary authentication component.
Information regarding the use of OAuth2 Authentication is provided on an as-needed basis by the API Gateway administrator.
Generally, Subscription Keys are provided as a Request Header:
Header Name: Ocp-Apim-Subscription-Key
Header Value: {api-subscription-key}
Environment Headers ️
This API Gateway provides access to multiple Environments for each API. An environment is a specific deployment-stage which may contain unique deployments of an API. Generally, the purpose of this is to provide access to early or alternative releases (e.g. alpha, beta, RC, hotfix, patch, validation, QAT, etc).
Generally, API Environment targeting is provided as a Request Header:
Header Name: Api-Environment
Header Value: BLD, DEV, QAT, HFX, or VAL
Version Headers
This API Gateway provides API versioning, which allows for specification and feature changes to the API interface. Versioning uses minor-revision and major-version changes. Some APIs have multiple versions available, following a standard SLA or SDLC approach. Typically, the purpose of this is to allow for backwards compatibility and to accommodate for both breaking and non-breaking changes.
Generally, API Version targeting is provided as a Request Header:
Header Name: Api-Version
Header Value: {version}
Examples of {version} values:
v1
v1.1
v2
API Error List
Kindly refer to the following: