Skip to main content

AdButler

AdButler is a fully customizable ad serving platform that helps publishers and advertisers manage digital advertising campaigns across multiple formats, offering white-label solutions with enterprise-grade scalability and flexibility.

AdButler icon

Power end-to-end data operations for your AdButler API with Nexla. Our bi-directional AdButler connector is purpose-built for AdButler, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to AdButler or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your AdButler workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

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

Authenticate

Credentials required

FieldRequiredSecretDescription
API KeyYesYesSet this to your API Key for Ad Butler API. You can register a new AdButler API key by visiting the AdButler API Settings page (Settings → API Settings)

Create a credential in Nexla

  1. 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
  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

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

  3. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the AdButler connector tile, then select the credential that will be used to connect to the AdButler instance, and click Next; or, create a new AdButler credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common AdButler endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Get all items of a Resource

This endpoint retrieves all items of a selected resource type from your AdButler account using the AdButler API v2. Use this endpoint when you need to fetch data for channels, campaigns, advertisers, creatives, or other resource types available in AdButler.

  • Select the type of resource you wish to fetch from the Resource Type dropdown menu. Available resource types include Channels, Publishers, Zones, Ad-Items, Advertisers, Campaign Assignments, Campaigns, Creatives, Data Key Targets, Data Keys, Day Parting, Geo Targets, Media Group, Placements, Platform Targets, Schedules, Managers, Roles, PMP-deals, and various VAST-related resources (VAST Ad Items, VAST Campaign Assignments, VAST Campaigns, VAST Channel Zone Assignments, VAST Channels, VAST Companions, VAST Media, VAST Placements, VAST Schedules, VAST Tracking, VAST Zones).
  • The endpoint uses the AdButler API v2 endpoint structure (https://api.adbutler.com/v2/{resource_type}) and automatically handles pagination using offset and limit parameters, retrieving up to 100 records per page by default. Additional pages are fetched automatically as needed.
  • Data is returned in JSON format with the response path configured to extract items from the $.data[*] path, ensuring each resource item is treated as a separate record. The API response includes metadata about the total number of records and pagination information.

The Resource Type parameter supports custom values in addition to the predefined options. If you need to fetch a resource type not listed in the dropdown, you can enter it manually. Ensure the resource type matches the exact API endpoint path used by AdButler.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

AdButler data sources can also be manually configured to ingest data from any valid AdButler API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new AdButler data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the AdButler destination, and select the Send to Destination option from the menu. Select the AdButler connector from the list of available destination connectors, then select the credential that will be used to connect to the AdButler organization, and click Next; or, create a new AdButler credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common AdButler endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Records of a Resource Type

This endpoint creates new records of a selected resource type in your AdButler account using the AdButler API v2. Use this endpoint when you need to create new channels, advertisers, or managers. Each Nexset record will result in a new entry in AdButler.

  • Select the resource type for which you want to create records from the Resource Type dropdown menu. Available resource types include Channels, Advertisers, and Managers.
  • The endpoint uses the AdButler API v2 endpoint structure (https://api.adbutler.com/v2/{resource_type}) and sends data in JSON format using the POST method. Each record in your Nexset will be sent as a separate API request to create a new resource entry.
  • Ensure that your Nexset data includes all required fields for the selected resource type. The API expects data in JSON format matching the resource type's schema. Refer to the AdButler API documentation for specific field requirements and data formats for each resource type.
  • The API will return the created resource object in the response, including the assigned ID and any additional fields generated by AdButler.

The Resource Type parameter supports custom values in addition to the predefined options. If you need to create a resource type not listed in the dropdown, you can enter it manually. Ensure the resource type matches the exact API endpoint path used by AdButler.

Manual configuration

AdButler destinations can also be manually configured to send data to any valid AdButler API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

For update/upsert operations, include the ID of the object to be updated at the end of the URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured AdButler endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the AdButler endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.