Skip to main content

Authorization

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

Chargify

Prerequisites​

To connect Nexla to Chargify, you need a Chargify account with API access, an API key, and your site's subdomain. Chargify uses HTTP Basic Authentication over HTTPS, where your API key serves as the username and the literal string x serves as the password.

Identify Your Chargify Site Subdomain​

Each Chargify site has a unique subdomain that forms the base of all API URLs. Your site subdomain is the prefix used when you access your Chargify dashboard (for example, if you log in at https://mycompany.chargify.com, your subdomain is mycompany).

  1. Sign in to your Chargify account at app.chargify.com.

  2. The subdomain is shown in the browser address bar when you are viewing your site dashboard. Note this value—you will need it when constructing API endpoint URLs in Nexla.

Obtain a Chargify API Key​

Chargify API keys grant programmatic access to your site's data. Each site can have up to 10 API v1 keys. API keys should be kept secure and treated like passwords.

  1. Sign in to your Chargify dashboard at app.chargify.com.

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

  3. Click the Chargify API tab to view your API keys.

  4. Click Create new API key to generate a new key. Assign a descriptive name (for example, "Nexla Integration") to help identify the key's purpose.

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

Only Chargify site owners and users with the appropriate permissions can access the API keys page. Contact your Chargify account administrator if you do not see this option. For complete information about API key management, see the Chargify API Keys documentation.

Important

Chargify does not display the full API key after initial creation. Copy and securely store the key immediately when it is generated, as you will not be able to view it again from the dashboard.

Create a Chargify Credential​

  • To create a new Chargify 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​

Chargify uses HTTP Basic Authentication over TLS (HTTPS). Your API key is sent as the username with every API call. This authentication method is the same for all Chargify REST API v1 operations.

  1. Enter your Chargify API key in the API Key field. This is the key you copied from Config > Integrations > Chargify API in your Chargify dashboard. The API key is used as the Basic Auth username.

  2. Enter your Chargify site subdomain in the Site Subdomain field. This is the unique prefix for your Chargify site (for example, if your site URL is https://mycompany.chargify.com, enter mycompany). The subdomain is required to construct the correct base URL for all API requests.

    All Chargify API requests are made to https://{'{subdomain}'}.chargify.com, where {'{subdomain}'} is your site's unique identifier. Every Chargify site has its own subdomain, and API keys are site-specific—an API key from one site cannot be used to access another site's data.

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.