Agari Developer Documentation

Agari Developer Documentation

API Overview & Guide
Get started
Interactive API Reference
Get started

OAuth 2.0

The Agari APIs use the industry standard OAuth 2.0 protocol to secure access to API endpoints.

More specifically, the OAuth 2.0 Client Credentials grant type is used by clients to obtain a temporary access token that will allow access to API endpoints.

Authenticating

Here's an overview of the client credentials grant type flow that you'll use to authenticate with the APIs:

  1. Manually generate API credentials (a client_id and client_secret) in the product portal
  2. Use the client_id and client_secret to generate a temporary access_token
  3. Use the access_token to make authenticated API requests
  4. Periodically regenerate a new access_token

📘

Authentication Walkthrough

Step by step instructions on how to perform these steps are in the Quick Start.

The client_id and client_secret are how your programs will initiate authentication with the API. While not a username and password, they can be thought of in the same way. They will be passed to an API endpoint to obtain a temporary access_token, which will grant you access to the rest of the API endpoints.

🚧

Keep your client_id and client_secret secure

Clients can use your client_id and client_secret to gain access to the APIs as your user. Keep these values somewhere safe and secure. Never share them with anyone.

Updated 2 months ago



OAuth 2.0


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.