Skip to main content

Authorization

Follow this guide to create a new Dolibarr credential that will allow Nexla to authenticate to and exchange data with your Dolibarr instance.
dolibarr_api_auth.png

Dolibarr

Prerequisites​

To connect Nexla to Dolibarr, you need a running Dolibarr instance (self-hosted or cloud-hosted via Dolicloud) and an API key for a Dolibarr user account. The steps below walk you through enabling the REST API module and generating an API key.

Enable the REST API Module​

The Dolibarr REST API is provided by a built-in module that must be activated before API keys can be generated or API calls made.

  1. Log in to your Dolibarr instance as an administrator.

  2. Navigate to Home > Setup > Modules/Applications.

  3. Locate the Web Services section and enable the API/Web Services (REST server) module by clicking the toggle or activation button next to it.

  4. Once activated, Dolibarr will expose its REST API at the path /api/index.php/ on your instance's base URL (for example, https://your-dolibarr-domain.com/api/index.php/).

The interactive API explorer is available at /api/index.php/explorer on your Dolibarr instance. It lists all available endpoints and allows you to test API calls directly in your browser using your API key.

Generate an API Key​

Each Dolibarr user account can have an API key generated independently. The API key grants access to the same data and permissions that the corresponding user has within Dolibarr. For Nexla integrations, Anthropic recommends creating a dedicated service user with only the permissions required for your integration.

  1. In your Dolibarr instance, navigate to Home > Users & Groups.

  2. Select the user account for which you want to generate an API key. For production integrations, this should be a dedicated service account with only the permissions needed for your data flows.

  3. Click the Modify button on the user's profile page to enter edit mode.

  4. Scroll to the API/Web Services section of the user profile and click Generate (or Regenerate) next to the API Key field.

  5. Copy the generated API key and store it securely. This key will be entered as the API Key credential field in Nexla.

Important

The API key grants the same level of access as the user account it belongs to. Store API keys securely and avoid sharing them. If a key is compromised, regenerate it immediately from the same user profile screen.

Additional documentation on the Dolibarr REST API and authentication is available in the Dolibarr REST API Wiki.

Create a Dolibarr Credential​

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

API Key Authentication​

Dolibarr uses API key authentication. The API key is passed in the DOLAPIKEY HTTP request header with every API call Nexla makes to your Dolibarr instance.

  1. Enter the base URL of your Dolibarr instance in the Base URL field. This is the root URL of your Dolibarr deployment, without any path suffix — for example, https://your-dolibarr-domain.com. Nexla will automatically append the /api/index.php/ path when making API calls.

    For self-hosted instances, ensure that your Dolibarr server is accessible from Nexla's IP ranges. For cloud-hosted Dolicloud instances, the base URL will be the URL provided when your account was created.

  2. Enter the API key you generated in the prerequisites section in the API Key field. This key will be sent in the DOLAPIKEY header with every request Nexla makes to your Dolibarr instance.

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.