Tokens

The way in which a token is obtained depends on the environment you are in.

Sandbox Tokens

To retrieve the bearer token for your assigned client organization in the sandbox environment:

  1. You must have Sandbox access (please contact your client success manager to request access),
  2. Sign into the Lynx Client Admin Dashboard (make a hyperlink to login page).
  3. Navigate to Settings >> Application,
  4. Click the 'Generate' button on the portal

Congratulations, you now have the bearer token for your assigned client organization.

You can also retrieve the token programmatically by invoking this command below:

curl --request POST \
  --url https://sandbox.lynx-fh.co/oauth/token \
  --header 'content-type: application/json' \
  --data '{"client_id":"enter your client id","client_secret":"enter your client secret","audience":"https://sandbox.lynx-fh.co/","grant_type":"client_credentials"}'

Production Tokens

In the production environment, you will need to programmatically retrieve tokens using the REST API below:

curl --request POST \
  --url https://prod.lynx-fh.co/oauth/token \
  --header 'content-type: application/json' \
  --data '{"client_id":"enter your client id","client_secret":"enter your client secret","audience":"https://prod.lynx-fh.co/","grant_type":"client_credentials"}'

Note:

For these token endpoints, Sandbox and Production, Lynx is performing dynamic token caching based on the JWT token expiration. Upon your request to these endpoints, Lynx will automatically return an unexpired token. Tokens are automatically refreshed by Lynx 5 minutes prior to expiration.

As these are JWT tokens, you may decode a generated token and assess expiration at any time.