Utiliser l’API REST de Dolibarr pour connecter une application mobile : Guide complet pour développeurs et PME
   05/15/2025 00:00:00     Dolibarr , Wiki Dolibarr    0 Commentaires
Utiliser l’API REST de Dolibarr pour connecter une application mobile : Guide complet pour développeurs et PME

À l’ère de la transformation numérique mobile-first, intégrer des applications d’entreprise aux plateformes mobiles n’est plus une tendance, mais une nécessité stratégique. Dolibarr ERP & CRM, connu pour son architecture open source modulaire, propose une API REST robuste permettant aux développeurs de connecter des applications externes, y compris des applications mobiles, directement au système central. Cette flexibilité ouvre la voie à des flux de travail optimisés, une synchronisation des données en temps réel et une meilleure expérience utilisateur.

Que vous soyez une petite entreprise souhaitant étendre ses outils internes, une société logicielle développant un client mobile pour Dolibarr, ou un consultant IT préparant une solution hybride, cet article est votre guide complet. Nous couvrons tout : fondamentaux de l’API, authentification, points de terminaison, cas d’usage, gestion des erreurs et bonnes pratiques pour déployer une intégration mobile sécurisée et évolutive.

Comprendre l’API REST de Dolibarr

L’API REST de Dolibarr expose un large éventail d’endpoints correspondant aux modules de base du système — tels que les factures, les clients, les produits, les commandes et les projets. Basée sur les méthodes HTTP standards (GET, POST, PUT, DELETE), l’API suit les principes RESTful, ce qui la rend facile à utiliser depuis n’importe quelle plateforme prenant en charge HTTP.

Introduite dans la version 5.0 et considérablement améliorée des versions 10 à 16, l’API REST est aujourd’hui un point d’intégration fiable. En 2025, elle est compatible avec les versions 14 et supérieures de Dolibarr, avec les derniers correctifs de sécurité et améliorations de structuration des données.

Pourquoi utiliser l’API REST pour une application mobile ?

L’intégration d’une application mobile avec l’API REST de Dolibarr offre de nombreux avantages :

  • Synchronisation en temps réel des données (produits, stock, factures)

  • Accès personnalisé aux modules CRM, comptabilité ou RH

  • Accès terrain pour commerciaux, livreurs ou techniciens

  • Notifications push pour les nouveaux prospects ou retards de paiement

  • Fonctionnalités hors ligne avec synchronisation différée

Prérequis et configuration de l’environnement

Pour démarrer, il vous faut :

  • Une installation fonctionnelle de Dolibarr (v14 ou supérieure recommandée)

  • Un accès administrateur à Dolibarr

  • L’API activée dans la configuration

  • Une clé API ou un token OAuth

  • Une application mobile ou un framework de développement (Flutter, React Native, Android Studio, etc.)

Activer le module API dans Dolibarr :

  1. Aller dans Configuration > Modules/Applications

  2. Activer le module API REST

  3. Aller dans Utilisateurs > Liste > Modifier

  4. Générer et copier la clé API pour l’utilisateur

Optionnel : Installer le plugin APIGateway ou configurer les règles CORS si l’app mobile est en mode web.

Authentification : Clé API vs OAuth2

Dolibarr prend en charge deux méthodes d’authentification :

Clé API (authentification par token)

  • Simple à mettre en œuvre

  • Idéal pour des apps internes ou mono-utilisateur

  • Envoyée en en-tête : DOLAPIKEY: votre_clé

OAuth2

  • Plus sécurisé et évolutif

  • Recommandé pour des apps publiques avec plusieurs utilisateurs

  • Requiert un ID client, une clé secrète, et une URL de redirection

Utilisez OAuth2 si vous publiez votre app mobile dans un store ou pour un public externe.

Structure de l’API REST et endpoints disponibles

L’API Dolibarr est organisée autour d’un point de base :

https://votredomaine.com/api/index.php

Chaque ressource (clients, produits, factures…) est accessible via une route spécifique :

Exemples :

  • GET /thirdparties – Lister tous les clients ou fournisseurs

  • POST /thirdparties – Créer un nouveau client

  • GET /products – Obtenir la liste des produits

  • POST /invoices – Créer une nouvelle facture

  • GET /users/me – Obtenir les infos de l’utilisateur courant

Les appels API doivent être authentifiés et retournent des réponses JSON.

Cas d’usage types pour des apps mobiles

1. Application CRM mobile

  • Afficher les fiches clients et coordonnées

  • Ajouter ou modifier des prospects

  • Voir l’historique des actions

  • Planifier des rendez-vous ou relances

2. Application de commande commerciale

  • Parcourir les produits avec visuels et tarifs

  • Créer devis ou commandes

  • Vérifier les stocks en direct

  • Transformer les devis en factures

3. Application technicien terrain

  • Voir les projets ou interventions assignées

  • Mettre à jour l’état des missions

  • Pointer les heures travaillées

  • Joindre des photos ou documents

4. Application d’inventaire

  • Scanner des codes-barres produits

  • Ajuster les stocks

  • Réceptionner des marchandises

  • Générer des mouvements de stock

Gestion des réponses et erreurs

Les réponses suivent les statuts HTTP classiques :

  • 200 OK – Lecture réussie

  • 201 Created – Création réussie

  • 400 Bad Request – Données invalides

  • 401 Unauthorized – Identifiants incorrects

  • 403 Forbidden – Droits insuffisants

  • 500 Internal Server Error – Erreur côté API

Structure JSON :

{
  "success": true,
  "error": null,
  "data": {...}
}

Vérifiez success et gérez les erreurs dans l’interface de l’application.

Pagination et filtres

Pour les listes (produits, clients...), l’API propose pagination et filtres :

  • limit=25&sortfield=lastname&sortorder=asc

  • sqlfilters=(status:in:(1,2))

Indispensable pour les apps mobiles à faible bande passante.

Envoi de fichiers et pièces jointes

L’API REST de Dolibarr permet l’upload de documents (contrats, photos, PDF).

Exemple :

POST /documents/upload
Headers:
  DOLAPIKEY: votre_clé
Body (multipart/form-data):
  refid, ref, modulepart, file

À utiliser pour joindre des fichiers aux factures ou missions.

Sécurité : recommandations clés

  • Toujours utiliser HTTPS

  • Limiter les IPs si possible

  • Préférer OAuth2 pour des apps publiques

  • Implémenter un rate limiting côté mobile

  • Ne jamais stocker la clé API en dur dans le code

Développement mobile : frameworks recommandés

Choix possibles :

  • Flutter : rapide, multiplateforme, très bon rendu UI

  • React Native : JS + large écosystème

  • Android/iOS natif : pour performance maximale

Utilisez des librairies comme axios (JS), http (Dart), Retrofit (Java) pour les appels API.

Bonnes pratiques de déploiement

  • Gérer un versioning clair de votre couche API

  • Cacher les données statiques en local

  • Suivre les erreurs API via logs ou analytics

  • Proposer une synchronisation en arrière-plan

  • Tester avec différentes résolutions d’écran et en mode hors ligne

Problèmes fréquents et solutions

Problème : erreur 401

  • Vérifiez que la clé API est valide et bien transmise dans les headers

Problème : erreur CORS sur mobile

  • Ajustez les headers serveur (Apache/Nginx) ou utilisez un proxy

Problème : réponse HTML au lieu de JSON

  • Vérifiez l’endpoint utilisé et l’en-tête Accept: application/json

Exemple réel : app Flutter de suivi client

Une app Flutter simple peut :

  • S’authentifier avec la clé API

  • Lister les clients via GET /thirdparties

  • Afficher les données dans une liste mobile

  • Voir les commandes avec GET /orders?fk_soc=ID

  • Mettre à jour un client via PUT /thirdparties/ID

Conclusion

Connecter une application mobile à Dolibarr via son API REST permet d’augmenter significativement la productivité, la mobilité et la qualité des données. Grâce à sa structure ouverte et ses modules natifs, Dolibarr devient une véritable plateforme connectée.

En suivant les bonnes pratiques de sécurité, de performance et de développement mobile, vous pouvez créer une intégration fiable, fluide et évolutive. Que vous développiez un outil interne ou une application commerciale, l’API REST de Dolibarr est votre passerelle vers une gestion moderne orientée mobilité.

Commentaires

Connectez-vous ou inscrivez-vous pour poster des commentaires