API Health Check
All of our APIs have a /healthcheck
endpoint, which verifies that the operating status of the requested API is optimal. It is a ping for the API entry points to ensure the entry points are accessible and it is the first thing you can do if the API request is not working.
Performing the API health check (for first-time users)
- To run the health check of an API, for example, for the Eligibility V3 API, import the Eligibility OpenAPI Spec from the Eligibility V3 API Getting Started page in to Postman (Preferred method) or any other tool/platform of your choice.
Using Postman
- Generate a Bearer token using the
/apip/auth/v2/token
endpoint:
BEARER TOKEN LIFESPAN
The lifespan of a Bearer token is one hour (3600 seconds) for both sandbox and production environments.
We recommend automating transactions to use the tokens generated over the token lifespan. Obtaining tokens for each transaction is less efficient and does not improve the security criteria for any transactions.
- Under the Postman >> MedicalNetwork >> Eligibility collection, send a
GET
request for health check:
https://apigw.changehealthcare.com/medicalnetwork/eligibility/v3/healthcheck
If the API engine is working correctly and if the entry points are accessible, the API operating status response shows "OK":
NOTE
If you receive a response other than 200 OK, the health check failed.
Please submit a service ticket with Optum by providing the
traceId
.
Using Try It interface
- Go to API Reference.
- Click the API Tools tab.
- Click
/apip/auth/v2/token
. - Enter the following values in their respective fields.
Field | Value |
---|---|
client_id | Your client ID provided by Optum |
client_secret | Your client secret provided by Optum |
grant_type | Always client_credentials |
NOTE
To view the request example, pull down the Example drop-down.
- Click Try It to generate a bearer token.
- Go to Optum API Reference.
- In the left navigation, click Health Check on the required API.
- Enter the bearer token generated by performing step 5, in the Authorization field.
- Click Try It.
The response to the requested API shows.
NOTE
A response other than a 200 OK, indicates that the API health check failed.
Healthcheck endpoints
Updated about 1 month ago