Skip to main content

Authorization

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

Recurly

Prerequisites​

To connect Nexla to Recurly, you need a Recurly account with API access and a private API key. Recurly's V3 API uses HTTP Basic Authentication, where your private API key serves as the username.

Obtain a Recurly Private API Key​

Recurly private API keys grant programmatic access to your Recurly account and should be kept secure. API keys provide full access to your account data, so treat them like passwords and avoid sharing or exposing them publicly.

  1. Sign in to your Recurly Admin Console at app.recurly.com.

  2. Navigate to Integrations > API Credentials in the left-hand navigation menu.

  3. If no API key exists, click Add Private API Key to generate a new one. Assign a descriptive name (for example, "Nexla Integration") to help identify the key's purpose.

  4. Copy the generated private API key and store it securely. You will need this key when creating the Nexla credential.

Only users assigned a Role that includes the Integration permission can access the API Credentials page. Contact your Recurly account administrator if you do not see this option. For additional details, see the Recurly REST API Keys documentation.

Create a Recurly Credential​

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

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 to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

HTTP Basic Authentication​

Recurly V3 uses HTTP Basic Authentication, where your private API key is sent as the username. This key is securely transmitted over SSL/TLS with every API call.

  1. Enter your Recurly private API key in the Username Or API Key field. This is the same key you copied from Integrations > API Credentials in the Recurly Admin Console. The API key is used as the Basic Auth username—Recurly does not require a separate username.

  2. The Password field is optional for Recurly V3. If your workflow or tooling requires a password value, you may leave it blank or enter any placeholder string; Recurly ignores the password when a valid API key is provided as the username.

    Recurly's V3 API requires the Accept: application/vnd.recurly.v2021-02-25 request header to specify the API version. This header is included automatically by the Nexla connector and does not need to be configured separately.

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.