Comment utiliser l'API Dolibarr pour automatiser vos process

Synchroniser vos clients, créer des factures automatiquement, connecter votre site à votre ERP… L'API REST de Dolibarr ouvre la porte à l'automatisation. Voici un guide complet pour la prendre en main et libérer du temps sur vos tâches répétitives.

Automatisation · API REST · Dolibarr      •      Niveau intermédiaire

1.  Qu'est-ce que l'API REST de Dolibarr ?

2.  Pourquoi automatiser vos process avec l'API ?

3.  Étape 1 : Activer le module API REST

4.  Étape 2 : Générer et sécuriser votre clé API

5.  Étape 3 : Découvrir l'API Explorer

6.  Comprendre les endpoints et leur structure

7.  Étape 4 : Vos premières requêtes en pratique

8.  Des scénarios d'automatisation concrets

9.  Multi-société, réponses et gestion des erreurs

10.  Bonnes pratiques pour des automatisations durables

11.  Questions fréquentes

12.  Conclusion : faites travailler Dolibarr pour vous

Combien d'heures passez-vous chaque semaine à recopier des informations d'un logiciel à un autre ? À créer manuellement des fiches clients, à générer des factures une par une, à exporter puis réimporter des données entre votre site web et votre outil de gestion ? Ces tâches répétitives, en plus d'être chronophages, sont une source d'erreurs et de frustration.

La solution porte un nom : l'automatisation. Et pour les utilisateurs de Dolibarr, elle passe par un outil puissant et souvent méconnu : l'API REST. Intégrée au cœur du logiciel, cette interface de programmation permet à d'autres applications de dialoguer directement avec votre Dolibarr, pour lire et écrire des données sans la moindre intervention manuelle.

Dans ce guide complet, nous allons démystifier l'API Dolibarr. Vous découvrirez ce qu'est une API REST, comment l'activer et la sécuriser, comment effectuer vos premières requêtes, et surtout comment l'exploiter concrètement pour automatiser vos processus métier. Quelques notions techniques de base suffisent : nous expliquons chaque étape pas à pas. À la fin, vous saurez transformer des heures de travail manuel en quelques lignes de code qui tournent toutes seules.

Qu'est-ce que l'API REST de Dolibarr ?

Commençons par les bases. Une API (interface de programmation applicative) est un ensemble de règles qui permet à deux logiciels de communiquer entre eux. Plutôt que de cliquer dans une interface, un programme envoie des requêtes structurées et reçoit des réponses, le tout automatiquement.

L'API de Dolibarr est de type REST, un standard du web qui s'appuie sur les requêtes HTTP — les mêmes que celles utilisées par votre navigateur. Les échanges se font au format JSON, un format texte léger et lisible, compatible avec pratiquement tous les langages de programmation. Concrètement, cela signifie que vous pouvez piloter Dolibarr depuis un script PHP, Python, JavaScript, ou même depuis un simple outil en ligne de commande.

Intégrée nativement à Dolibarr depuis plusieurs versions, cette API donne accès à la plupart des fonctionnalités du logiciel : tiers, produits, commandes, factures, utilisateurs, et bien d'autres. C'est la clé de voûte de toute intégration et de toute automatisation autour de votre ERP.

Les quatre opérations fondamentales

L'API repose sur quatre actions de base, qui correspondent aux méthodes HTTP. On parle souvent d'opérations CRUD (Create, Read, Update, Delete) :

•     GET — lire des données (consulter la liste des clients, récupérer une facture).

•     POST — créer une nouvelle donnée (ajouter un produit, créer un tiers).

•     PUT — mettre à jour une donnée existante (modifier une facture).

•     DELETE — supprimer une donnée.

Pourquoi automatiser vos process avec l'API ?

Avant de plonger dans la technique, mesurons les bénéfices concrets. L'automatisation via l'API n'est pas un luxe de développeur : c'est un levier de productivité aux retombées très réelles.

Gagner un temps précieux

Chaque tâche répétitive automatisée, c'est du temps rendu à votre activité. Synchroniser des centaines de clients, générer des dizaines de factures, mettre à jour un catalogue produit : ce qui prenait des heures s'exécute en quelques secondes, sans surveillance.

Éliminer les erreurs de saisie

La ressaisie manuelle est la première source d'erreurs : un chiffre inversé, une ligne oubliée, un doublon. En laissant un programme transférer l'information, vous garantissez la cohérence et la fiabilité de vos données entre vos différents outils.

Connecter votre écosystème

L'API permet de faire dialoguer Dolibarr avec le reste de vos logiciels : votre site e-commerce, votre outil de comptabilité, votre CRM, une application mobile maison, ou des plateformes d'automatisation. Votre ERP cesse d'être un îlot isolé pour devenir le centre névralgique d'un système connecté.

Travailler en temps réel

Une commande passée sur votre site crée instantanément le client et la commande dans Dolibarr. Un paiement encaissé met à jour la facture. Cette synchronisation en temps réel offre une vision toujours à jour de votre activité et fluidifie l'ensemble de vos opérations.

Étape 1 : Activer le module API REST

Avant toute chose, il faut activer l'API dans Dolibarr. Rendez-vous dans Accueil → Configuration → Modules/Applications, puis recherchez et activez le module Web Services API REST. Cette opération requiert des droits d'administrateur.

Une fois le module activé, vérifiez que l'API répond. Elle est servie à l'adresse /api/index.php de votre installation. Si votre Dolibarr fonctionne sous Apache, l'API est généralement disponible sans configuration supplémentaire. Sous Nginx, il peut être nécessaire d'ajuster la configuration du serveur pour autoriser l'accès aux requêtes de l'API.

Étape 2 : Générer et sécuriser votre clé API

L'API de Dolibarr utilise une authentification par clé API (un jeton, ou token). Chaque utilisateur peut disposer d'une ou plusieurs clés. Pour en générer une, connectez-vous, ouvrez la fiche de l'utilisateur concerné dans Utilisateurs & Groupes, puis rendez-vous dans l'onglet dédié à la clé API et générez-la. Copiez cette clé et conservez-la précieusement.

Cette clé doit ensuite accompagner chacune de vos requêtes. Elle se transmet dans un en-tête HTTP spécifique :

Point crucial : l'authentification est liée aux droits de l'utilisateur. La clé hérite des permissions de l'utilisateur qui l'a générée. Une requête ne pourra donc faire que ce que cet utilisateur a le droit de faire dans Dolibarr. C'est un mécanisme de sécurité fondamental qu'il faut exploiter intelligemment.

Les bonnes pratiques de sécurité

Une clé API est aussi sensible qu'un mot de passe. Quelques règles s'imposent pour ne pas transformer votre porte d'entrée en faille de sécurité :

•     Créez un utilisateur API dédié, avec uniquement les droits strictement nécessaires à l'automatisation visée. N'utilisez jamais un compte administrateur.

•     Utilisez une clé par application. En cas de compromission, vous révoquez la clé concernée sans impacter les autres intégrations.

•     N'exposez jamais la clé dans du code côté client (JavaScript de navigateur, application publique) où elle serait visible.

•     Imposez le HTTPS pour chiffrer la transmission de la clé et des données.

•     Renouvelez les clés périodiquement pour limiter les risques en cas de fuite.

Étape 3 : Découvrir l'API Explorer

Dolibarr embarque un outil formidable pour explorer et tester l'API sans écrire une ligne de code : l'API Explorer, basé sur l'interface Swagger. Vous y accédez à l'adresse /api/index.php/explorer/ de votre installation.

Cet explorateur liste l'ensemble des points d'accès (endpoints) disponibles sur votre installation, avec leur documentation générée automatiquement à partir du code. Mieux encore : il propose des formulaires interactifs « Try it out » qui vous permettent d'exécuter une vraie requête directement depuis votre navigateur, et de visualiser la réponse. C'est l'endroit idéal pour comprendre la structure des données et tester vos appels avant de les coder.

Comprendre les endpoints et leur structure

Un endpoint (ou point d'accès) est une URL qui correspond à un type de données. Dans Dolibarr, ils suivent une structure cohérente, organisée par module. L'URL de base est toujours /api/index.php/, suivie du nom de la ressource. Voici les plus courants :

Chaque endpoint accepte les différentes méthodes HTTP selon l'action voulue. Pour cibler un élément précis, on ajoute son identifiant à l'URL : une requête sur la facture numéro 42 s'adressera ainsi au chemin de la ressource facture suivi de cet identifiant.

Étape 4 : Vos premières requêtes en pratique

Passons à la pratique avec l'outil le plus universel : cURL, disponible en ligne de commande sur la plupart des systèmes. Les exemples qui suivent sont transposables dans n'importe quel langage.

Lire des données (GET)

Pour récupérer la liste de vos tiers, une simple requête GET avec votre clé suffit :

Dolibarr renvoie alors un tableau JSON contenant les tiers, avec tous leurs champs. Vous pouvez affiner la requête avec des paramètres de tri, de limite ou de filtre pour ne récupérer que ce qui vous intéresse.

Créer une donnée (POST)

Pour créer un nouveau produit, on envoie une requête POST accompagnée d'un corps JSON décrivant l'objet :

Mettre à jour (PUT) et supprimer (DELETE)

La mise à jour suit la même logique avec la méthode PUT, en ciblant l'identifiant de l'élément et en n'envoyant que les champs à modifier. La suppression, elle, utilise la méthode DELETE sur l'URL de l'élément concerné. Dans tous les cas, la clé API doit accompagner la requête, et les droits de l'utilisateur conditionnent la réussite de l'opération.

Des scénarios d'automatisation concrets

Maintenant que les bases sont posées, voyons comment tout cela se traduit en gains réels. Voici quelques automatisations parmi les plus utiles.

Synchroniser votre boutique en ligne

À chaque commande passée sur votre site e-commerce, un script appelle l'API pour créer automatiquement le client s'il n'existe pas, puis enregistrer la commande dans Dolibarr. Votre ERP reflète vos ventes en temps réel, sans aucune saisie manuelle. À l'inverse, vous pouvez pousser votre catalogue produit de Dolibarr vers votre boutique pour garder des fiches cohérentes.

Générer et envoyer des factures automatiquement

Pour les abonnements ou les prestations récurrentes, un script programmé peut créer chaque mois les factures correspondantes via l'API, puis déclencher leur validation. Le temps passé sur la facturation récurrente fond littéralement à zéro.

Alimenter un tableau de bord externe

Vous souhaitez suivre vos indicateurs dans un outil de visualisation ou un tableur partagé ? Un script interroge régulièrement l'API pour extraire le chiffre d'affaires, les factures impayées ou les nouvelles commandes, et alimente votre tableau de bord. Vos données de pilotage sont toujours fraîches.

Relier Dolibarr à des plateformes d'automatisation

Des plateformes d'automatisation « sans code » permettent de connecter Dolibarr à des centaines d'autres services via son API. Vous pouvez ainsi déclencher l'envoi d'un message lorsqu'une facture est payée, créer une tâche dans votre outil de gestion de projet à chaque nouvelle commande, ou notifier votre équipe sur sa messagerie. Les possibilités sont quasi illimitées.

Multi-société, réponses et gestion des erreurs

Si vous utilisez Dolibarr en mode multi-société, l'API gère ce cas grâce à un en-tête dédié, DOLAPIENTITY, qui permet de cibler l'entité concernée par la requête. Vous pilotez ainsi plusieurs sociétés depuis une même logique d'automatisation.

Côté réponses, l'API renvoie systématiquement du JSON, accompagné d'un code de statut HTTP qui indique le résultat : un code de succès pour une opération réussie, ou un code d'erreur en cas de problème (clé invalide, droits insuffisants, donnée introuvable, requête mal formée). Votre code doit toujours vérifier ce statut avant d'exploiter la réponse.

Une bonne gestion des erreurs est essentielle pour une automatisation fiable. Prévoyez systématiquement de traiter les cas d'échec : journaliser l'erreur, réessayer si pertinent, et alerter en cas de problème persistant. Une automatisation qui échoue en silence est plus dangereuse qu'une absence d'automatisation.

Bonnes pratiques pour des automatisations durables

Pour que vos automatisations restent fiables et maintenables dans le temps, gardez en tête ces quelques principes :

1.    Testez toujours dans l'Explorer d'abord. Validez chaque requête dans l'API Explorer avant de l'intégrer à un script.

2.    Travaillez sur un environnement de test. Ne mettez jamais au point vos scripts directement sur votre Dolibarr de production.

3.    Limitez les droits de l'utilisateur API. Le principe du moindre privilège réduit l'impact d'une éventuelle compromission.

4.    Journalisez vos appels. Conserver une trace des requêtes facilite grandement le débogage.

5.    Gérez les volumes raisonnablement. Pour de gros traitements, paginez vos requêtes et évitez de surcharger le serveur.

6.    Documentez vos intégrations. Notez ce que fait chaque script et quelle clé il utilise : votre futur vous-même vous remerciera.

Questions fréquentes

Faut-il savoir coder pour utiliser l'API Dolibarr ?

Pour explorer et tester, non : l'API Explorer permet d'effectuer des requêtes depuis le navigateur sans code. Pour automatiser réellement, des notions de programmation ou l'usage d'une plateforme d'automatisation sans code sont nécessaires. Les bases suffisent pour démarrer : l'API REST est un standard simple et bien documenté.

L'API est-elle disponible dans toutes les versions de Dolibarr ?

L'API REST est intégrée au cœur de Dolibarr depuis plusieurs versions et constitue aujourd'hui un module standard. Il suffit de l'activer dans la configuration. Veillez à maintenir votre installation à jour pour bénéficier des dernières corrections et du support de tous les endpoints.

Que faire si une requête renvoie une erreur de droits ?

Une erreur de permissions signifie que l'utilisateur associé à la clé API n'a pas le droit d'effectuer l'action demandée. Vérifiez les permissions de cet utilisateur dans Dolibarr et accordez-lui les droits nécessaires — sans pour autant lui donner plus que le strict requis.

Puis-je connecter Dolibarr à mon site sans développer moi-même ?

Oui. Des connecteurs existent pour de nombreuses plateformes e-commerce, et les outils d'automatisation sans code permettent de relier Dolibarr à d'autres services via son API, sans écrire de code. Pour des besoins très spécifiques, le développement reste cependant la voie la plus flexible.

Conclusion : faites travailler Dolibarr pour vous

L'API REST de Dolibarr est un véritable trésor pour qui veut automatiser ses process et libérer du temps. En quelques étapes — activer le module, générer une clé, explorer les endpoints, écrire ses premières requêtes — vous ouvrez la voie à des automatisations qui éliminent la saisie manuelle, fiabilisent vos données et connectent votre ERP au reste de votre écosystème.

La force de cette approche tient à sa progressivité. Vous n'avez pas besoin de tout révolutionner d'un coup : commencez par une seule automatisation, validez-la dans l'API Explorer, puis déployez-la sereinement. Chaque tâche automatisée est du temps reconquis pour ce qui compte vraiment dans votre activité.

Le meilleur conseil ? Ouvrez dès aujourd'hui l'API Explorer de votre Dolibarr, lancez une première requête GET sur vos tiers, et observez la réponse. Ce petit pas vous donnera la mesure du potentiel à portée de main — et l'envie d'aller plus loin. Votre ERP ne demande qu'à travailler pour vous, à condition de lui en donner les instructions.