Installation

Installation

Téléchargement

Téléchargez le module depuis le DoliStore ou depuis votre espace client CAP-REL. Vous obtenez une archive ZIP du module.

Installation

  1. Connectez-vous en tant qu'administrateur Dolibarr
  2. Allez dans Accueil > Configuration > Modules/Applications
  3. Cliquez sur l'onglet Déployer/Installer un module externe
  4. Sélectionnez le fichier ZIP téléchargé et lancez le déploiement

Écran de déploiement d'un module externe dans Dolibarr

Activation

  1. Revenez sur l'onglet Modules/Applications disponibles
  2. Recherchez "Obapi" dans la liste
  3. Cliquez sur le bouton d'activation

Page d'activation du module OBAPI dans la liste des modules Dolibarr

Lors de l'activation, le module crée automatiquement :

  • Les tables llx_obapi_logs (journal des accès API) et llx_obapi_rights (droits par tiers)
  • Deux champs supplémentaires sur la fiche tiers : Adresse du service obAPI (URL) et Clé d'API (chaîne)
  • Une clé de chiffrement interne (sodium) stockée dans la configuration
  • Un répertoire de données obapi/temp

Hôte virtuel recommandé

Pour des raisons de sécurité, il est recommandé de créer un hôte virtuel dédié qui pointe vers le dossier public/ du module. Cela isole le point d'entrée de l'API REST du reste de votre Dolibarr.

<VirtualHost *:443>
    ServerName obapi.votre-domaine.fr
    DocumentRoot /var/www/dolibarr/htdocs/custom/obapi/public

    <Directory /var/www/dolibarr/htdocs/custom/obapi/public>
        AllowOverride All
        Require all granted
    </Directory>

    SSLEngine on
    SSLCertificateFile /etc/letsencrypt/live/obapi.votre-domaine.fr/fullchain.pem
    SSLCertificateKeyFile /etc/letsencrypt/live/obapi.votre-domaine.fr/privkey.pem
</VirtualHost>

Renseignez ensuite cette adresse (par exemple https://obapi.votre-domaine.fr) dans le paramètre Adresse web de votre service obapi de la configuration.

Sécurité : OBAPI utilise HTTPS par défaut. L'option permettant d'autoriser les connexions HTTP non sécurisées existe pour les cas particuliers (VPN, intranet, tests) mais ne doit jamais être activée en production sur un réseau public.

Permissions

Le module définit deux niveaux de permissions, configurables dans Accueil > Configuration > Utilisateurs et groupes > Permissions :

Permission Description
Lire OBAPI Accès en lecture à l'onglet OBAPI sur les fiches tiers et à la page d'accueil du module
Créer/Modifier OBAPI Accès en écriture : configuration des connexions client, gestion des droits serveur

Mise à jour

  1. Téléchargez la nouvelle version du module
  2. Dans Accueil > Configuration > Modules/Applications, onglet Déployer/Installer un module externe, déposez la nouvelle archive ZIP
  3. Rendez-vous sur l'onglet Modules/Applications disponibles, recherchez "Obapi" et désactivez puis réactivez le module. Cette étape est indispensable : elle applique les éventuelles mises à jour de la base de données et enregistre les nouveaux hooks et permissions apportés par la nouvelle version.

Désinstallation

Pour désinstaller le module, rendez-vous dans Accueil > Configuration > Modules/Applications et cliquez sur le bouton de désactivation en regard de la ligne OBAPI. Les données existantes (journal des accès, droits par tiers) sont conservées et pourront être réutilisées lors d'une éventuelle réactivation.

OBAPI Configuration