Interfaces Dolibarr vers exterieur: Difference between revisions

(Ajout explication sur création d'une interface Dolibarr vers exterieur)
 
mNo edit summary
Tag: 2017 source edit
 
(58 intermediate revisions by 12 users not shown)
Line 1: Line 1:
Pour permettre de déclencher du code personalisé en réaction à un évenement Dolibarr (création/modification/suppression d'une société/facture/produit), Dolibarr propose un mécanisme de triggers.
<!-- BEGIN interlang links -->
<!-- Do NOT edit this section
    Links below are automatically managed by PolyglotBot
    You can edit links on the English source page : Interfaces_Dolibarr_toward_foreign_systems -->
[[en:Interfaces_Dolibarr_toward_foreign_systems]]
[[es:Interfaces_Dolibarr_hacia_el_exterior]]
[[zh:Dolibarr到外部系统的接口]]
<!-- END interlang links -->


Pour ajouter son propre code à déclencher par trigger, la procédure est la suivante:
{{TemplateDocDev}}
* Copier le fichier includes/triggers/interface_demo.class.php sous le nom interface_xxx.class.php (ou xxx est une chaine de votre choix), en le laissant dans le meme répertoire. Par exemple includes/triggers/interface_monworkflow.class.php
Dolibarr fournit deux mécanismes simples pour permettre d'interfacer Dolibarr avec une application tierce:  
* Editer ce fichier interface_monworkflow.class.php afin d'ajouter votre code dans la fonction run_trigger. Cette fonction est appelée à chaque évennement Dolibarr. Placer votre code en fonction du ou des évenements sur lesquels vous voulez réagir, chaque évenement étant identifié par un test sur la variable $action:


  function run_trigger($action,$object,$user,$lang,$conf)
* Le [[Système_de_Triggers|système de Triggers]] - active votre code suite à un événement-action métier interne (par exemple, création d'une facture, modification d'un utilisateur, suppression d'une commande...)
  {
* Le [[système de Hooks]] - active votre code dans un point d'entrée de Dolibarr (un point d'entrée peut être n'importe où contrairement aux actions-triggers).
        // Mettre ici le code à exécuter en réaction de l'action
* Le [[Module Webhook FR|Module Webhook]] - un module (s'appuyant sur le système de Hooks, voir ligne ci-dessus) pour envoyer un message JSON suite à un événement trigger de Dolibarr.
        // Le type de l'évenement Dolibarr est stocké dans $action
        // Les données de l'action sont stockées dans $object
        // La configuration, utilisateur et langage sont dans $conf,$user et $lang
        if ($action == 'COMPANY_CREATE')
        {
            dolibarr_syslog("Trigger for action '$action' launched. id=".$object->id);
        }
        elseif ($action == 'COMPANY_MODIFY')
        {       
            dolibarr_syslog("Trigger for action '$action' launched. id=".$object->id);
        }
        elseif ($action == 'COMPANY_DELETE')
        ...
  }


Les évenements Dolibarr qui provoquent un appel de triggers sont, pour l'instant, les suivants:
Pour des informations sur l'autre sens et permettre à un système extérieur de faire agir Dolibarr, voir plutôt la page [[Interfaces Exterieur vers Dolibarr]].
* COMPANY_CREATE
* COMPANY_MODIFY
* COMPANY_DELETE

Latest revision as of 15:14, 14 August 2024


Dolibarr fournit deux mécanismes simples pour permettre d'interfacer Dolibarr avec une application tierce:

  • Le système de Triggers - active votre code suite à un événement-action métier interne (par exemple, création d'une facture, modification d'un utilisateur, suppression d'une commande...)
  • Le système de Hooks - active votre code dans un point d'entrée de Dolibarr (un point d'entrée peut être n'importe où contrairement aux actions-triggers).
  • Le Module Webhook - un module (s'appuyant sur le système de Hooks, voir ligne ci-dessus) pour envoyer un message JSON suite à un événement trigger de Dolibarr.

Pour des informations sur l'autre sens et permettre à un système extérieur de faire agir Dolibarr, voir plutôt la page Interfaces Exterieur vers Dolibarr.