Submitting an Application

circle-info

Not using OAuth 2.0, or no traditional API? You can still become a partner. Email us at [email protected]envelope and we'll guide you through the right path.

If your platform supports OAuth 2.0, the fastest way to get started is through Terra's self-serve application form at partner.tryterra.coarrow-up-right. It walks you through the configuration Terra needs to connect to your API, step by step.

What you'll configure in the form

OAuth 2.0 URLs

Your authorization endpoint (where users log in and approve access), your token endpoint (where Terra exchanges the code for a token), and optionally a refresh or revocation URL.

Client credentials

Your client_id and client_secret: the credentials Terra uses to identify itself when calling your OAuth endpoints. You generate these when you register Terra as an authorized app in your developer portal.

User ID extraction

After a user connects, Terra needs to know which user it's dealing with. You tell Terra where to find that ID: either directly in the token response, or by pointing to a user-info endpoint and the field to read from.

Scopes

Scopes are the permissions a user grants when they connect. You define which scopes Terra should request, which are required for each data type, and how granted scopes are returned in the response.

Data endpoints

For each data type your platform supports, you provide the endpoint URL, HTTP method, and the scopes required to access it.

Before you start

Make sure you have the following ready:

After you submit, Terra's team reviews your configuration and we'll get back to you shortly.

Last updated

Was this helpful?