All examples in this document will use the preproduction endpoint, however both environments are virtually identical with the exception of which version of the API is running on the environment.

Please register with a new user and verify your email address.

*The permissions can be found at the heading of each api listing in our apidoc: (example) partner. Create. Links

By default, your client credentials can be used to make requests against the API for resources and HTTP methods which do not require any permissions. If you are accessing a resource and HTTP method that requires permissions, and your credentials do not have the appropriate permission, you will receive an HTTP 403 Forbidden. Please make a request to [email protected] to add the appropriate permissions

To authenticate, you will first need to generate a JWT token by using the appropriate token endpoint:

The response will be similar to:

Where <JWT.TOKEN> is a JWT token that (when decoded) stores information similar to:

You can use jwt.io to both preview and verify the token. Note the 86400 expiration is in seconds and equates to 24 hours. THIS VALUE MAY VARY as changes to our platform are made so please track the expiration and make a new request for a token appropriately. Please DO NOT make a request for a token for every call. We will both save money on our bandwidth and reduce unnecessary overhead and reduced security if you follow oauth2 client-credentials conventions.

Now that you have a JWT token, you can add the appropriate header to your client and make API calls as a partner application:

For non curl clients, you will need to add a request header Authorization with value Bearer <JWT.TOKEN> making sure to replace <JWT.TOKEN> with the token from the authorization response you received in the prior step.Now that you have a JWT token, you can add the appropriate header to your client and make API calls as a partner application: