API Health Check

All of our APIs have /healthcheck endpoint, which verifies that the connection to our API server is established and the requested API is operational. 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)

• If you have your own development platform, create a sandbox for a set of sandbox credentials to securely access our APIs to run the health check for example, Eligibility V3 API health check, download and import the Eligibility OpenAPI Spec from the Overview page in to your development platform or a tool of your choice.
• If you do not have a development platform/tool to try or test our APIs, create a sandbox for a set of sandbox credentials to securely access our APIs to run the health check endpoint in an interactive Try It interface.

For information, see Try Our APIs.

In Try It! interface

1. Generate a Bearer Token using your sandbox credentials to continue.

• client_id: your client_id
• client_secret: your client_secret
• grant_type: client_credentials

2. Click Try It.
3. To check the API status, for example, to check the Eligibility API status, click Health Check.

The curl request shows as below in the box on the right

curl --request GET \
     --url https://sandbox-apigw.optum.com/medicalnetwork/eligibility/v3/healthcheck \
     --header 'Authorization: Bearer eyJraWQiOiIxIiwidHl... \
     --header 'accept: */*'

2. Enter the Bearer token generated in the in step 1 above, in the Authorization box exactly as shown in the following example.

If the connection to the API service is established and if the entry points are accessible, and if the API is operational, the status response shows OK with the active product version as shown in the preceding figure on the right.

In your development platform

1. Download our OpenAPI Spec and import it in your platform.
2. Inside the required product API collection folder, click the Generate JWT token with payload - Medical Network endpoint.
3. Click the Body tab and enter your specific API credentials provided.

• client_id: your client_id
• client_secret: your client_secret
• grant_type: client_credentials

4. Run the request to generate a Bearer token.
5. Now, click the /healthcheck endpoint and send the request.

If the request was successful, the 200 Success response shows as "status: ok". If the request failed, a 500 Internal Server Error shows.

For information about HTTP response codes, see.