Configuration

La configuration du module est accessible depuis Accueil > Configuration > Modules > OBAPI, onglet Réglages.

Page de configuration du module OBAPI avec les paramètres généraux

Paramètres généraux

Clé de sécurité interne

Paramètre Description
Clé de sécurité interne Clé utilisée pour signer les jetons JWT. Générez-la une seule fois lors de la première configuration et ne la modifiez plus par la suite. Si vous la changez, tous les jetons en cours deviennent invalides et vos clients devront se reconnecter.

Utilisateur par défaut

Paramètre Description
Utilisateur Dolibarr par défaut Utilisateur Dolibarr associé aux actions automatiques d'OBAPI (par exemple la création d'une commande client reçue via l'API). Il est conseillé de créer un utilisateur dédié pour identifier facilement les actions réalisées par OBAPI.

Mode serveur

Ces paramètres contrôlent l'exposition de vos données à vos clients.

Paramètre Description
Activer le serveur obAPI Active le point d'accès REST. Vos clients pourront se connecter à votre service OBAPI pour récupérer leurs données.
Adresse web de votre service obapi URL publique complète (avec le préfixe https://) du point d'entrée de votre API. Si vous utilisez un hôte virtuel dédié, indiquez son adresse ici (par exemple https://obapi.votre-domaine.fr). Consultez la page Installation pour la configuration de l'hôte virtuel.
Durée de validité de la clé temporaire Durée pendant laquelle la clé temporaire de jonction reste valide. Cette clé est transmise à votre client pour qu'il configure sa connexion initiale. Options : 10 minutes, 1 heure, 2 heures, 4 heures ou 1 jour. Choisissez une durée suffisante pour laisser le temps à votre client de faire la manipulation, mais aussi courte que possible.
Liste des objets partagés Sélection multiple des types d'objets que vous souhaitez exposer via l'API : factures, commandes, devis, tiers, contacts, produits, expéditions. Seuls les objets cochés ici seront accessibles via l'API.

Mode client

Paramètre Description
Activer le mode client pour les non-fournisseurs Par défaut, l'onglet OBAPI en mode client apparaît uniquement sur les fiches tiers de type fournisseur. Activez cette option pour afficher l'onglet OBAPI sur tous les tiers, y compris ceux qui ne sont pas des fournisseurs.

Sécurité

Paramètre Description
Autoriser les connexions HTTP non sécurisées Autorise les connexions vers un serveur OBAPI distant en HTTP (sans chiffrement TLS). Cette option peut être utile pour des installations particulières (VPN, filiales, tests en intranet). Ne l'activez jamais sur un réseau public.