Register an app

✅

Prerequisites

• Sign up for a Forage account

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.

How 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.

📘

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 the API Settings of the dashboard, you can set an API Version for all of your requests. To override that setting for a particular API call, specify the API-Version in the individual request header. Learn more about versioning in the Forage versioning guide.

Next steps

• Authenticate with Forage