API resources

Downloads

OpenAPI document, Postman collection and environment files.

OpenAPI document

Use the partner OpenAPI 3.0 document for code generation, schema validation or another API reference tool.

Download OpenAPI YAML

Postman collection

Import the collection, then import the Demo or Production environment file.

Download Postman collection

Demo environment

Contains Demo base URLs and empty client ID, client secret, access token and partner ID values.

Download demo environment

Production environment

Contains Production base URLs and empty credential values. Add credentials locally and do not commit the populated file.

Download production environment

Use Postman locally

Install Postman.
Download the desktop app from Postman.
Import the collection.
Import the collection and the environment file for Demo or Production.
Add credentials locally.
Paste values into your private Postman environment or vault. Do not sync production secrets to a shared workspace.

Manage credentials

Create and rotate API credentials in Developer settings. These credentials authenticate API requests and cannot be used to sign in to this documentation site.

Open Developer settings Review authentication

Production access

Production browser requests are disabled. Use a server-side secret manager, local curl session or private Postman vault.