Authentication

To use the API, you will need the following credentials. These credentials will be securely provided to you by Blueprint when your partner organization is onboarded.

• clientId - identifier of your partner application

• clientSecret - secret associated with your partner application

• apiKey - API key associated to your partner organization

The first thing you need to do is generate an a server-side access token:

• Call POST /authenticate and provide clientId and clientSecret in the body of the request, and include these headers:

  • X-API-Key: your-api-key

• This method will return an access token. This token should be securely stored on the server and not exposed to the front end.

• For all subsequent calls, you must provide these headers:

  • Access-Token: your-access-token

  • X-API-Key: your-api-key

If you do not provide an API key, every call will return a 403 HTTP status code, and a response body that looks like this:

{
  "message": "Forbidden"
}