Nouveautés de la version 2.0
La version 2.0 d'OBAPI marque un changement majeur : le module s'aligne désormais sur la spécification officielle du protocole OBAPI v1.0 publiée sur obapi.org. Cette refonte apporte une API plus riche, un format de réponse standardisé et une couverture fonctionnelle étendue.
Attention : cette version n'est pas compatible avec les serveurs OBAPI 1.x. Si vous consommez un service OBAPI distant, votre fournisseur devra lui aussi mettre à jour son module vers la version 2.0 pour que la connexion fonctionne.
Alignement sur le protocole OBAPI officiel
Le format des réponses, le nommage des champs et les règles de filtrage suivent désormais la spécification publique du protocole. Cela signifie que :
- Tout client conforme au protocole OBAPI officiel peut consommer un serveur Dolibarr OBAPI 2.0, y compris des clients développés dans d'autres langages ou pour d'autres ERP.
- Les intégrations existantes bâties sur la version 1.x doivent être adaptées.
Nouveaux objets exposés par l'API
Le périmètre des objets partageables via le mode serveur a été élargi. La configuration du module permet désormais d'exposer, en plus des factures, commandes et tiers déjà présents :
- Avoirs (factures d'avoir)
- Devis (propositions commerciales)
- Contacts
- Produits
- Expéditions
- Dictionnaires (listes de référence communes)
Pour chaque client, les droits Lecture et Écriture restent configurables indépendamment, objet par objet, depuis l'onglet Obapi de la fiche tiers.
Endpoint de découverte
Un nouvel endpoint public / permet à un client de découvrir automatiquement les capacités d'un serveur OBAPI (version du protocole, éditeur, objets exposés, limites de pagination). Cette information est utilisée pour détecter les incompatibilités de version et guider la configuration initiale.
Téléchargement de documents PDF
Les documents PDF associés aux factures, commandes, devis et expéditions sont désormais accessibles via l'API. Les identifiants sont chiffrés pour éviter toute fuite d'informations internes (numéros de facture, identifiants Dolibarr).
Amélioration de l'onglet tiers
- Détection automatique de la version du serveur distant lors de la connexion. Un message clair est affiché si le serveur est en version 1.x.
- Regroupement des informations client et serveur sur un même onglet pour simplifier l'administration.
- Affichage d'un lien direct vers le journal des accès filtré par client.
Rupture de compatibilité
La version 2.0 est incompatible avec les clients et serveurs OBAPI 1.x. Lors de la mise à jour, assurez-vous que vos partenaires (clients ou fournisseurs utilisant OBAPI) sont également à jour. Un avertissement est affiché dans l'interface quand le module détecte un correspondant encore en 1.x.
Qualité et robustesse
- Couverture de tests unitaires et d'intégration étendue (import de factures fournisseur, commandes fournisseur, produits, projets, tâches).
- Passage à la fonction
$db->escape()partout pour la protection SQL. - Utilisation systématique de
dol_escape_htmltag()pour l'affichage de données distantes. - Journalisation renforcée des accès API et des erreurs d'import.
Mise à jour
- Téléchargez la nouvelle version du module depuis le DoliStore ou votre espace client CAP-REL.
- Dans Accueil > Configuration > Modules/Applications, onglet Déployer/Installer un module externe, déposez la nouvelle archive ZIP.
- Rendez-vous sur l'onglet Modules/Applications disponibles, recherchez "Obapi" et désactivez puis réactivez le module. Cette étape applique les mises à jour de base de données et réenregistre les hooks et permissions.
- Vérifiez dans la configuration que la liste des objets partagés correspond à vos besoins. Les nouveaux objets (devis, avoirs, contacts, produits, expéditions, dictionnaires) ne sont pas activés par défaut.
- Prévenez vos partenaires OBAPI de la mise à jour et coordonnez avec eux le passage en version 2.0.