Skip to main content

Authorization

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

Babelforce

Prerequisites​

The Babelforce REST API authenticates HTTP requests using an Access ID and Access Token pair, which are sent as the X-Auth-Access-Id and X-Auth-Access-Token request headers on every call. These values are generated from the Babelforce manager app and are tied to a specific user account, granting access using that user's permissions. For most API collections, the underlying user must have manager rights in Babelforce.

In addition to the credential values, the credential record also stores the Base URL of your Babelforce environment so that endpoint URLs resolve to the correct regional service host (for example, https://services.babelforce.com for the global default, or a regional variant for environments hosted elsewhere).

Generate an Access ID and Access Token​

  1. Sign in to your Babelforce manager app at the URL for your region — for example, https://apps.babelforce.com/manager2/ for the EU region.

  2. Click your user icon, and open the account overview page (for the EU region, this is https://apps.babelforce.com/manager2/#/app/manager/account/overview).

  3. On the account overview page, locate the Access ID and Access Token values associated with your user profile.

  4. Copy both values, and store them securely. These values authenticate Nexla to your Babelforce account using your permissions, so they should be treated like a password.

    The Access ID and Access Token are tied to a specific Babelforce user. To avoid disruption if a user account is later disabled, it is recommended to generate these values from a dedicated integration user with manager rights rather than from a personal account.

Identify Your Babelforce Base URL​

The Babelforce REST API is hosted on regional service endpoints. The base URL stored on the credential is the root URL of your Babelforce environment — Nexla appends endpoint-specific paths (for example, /api/v2/calls or /auth/scim/v2/Users) automatically.

  • The default global base URL is https://services.babelforce.com.

  • Regional environments use a regional variant of this URL. The correct base URL for your account is the host portion of the example requests shown in the Babelforce developer hub for your environment.

Do not include a trailing path such as /api/v2 in the Base URL field — Babelforce endpoints append their own path, and including a trailing path will cause API calls to fail.

For complete information about Babelforce API authentication, see the Babelforce Authentication: Best Practice guide and the Babelforce developer hub.

Important

The Access ID and Access Token values grant access to Babelforce account data using the underlying user's permissions. Store them in a secure secret manager, never commit them to source control, and rotate them immediately if you suspect they have been exposed.

Create a Babelforce Credential​

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

  1. Enter your Babelforce Access ID in the Access ID field. This value is sent as the X-Auth-Access-Id header on every request and is treated as a secret.

  2. Enter your Babelforce Access Token in the Access Token field. This value is sent as the X-Auth-Access-Token header on every request and is treated as a secret.

  3. Enter the root URL of your Babelforce environment in the Base URL field. The default value is https://services.babelforce.com; change this to the regional variant that matches your account if it is hosted in a different region.

    The Base URL value should not include a trailing path such as /api/v2. Endpoints append their own path automatically when calls are made.

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. Nexla will validate the credential by issuing a test call to the /api/v2/calls/reporting/simple endpoint using the configured Access ID, Access Token, and Base URL values.

  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.