← Documentation

Dolibarr

Dolibarr is an open-source Enterprise Resource Planning (ERP) and Customer Relationship Management (CRM) software suitable for businesses of all sizes.

The Dolibarr add-on enables seamless synchronization of WordPress posts with Dolibarr’s various modules, including products, contacts, events, projects and warehouses.

Dolibarr's main dashboard with sample data

The add-on

Dolibarr has a REST API as an optional module. Once enabled, a set of web services will be available to be called out of the box. This add-on requires your instance to has this module enabled. To talk with this API, the add-on works with an extension of the generic REST bridge class.

A Dolibarr bridge will synchronize your posts with the database of your ERP.

With Posts Bridge introspection API you’ll be able to inspect each module fields to easily map them to your post fields and taxonomies.

How to use

The first step to use the add-on is to activate it on the add-ons table on the general settings tab.

Screenshot of the addons panel on the general settings tab with the Dolibarr addon activated

Once activated, a new tab will be visible on the settings page. If it’s your first time, it should looks like this:

Dolibarr tab out of the box without bridge configurations.

Bridge set up

A Dolibarr bridge will require the following components:

1. Backend

Before registering the backend, you should create an API key.

API keys are linked to users. You can use your own user or create a new one for this purpose. To generate the key, you have to go to the user’s profile, click on Modify and then search for the Key for API field. You can manually type a key value, or click on the refresh button to get a random string. To finish, copy the key value and click on the Save button at the bottom of the screen.

With your API key on the clipboard, go to Settings > Posts Bridge > HTTP > Backends on your WordPress admin panel and follow this steps:

  1. Add a new backend with a unique name
  2. Set the base URL of your ERP instance as the connection URL
  3. Add Accept as an HTTP header with application/json as value
  4. Add DOLAPIKEY as an HTTP header with your API key as value

2. Post type

Posts Bridge allows you to bridge any registered post type from your WordPress site. If you’ve not registered it yet, you can register it with Posts Bridge. Go to the CPTs tab and create a new custom post type. The registration form will inherit the registration defaults, but you can modify its values at any time. The only required fields are Name, Label and Singular label.

3. Bridge

The add-on’s bridge is an extension of the generic REST bridge with some predefined defaults. Like the REST bridge, the addon’s bridge requires a post type, a backend, and an endpoint.

The bridge endpoint have to match with one of the available endpoints of your instance API. To get an overview of this endpoints you can use the API explorer. To get there, open a web browser, go to your ERP’s admin UI and go to Tools > API explorer, copy your API key on the input from the header and click on explore. After that you will reach the following page:

Screenshot Dolibarr's API explorer UI

Open a service, copy the endpoint and use it as your bridge endpoint. For example, to get your posts bridged to the agenda web service, you have to use /api/index.php/agendaevents.

Troubleshooting

To troubleshooting your bridges you can use the plugin’s debug console from the General Settings page. Enable the debug mode and submit a sample form response to see what’s going on under the hood. Take a look to our tutorial about how to use the debug console.

Common issues

  1. API connection failures
    • Verify the API key
    • Confirm REST API module activation
    • Ensure module availability
  2. Missing data
    • Validate field mappings
    • Verify web services endpoint schemas