The three pieces

Working with the APIs involves three things, and it's worth keeping them straight:

  • Application - a container for your project. It holds your credentials and tracks which APIs you use.
  • API registration - links your application to a specific API. A single application can be registered with many APIs.
  • Credential - the key or client secret the API checks on every request. Credentials belong to your application, not to you personally.

Create an application

  1. Open My applications and select New application.
  2. Name it after the project you're building, such as order-sync.
  3. Register the application with each API it needs to call.
Waiting for approval?

Some APIs approve registrations right away; others need an administrator. You'll get an email as soon as yours is approved. Until then, requests to that API return 403 Forbidden.

Manage registrations

From your application page you can:

  • Register the application with additional APIs at any time.
  • See which APIs each credential can reach.
  • Revoke access to an API you no longer call.

Generate and rotate credentials

Each application can hold multiple credentials, so you can separate staging from production. Generate them from the application page, and see Authentication for how to send them.

Rotate on a schedule:

  1. Generate a new credential.
  2. Update your service to use it.
  3. Revoke the old credential once traffic has moved over.

Next steps