API & Services Connectionā„¢
Guides
Request Sandbox AccessMarketplaceCommunityQuick Reference

Use the Try It Interface

Suggest Edits

Following are some examples of using the Try It interface in the developer portal.

šŸ“˜

BEARER TOKEN LIFESPAN

The lifespan of a Bearer token is one hour (3600 seconds) for both sandbox and production environments.

Interactive Try It interface

Use the API reference's Try It interface as shown below by using our sandbox predefined values to familiarize yourself with our APIs.

  1. For example, to generate an API Bearer token in the developer portal, go to API Tools.
  2. Click /apip/auth/v2/token.
  3. Use your sandbox credentials provided in the client Id and client secret fields and enter client_credentials in the grant_type field and click Try It.
curl --request POST \
     --url https://sandbox-apigw.optum.com/apip/auth/v2/token \
     --header 'accept: */*' \
     --header 'content-type: application/json' \
     --data '
{
  "client_id": "your client ID",
  "client_secret": "your secret",
  "grant_type": "client_credentials"
}'

2174

Example of Generate Bearer Token Try It Feature

API Healthcheck

  1. To check the API status, for example, to check the Eligibility API status, click Health Check.
  2. Enter the Bearer token generated in the above section in the Authorization box exactly as shown in the example in the image below.

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: */*'

If the API engine is working correctly and if the entry points are accessible, the API operating status response shows OK with the active product version.

2066

Eligibility V3 API Response Example

šŸ‘

IMPORTANT

For sandbox usage, all fields must have the correct predefined values to obtain a successful response example. Inventing new PMI values or using real-world PMI values will result in errors. Please provide all of the values, such as tradingPartnerServiceId, controlNumber, subscriber, and so on marked as required (R) (see example) in your API requests.


Related Topics

Updated 4 days ago