Skip to main content

Authorization

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

Encharge

Prerequisites​

To connect Nexla to Encharge, you will need an active Encharge account and access to its API credentials. Encharge provides two types of API keys depending on the operations you want to perform:

  • REST API Key: Used for reading data from Encharge (e.g., listing people, accounts, segments, tags, fields, schemas, and custom objects) and for most write operations via the REST API.
  • Ingest API Write Key: Used specifically for writing behavioral event data via the Encharge Ingest API (e.g., the Track Event destination endpoint).

Obtain Your Encharge REST API Key​

The Encharge REST API key authenticates requests to the core Encharge REST API at https://api.encharge.io. All data source operations and most destination operations use this key.

  1. Log in to your Encharge account at app.encharge.io.

  2. Navigate to Settings in the left-hand navigation menu.

  3. Select API Tokens (or API Keys) from the Settings menu.

  4. Your REST API key is displayed on this page. Copy the key value for use in Nexla.

For complete details on Encharge API authentication, refer to the Encharge API Documentation. The REST API key is passed as the X-Encharge-Token request header in all API calls.

Obtain Your Encharge Ingest API Write Key​

The Encharge Ingest API write key is required only if you plan to use the Track Event destination endpoint. This key authenticates event-tracking writes to the Ingest API at https://ingest.encharge.io.

  1. Log in to your Encharge account at app.encharge.io.

  2. Navigate to Settings in the left-hand navigation menu.

  3. Select API Tokens from the Settings menu.

  4. Locate the Ingest API Write Key (sometimes labeled as the write key or site write key). Copy the key value for use in Nexla.

The Ingest API write key is a separate credential from the REST API key. It is scoped specifically to write operations on the Ingest API. For complete information on the Encharge Ingest API, refer to the Ingest API documentation.

Create an Encharge Credential​

  • To create a new Encharge 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.

Authentication Settings​

Encharge supports two authentication methods in Nexla: API Key Authentication for REST API operations, and Ingest API Write Key Authentication for event-tracking destination operations. Select the method appropriate for your use case.

Encharge Authentication Methods

Authenticate using your Encharge REST API key. This method is used for all data source operations (reading people, accounts, segments, tags, fields, and custom objects) and for most destination operations (creating/updating people, managing tags, and creating custom objects). The API key is passed as the X-Encharge-Token header in all requests to the Encharge REST API.

  1. Enter your Encharge REST API key in the **API Key Value** field. This key authenticates Nexla with the Encharge REST API and should be kept secure. You can obtain this key from **Settings > API Tokens** in your Encharge account.

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.