Skip to main content

Authorization

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

Campayn

Prerequisites​

To connect Nexla to Campayn, you need an active Campayn account and an API key generated from that account. Campayn authenticates API requests using API key authentication with the TRUEREST scheme, in which your key is passed in the Authorization request header. Nexla constructs this header automatically once you provide your API key.

Every Campayn API request is made against your account's dedicated subdomain (for example, mycompany.campayn.com), so you also need to know the subdomain for your account.

Locate Your Account Subdomain​

Campayn provisions each account on its own subdomain in the form {subdomain}.campayn.com. Your subdomain is the portion of the URL that appears before .campayn.com when you are signed in to your Campayn dashboard.

  1. Sign in to your Campayn account.

  2. Note the address shown in your browser's address bar (for example, https://mycompany.campayn.com).

  3. The text before .campayn.com is your subdomain. In the example above, the subdomain is mycompany.

Generate a Campayn API Key​

  1. Sign in to your Campayn account.

  2. Click Settings in the left navigation menu.

  3. Locate the API section, and copy the API key that is displayed for your account.

    Anyone who has your API key can access your Campayn data, including reports and lists, so treat it as securely as your username and password. If you believe your key has been compromised, regenerate it from your Campayn account settings.

For complete information about the Campayn API and authentication, refer to the official Campayn API documentation.

Create a Campayn Credential​

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

Authentication Settings​

Campayn uses API key authentication. Provide the API key and account subdomain so that Nexla can authenticate to your account and build the correct base URL for every API request.

  1. Enter your Campayn API key in the API Key field. This key authenticates Nexla with Campayn and should be kept secure. Nexla passes it in the Authorization header using Campayn's TRUEREST scheme.

  2. Enter your account subdomain in the Subdomain field (for example, mycompany for mycompany.campayn.com). This value is required so that Nexla can construct the base URL for every Campayn API request.

    Enter only the subdomain itself, not the full host name. For an account hosted at mycompany.campayn.com, enter mycompany.

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.