Skip to main content

Authorization

Follow this guide to create a new Capsule credential that will allow Nexla to authenticate to and exchange data with your Capsule account.
capsule_api_auth.png

Capsule

Prerequisites​

Before creating a Capsule credential, you need to register an OAuth 2.0 application in your Capsule account and obtain the Client ID and Client Secret. Capsule uses OAuth 2.0 with 3-legged authentication (authorization code flow) to securely authenticate API requests.

To set up OAuth 2.0 authentication for Capsule:

  1. Create an OAuth Application: Log in to your Capsule account and navigate to the Developer Console or API settings section to create a new OAuth application.

  2. Obtain Client Credentials: After creating the OAuth application, you will receive a Client ID and Client Secret. These credentials are used to authenticate with the Capsule API.

  3. Configure Redirect URI: Ensure your OAuth application is configured with the appropriate redirect URI for Nexla's OAuth flow.

  4. Select Access Scopes: Determine which access scopes your application needs based on the Capsule API endpoints you plan to use. Access scopes determine which resources your application can access.

The OAuth 2.0 authorization URL and token URL are pre-configured by Nexla and do not require manual entry. Nexla automatically handles the OAuth 2.0 authorization code flow, including the authorization redirect, token exchange, and token refresh.

For detailed information about Capsule OAuth 2.0 setup, application registration, and available scopes, refer to the Capsule API authentication documentation.

Create a Capsule Credential​

  • To create a new Capsule credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Capsule

CapsuleCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

OAuth 2.0 Configuration​

  1. Enter your Capsule OAuth Client ID in the Client ID field. This is the Client ID you obtained from your Capsule OAuth application registration. The Client ID is used together with the Client Secret to authenticate and obtain OAuth 2.0 access tokens.

  2. Enter your Capsule OAuth Client Secret in the Client Secret field. This is the Client Secret you obtained from your Capsule OAuth application registration. The Client Secret is used together with the Client ID to securely authenticate and obtain OAuth 2.0 access tokens.

  3. Enter the access scope for your Capsule application in the Access Scope field. This determines which Capsule API resources your application can access. Leave this field empty if you want to use the default scope, or specify the required scopes based on the Capsule API endpoints you plan to use.

    The Client ID and Client Secret are used for OAuth 2.0 authorization code flow authentication. The credentials are exchanged for an access token using the Capsule token endpoint (https://api.capsulecrm.com/oauth/token). The access token is then used in the Authorization: Bearer {token} header for all API requests. Keep your Client Secret secure and do not share it publicly or commit it to version control systems. The OAuth 2.0 authorization URL (https://api.capsulecrm.com/oauth/authorise) and token URL are pre-configured and handled automatically by Nexla. For detailed information about Capsule OAuth 2.0 authentication, available scopes, and API access, see the Capsule API authentication documentation.

  4. When you create a Capsule credential, Nexla will prompt you to authenticate with your Capsule account. Follow the OAuth 2.0 authorization prompts to grant Nexla access to your Capsule account resources.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.