Quickstart

This guide will help you get up and running making your first Optimal Outcomes API call in just a few minutes. You will create a user token & secret combination and ping the Optimal Outcomes API.

This guide assumes you are an Optimal Outcomes Registry customer with Account Manager access to your dashboard.

Create an API user to generate API credentials:

1. Login to your Optimal Outcomes Registry account as the Account Manager
2. Navigate to your Account's Users and Contacts then click on the Add New API User button, which is located directly above the list of your account's users.
3. Fill out the API user details, as you would for any new user.
4. After you Submit the new User, a popup will appear with the Client Id and Secret you will use to generate an 0Auth API token.

Generate OAuth2.0 token

In order to perform calls to Xpansiv Optimal Outcomes API, clients have to request a session token the request. Bearer tokens are issued by Xpansiv Authorization Server.

The Authorization Server URL will depend on the environment you are sending requests.

In the token request, the scope of the access request will be different

Postman Resources for UAT

The following Postman Resources can be imported into a Postman workspace to get you started with Optimal Outcomes API.

UAT Environment: UAT Environment json

UAT API Endpoint Collection: UAT API Collection json

After importing the UAT Environment in Postman, populate and save the clientId & clientSecret environment variables with the API credentials generated for your Optimal API User (see above).

You are now ready to generate an API session token, by navigating to Collections: Optimal - External API -> Auth.

The clientId & clientSecret environment variables have already been populated, along with the Refresh Token & Scope URLs. Click on the Get New Access Token button. After the Access Token is generated, click on the Use Token button.

The generated access token will now be used when you make an Optimal Outcomes API request.