Skip to main content

Authorization

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

AdButler

Prerequisites​

Before creating an AdButler credential in Nexla, you need to ensure API access is enabled for your AdButler account and obtain an API key. The API key authenticates Nexla with the AdButler API and should be kept secure.

API Access Requirement​

AdButler's API requires the API Access add-on to be added to your subscription. If you don't have API access enabled, you'll need to add this add-on to your AdButler subscription before you can use the API.

  1. Ensure that API access is enabled on your AdButler account. If API access is not enabled, contact AdButler support to add the API Access add-on to your subscription.

    API access must be enabled on your AdButler account before you can create API keys or use the API. Contact AdButler support if you need assistance enabling API access for your account.

Obtain an AdButler API Key​

  1. Sign in to your AdButler account.

  2. Navigate to Settings → API to access the API configuration page.

  3. On the API settings page, you can view existing API keys or create a new one. API keys are used to authenticate API requests and provide access to your AdButler account data.

  4. To create a new API key, click the option to create or generate a new key. Give the key a descriptive name to help identify its purpose.

  5. Copy the API key immediately after creation. Store it securely, as you'll need to enter it during credential creation in Nexla.

    API keys provide full access to your AdButler account data. Keep your API keys secure and do not share them publicly or commit them to version control systems. If you suspect a key has been compromised, regenerate it immediately in your AdButler account settings.

Optional: IP Whitelisting​

For enhanced security, you can optionally whitelist specific IP addresses for your API key. This restricts API access to requests originating from the whitelisted IP addresses. For additional information about AdButler API authentication, API key management, and security best practices, see the AdButler API documentation.

  1. When creating or editing an API key in AdButler, locate the IP whitelisting option.

  2. Enter the IP addresses that should be allowed to use this API key in the corresponding textbox. You can specify multiple IP addresses.

  3. Save the API key configuration with the IP whitelist settings.

    IP whitelisting is optional but recommended for production environments. If you enable IP whitelisting, ensure that Nexla's servers are included in the whitelist, or contact Nexla support to obtain the appropriate IP addresses.

Create an AdButler Credential​

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

New Credential Overlay – AdButler

AdButlerCred.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.

API Key Configuration​

  1. Enter your AdButler API key in the API Key field. This key authenticates Nexla with the AdButler API and should match the API key obtained from your AdButler account settings.

    The API key is sent in the Authorization header for all API requests. Keep your API key secure and do not share it publicly or commit it to version control systems.

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.