Relier votre logiciel métier à Dolibarr : API REST, webhooks et exports

Que donne l'API REST de Dolibarr ?

L'API REST de Dolibarr donne accès, en lecture et en écriture, aux objets des modules activés sur votre instance. Elle s'active comme n'importe quel module, depuis la page des modules, puis répond à l'adresse /api/index.php/ de votre installation. D'après le wiki officiel de Dolibarr :

• chaque appel porte une clé d'API dans l'en-tête HTTP DOLAPIKEY ; la clé est celle d'un utilisateur Dolibarr, et le wiki indique de créer un utilisateur pour l'occasion ;
• un appel de connexion (login) permet aussi d'obtenir la clé à partir des identifiants ;
• les verbes HTTP habituels servent à lire (GET), créer (POST), modifier (PUT) et supprimer (DELETE), et des actions métier existent, comme la validation d'une commande ;
• les objets cités en exemple comprennent les tiers (thirdparties), les produits, les commandes et leurs lignes, les factures ;
• les dates s'écrivent au format ISO, le format « aammjj » est refusé ;
• sur une installation multisociété, l'en-tête DOLAPIENTITY désigne l'entité visée.

L'outil le plus utile au cadrage est l'explorateur intégré, à l'adresse /api/index.php/explorer de votre Dolibarr : il affiche tous les appels disponibles pour la clé utilisée. Si une action manque, le module correspondant n'est probablement pas activé. Attention, l'explorateur agit sur les vraies données : un essai y crée réellement l'enregistrement. Un fichier de description au format Swagger est aussi publié.

Comment Dolibarr prévient-il vos autres outils ?

Dolibarr prévient vos autres outils par son module Webhook, livré avec la distribution. Une fois le module activé, sa configuration consiste à déclarer une cible, c'est-à-dire un ou plusieurs codes d'événements et l'adresse à appeler. À chaque événement, Dolibarr poste un message JSON qui contient le code de l'événement (triggercode) et l'objet concerné.

Deux réserves. Le wiki de Dolibarr ne décrit ni renvoi en cas d'échec, ni signature des messages : rien n'y garantit qu'un message manqué sera renvoyé, ni que l'appel vient bien de votre Dolibarr. Le service récepteur vérifie donc chaque message (secret partagé, adresse d'origine) et rattrape chaque nuit, par l'API REST, ce qui aurait été manqué. Pour une logique plus fine, Dolibarr offre aussi les déclencheurs (triggers) et les points d'accroche (hooks), qui exécutent du code PHP dans un module.

Faut-il une API pour envoyer la comptabilité au cabinet ?

Souvent non. Le module de comptabilité en partie double de Dolibarr exporte le grand livre dans des formats attendus par les logiciels des cabinets : sa documentation cite notamment Cegid, Sage Coala, Sage BOB 50, Ciel, Quadratus, EBP, Cogilog et le fichier des écritures comptables (FEC). Si votre cabinet travaille au mois, un export régulier peut suffire, sans aucun développement.

L'API devient utile quand la comptabilité doit suivre au fil de l'eau, ou quand le logiciel du cabinet attend autre chose qu'un fichier. Le flux part alors d'un événement Dolibarr, une facture validée par exemple, et appelle l'API du logiciel comptable : notre page consacrée à Pennylane montre ce que ce type de liaison implique.

Quatre flux types entre Dolibarr et un outil spécifique

1. Commande saisie sur le terrain. Le commercial prend la commande sur une application mobile chez le client. De retour au réseau, l'application crée la commande dans Dolibarr, ajoute ses lignes une à une, puis la valide : le wiki précise qu'une commande et ses lignes ne se créent pas en un seul appel.
2. Portail branché sur le catalogue. Un portail client sur mesure lit produits et tiers dans Dolibarr pour afficher le catalogue et l'historique des commandes, sans second catalogue à tenir à jour.
3. Facture validée, paiement proposé. À la validation d'une facture (BILL_VALIDATE), le webhook prévient un service qui génère un lien de paiement et l'envoie au client ; une fois le règlement reçu, le service met à jour la facture dans Dolibarr.
4. Nouveau client, outils alignés. La création d'un tiers (COMPANY_CREATE) entraîne sa création dans l'outil d'emailing ou l'extranet, avec les seuls champs nécessaires.

Le wiki de Dolibarr documente aussi des liaisons avec les plateformes Zapier, Make, n8n et Airbyte, qui suffisent pour des flux simples entre outils connus.

La liste de contrôle avant de brancher Dolibarr

1. Un utilisateur Dolibarr dédié à l'intégration, aux droits limités au nécessaire, puisque la clé d'API est la sienne.
2. Un accès en HTTPS uniquement, et une clé rangée dans un coffre de secrets, jamais dans le code d'une application mobile.
3. Une copie de votre instance pour les essais, puisque l'explorateur et l'API modifient les vraies données.
4. Une table de correspondance entre vos identifiants et ceux de Dolibarr, consultée avant toute création, contre le tiers ou la commande en double.
5. Une gestion des commandes restées incomplètes après une coupure, puisque les lignes s'ajoutent une à une.
6. Une recette des flux à chaque montée de version de Dolibarr et à chaque activation de module, car la liste des appels en dépend.
7. Un journal de chaque échange, une alerte en cas d'erreurs répétées et une revue de sécurité ; notre guide sur la sécurité d'une application métier détaille ces points.
8. Une revue RGPD : les tiers de Dolibarr sont souvent des particuliers, et seuls les champs utiles doivent circuler.

Module Dolibarr ou service à côté : où placer le code ?

Un développement pour Dolibarr peut vivre dedans ou à côté. Dedans, c'est un module PHP qui s'appuie sur les déclencheurs et les points d'accroche : adapté quand la règle ne concerne que Dolibarr, comme un contrôle à la validation d'une facture. À côté, c'est un service qui dialogue par l'API REST et les webhooks : adapté quand plusieurs outils sont en jeu, ou quand une application, mobile par exemple, a sa propre logique.

Il arrive aussi que l'intégration révèle un écart entre Dolibarr, tel qu'il est paramétré chez vous, et vos processus : écrans éloignés de votre métier, étapes contournées par des tableurs. La question n'est alors plus celle de la connexion ; nos comparatifs Dolibarr ou logiciel sur mesure et Odoo ou Dolibarr aident à trancher.

Ce que YMHB Web réalise sur un projet Dolibarr

YMHB Web construit le service d'intégration et, si besoin, l'application qui l'utilise : portail, application terrain, outil d'atelier. Le travail démarre par un cadrage sur votre instance réelle (version, modules activés, champs complémentaires, droits), puis vient le chiffrage, en forfait global. Le code, en technologies standard, est déposé chez vous et documenté : liste des flux, codes d'événements utilisés, droits de l'utilisateur technique, procédure de rattrapage. Il vous appartient au paiement intégral. La logique d'ensemble est décrite sur notre page connecter ses outils par API.