Register an App

You need to register an OAuth application with Forage to generate a Client ID and Client Secret. With the app's Client ID and Client Secret, you can create tokens that validate requests to the Forage API. Before you begin, sign up for a Forage account if you haven't already.

How to register an app

To register an app:

1. Log in to the Forage dashboard (sandbox or production).
2. From the left navigation menu, click API Settings.
3. Click the Create Application button and set a meaningful name for your app, something like, [Merchant Name] - [Your Name] Testing .
4. Expand the accordion to view your app's Client ID and Client Secret.

Your app's Client ID and Client Secret are now available in the Forage dashboard.

📘

Multiple applications

You can create as many OAuth applications as you like and share the Client IDs and Client Secrets with your teammates for their own testing purposes.

The Forage API is versioned on a per-endpoint basis. In API Settings, you can set a default API Version for all requests; override it per-call by passing API-Version in the request header. See the Forage versioning guide for details.

Next steps

• Authenticate with Forage to use your new credentials to generate the tokens that authorize API requests.