NAV

Introduction

Dendreo est un logiciel de gestion pour centre de formation.

Vous pouvez créer un compte d'essai de 14 jours sur notre site internet.

Fonctionnement général

Authentification

Nous proposons une authentification par token. Le token peut être communiqué de deux manières différentes :

L'absence de ce token ou l'utilisation d'un token invalide, entrainera une erreur 401 (Unauthorized).

Attention, l'URL de l'API dépend de votre URL de connexion. Dans les exemples ci-dessous, les URLs sont fournis pour le compte demo.

Exemple : https://pro.dendreo.com/demo/api/entreprises.php

Formats

Requêtes

Deux stratégies sont proposées pour les requêtes liées à la création ou la mise à jour d'un élément :

Réponses

Seul le format JSON est proposé actuellement.

Erreurs

{
  "status": "failure",
  "errors": [
    "Une raison sociale est obligatoire (raison_sociale est vide)"
  ]
}

Quand des attributs sont validés par l'API (présence, format, existence), si aucune erreur n'est détectée, un statut 200 (Success) ou 201 (Created) sera retourné par l'API.

Dans le cas contraire, un statut 422 (Unprocessable Entity) sera retourné accompagné des messages d'erreurs associés aux validations qui ont échouée.

Requêtes

[
  {
    "id_entreprise": "3",
    "raison_sociale": "EDF"
  },
  {
    "id_entreprise": "4",
    "raison_sociale": "Peugeot"
  }
]

Dans le cas des requêtes GET il est possible de requêter plus d'un objet, en mettant plusieurs id à la suite, séparés par des virgules

Exemple : GET https://pro.dendreo.com/demo/api/contacts.php?id=12,14,16

Pour les objets de type : Entreprise, Contact, Participant, Formateur et Action De Formation il est possible d'utiliser id_externe à la place de id

Exemple : GET https://pro.dendreo.com/demo/api/entreprises.php?id_externe=externe_12,externe_14,externe_16

Notez qu'il est possible d'utiliser id ou id_objet, par exemple id ou id_contact pour afficher un contact particulier :

Exemple : GET https://pro.dendreo.com/demo/api/contacts.php?id=12 Exemple : GET https://pro.dendreo.com/demo/api/contacts.php?id_contact=12

Dans le cas des requêtes SHOW et INDEX il est possible de restreindre les colonnes à afficher en renseignant le paramètre fields.

Exemple : GET https://pro.dendreo.com/demo/api/entreprises.php?fields=id_entreprise,raison_sociale

Il est aussi possible d'inclure dans la réponse des éléments liés en les indiquant dans le paramètre “include”.

Exemple : GET https://pro.dendreo.com/demo/api/contacts.php?include=entreprise

Enfin, certains attributs sont cachés par défaut mais vous pouvez les afficher avec le paramètre show. Ces champs champs sont notamment date_add, date_edit et date_delete.

Exemple : GET https://pro.dendreo.com/demo/api/contacts.php?id=12&show=date_edit,date_delete

Recherche/filtre

Dans le cas des requêtes INDEX il est possible de filtrer les résultats en indiquant une clef de recherche dans le paramètre search.

Exemple : GET https://pro.dendreo.com/demo/api/entreprises.php?search=EDF

Les champs sur lesquels cette recherche est effectuée sont précisés pour chaque objet.

Certains objets proposent de filter les résultats de recherche par date d'ajout et d'édition: created_after, created_before, updated_after, updated_before

le format de date est : YYYY-MM-DD (= ‘YYYY-MM-DD 00:00:00’ ou YYYY-MM-DD hh:mm:ss)

Et retournera les objets dont la date_add ou date_edit est “inférieur ou égale” ou “supérieur ou égale” à la date donnée.

Ces parametres peuvent être cumulés.

Les objets sur lesquels ce filtre est disponible sont : Contact, Facture, Entreprise, Formateur et Participant.

Catégories de module

Exemple de réponse

{
  "id_categorie_module": "3",
  "intitule": "Management",
  "status": "1"
}

Une catégorie de module correspond à un système de classification des modules de formation qui constituent le catalogue.

Actions disponibles

Action Méthode URL
INDEX GET /api/categories_module.php
SHOW GET /api/categories_module.php?id=3

Catégories de produits

Exemple de réponse

{
  "id_categorie_produit": "2",
  "intitule": "E-Learning",
  "color": "490A3D",
  "status": "1"
}

Lorsque le mode “Multi-Produits” est activé Dendreo est capable de gérer différents Produits, autres que de la formation. Vous pourrez ajouter différents types de Produits à votre Catalogue, puis utiliser ces Produits au sein de vos Actions de Formation. Vous pouvez même réaliser des Actions Hors Formation, c'est à dire des Actions ne comportant aucun Module de formation.

Actions disponibles

Action Méthode URL
INDEX GET /api/categories_produit.php
SHOW GET /api/categories_produit.php?id=3

Modules/Produits

Par défaut, Dendreo permet de programmer de la formation. Il existe cependant une option appelée “Multi-Produits” qui permet d'associer d'autres produits (modules) à une action de formation.

La catégorie de produit par défaut (id_categorie_produit = 1) correspond à de la formation. Un module avec un id_categorie_produit différent de 1 est donc considéré comme un produit autre que de la formation.

Lister tous les modules de formation

[
  {
    "id_module": "4",
    "id_categorie_produit": "1",
    "intitule": "[Demo] Les Bases Du Management",
    "include_in_bpf": "1",
    "numero": "4",
    "numero_complet": "MOD_2014004",
    "numero_comptable": "",
    "description": "Les bases du management",
    "prix": "1000.00",
    "duree_heures": "4.00",
    "duree_jours": "1.00",
    "id_formacode": "0",
    "id_specialite": "2",
    "id_formateur": "0",
    "id_categorie_module": "1",
    "nb_participants_min": "0",
    "nb_participants": "0",
    "objectif": "",
    "public_vise": "",
    "pre_requis": "",
    "intitules": "",
    "id_salle_de_formation": "0",
    "moyens_pedago": "",
    "id_centre_de_formation": "0"
  }
]

Accède à tous les modules de formation présents sur Dendreo.

Il est possible d'afficher des données supplémentaires pour les modules en renseignant le paramètre include.

Exemple : GET https://pro.dendreo.com/demo/api/modules.php?include=visuel

Il est possible de filtrer les modules via le paramètre suivant :

numero_complet : Le numéro complet du module

Exemple : GET https://pro.dendreo.com/demo/api/modules.php?numero_complet=MOD_2019001

Requête HTTP

GET https://pro.dendreo.com/demo/api/modules.php

Afficher un module de formation

{
  "id_module": "4",
  "id_categorie_produit": "1",
  "intitule": "[Demo] Les Bases Du Management",
  "include_in_bpf": "1",
  "numero": "4",
  "numero_complet": "MOD_2014004",
  "numero_comptable": "",
  "description": "Les bases du management",
  "prix": "1000.00",
  "duree_heures": "4.00",
  "duree_jours": "1.00",
  "id_formacode": "0",
  "id_specialite": "2",
  "id_formateur": "0",
  "id_categorie_module": "1",
  "nb_participants_min": "0",
  "nb_participants": "0",
  "objectif": "",
  "public_vise": "",
  "pre_requis": "",
  "intitules": "",
  "id_salle_de_formation": "0",
  "moyens_pedago": "",
  "id_centre_de_formation": "0",
  "actions_de_formation_programmees": [
    {
      "id_action_de_formation": "132",
      "intitule": "[Demo] Les Bases Du Management",
      "date_debut": "2016-09-02 09:00:00",
      "date_fin": "2016-09-02 17:00:00"
    }
  ]
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/modules.php?id=4

Il est possible de récupérer l'url du visuel associé au module dans la réponse, en rajoutant include=visuel à votre requête.

Exemple : GET https://pro.dendreo.com/demo/api/modules.php?id=4&include=visuel

Notez que les actions_de_formation_programmees retournées pour un module sont uniquement les actions de formation dans une étape de type “prévisionnelle” (cela exclue donc les formations en cours de réalisation ou terminées).

Formateurs

Lister tous les formateurs

[
  {
    "id_formateur": "5",
    "numero": "1",
    "numero_complet": "",
    "n_secu": "",
    "civilite": "M.",
    "nom": "Dupond",
    "nom_jeune_fille": "",
    "prenom": "Jacques",
    "date_de_naissance": "1963-09-01",
    "lieu_de_naissance": "LYON",
    "nationalite": "Française",
    "situation_familiale": "-",
    "adresse": "33 rue Bichat",
    "code_postal": "75006",
    "ville": "PARIS",
    "profession": "Formateur Professionnel d'Adultes",
    "telephone_perso": "0676655443",
    "telephone_pro": "0676655443",
    "email_perso": "",
    "email_pro": "contact@cformateur.fr",
    "statut": "travailleur_independant",
    "remu_horaire_par_defaut": "0.00",
    "diplomes": "",
    "id_externe": "",
    "id_centre_de_formation": "0"
  }
]

Accède à tous les formateurs présents sur Dendreo.

Il est possible de filtrer les formateurs via le paramètre suivant :

numero_complet : Le numéro complet du formateur

Exemple : GET https://pro.dendreo.com/demo/api/formateurs.php?numero_complet=FORM_2019001

Requête HTTP

GET https://pro.dendreo.com/demo/api/formateurs.php

Afficher un formateur

{
  "id_formateur": "5",
  "numero": "1",
  "numero_complet": "",
  "n_secu": "",
  "civilite": "M.",
  "nom": "Dupond",
  "nom_jeune_fille": "",
  "prenom": "Jacques",
  "date_de_naissance": "1963-09-01",
  "lieu_de_naissance": "LYON",
  "nationalite": "Française",
  "situation_familiale": "-",
  "adresse": "33 rue Bichat",
  "code_postal": "75006",
  "ville": "PARIS",
  "profession": "Formateur Professionnel d'Adultes",
  "telephone_perso": "0676655443",
  "telephone_pro": "0676655443",
  "email_perso": "",
  "email_pro": "contact@cformateur.fr",
  "statut": "travailleur_independant",
  "remu_horaire_par_defaut": "0.00",
  "diplomes": "",
  "id_externe": "",
  "id_centre_de_formation": "0"
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/formateurs.php?id=5

Il est possible de récupérer l'url de la photo de profil du formateur dans la réponse, en rajoutant include=photo à votre requête.

Exemple : GET https://pro.dendreo.com/demo/api/formateurs.php?id=5&include=photo

Ajouter un formateur

{
    "id_formateur": "5",
    "id_add": "0",
    "id_edit": "0",
    "numero": "9",
    "numero_complet": "FORM_2018009",
    "numero_perso": "0",
    "n_secu": "",
    "civilite": "M.",
    "nom": "Dupond",
    "nom_jeune_fille": "",
    "prenom": "Jacques",
    "color": "",
    "date_de_naissance": "1963-09-01",
    "lieu_de_naissance": "LYON",
    "nationalite": "Française",
    "situation_familiale": "-",
    "adresse": "33 rue Bichat",
    "code_postal": "75006",
    "ville": "PARIS",
    "profession": "Formateur Professionnel d'Adultes",
    "biographie_catalogue": "",
    "telephone_perso": "0676655443",
    "telephone_pro": "0676655443",
    "email_perso": "",
    "email_pro": "contact@cformateur.fr",
    "statut": "Travailleur indépendant/gérant non salarié",
    "statut_bpf": "Personne de votre organisme (CDI, CDD, occasionnel, bénévole)",
    "mode_remu": "Horaire",
    "remu_horaire_par_defaut": "0",
    "key_uniq": "",
    "id_externe": "",
    "id_centre_de_formation": "0"
}

Paramètres

Intitulé Obligatoire Description
nom oui Nom
prenom oui Prénom
civilite non Civilité (format vérifié)
date_de_naissance non Date de naissance (format “AAAA-MM-JJ” ou “JJ/MM/AAAA”)
statut non travailleur_independant, cdi, cdd, occasionnel, benevoles, exterieur
statut_bpf non interieur, exterieur
mode_remu non Mode de rémunération : horaire, journalier
remu_horaire_par_defaut  non Rémunération Horaire par défaut
n_secu non Numéro de sécurité sociale
lieu_de_naissance non Lieu de naissance
nationalite non Nationalité
situation_familiale non Situation familliale
adresse non Adresse (Rue)
code_postal non Code postal
ville non Ville
profession non Profession
biographie_catalogue non Biographie affichée sur le catalogue
telephone_perso non Téléphone perso
telephone_pro non Téléphone pro
email_perso non Email perso
email_pro non Email pro
id_centre_de_formation non ID Centre de formation (existence vérifiée)

Requête HTTP

POST https://pro.dendreo.com/demo/api/formateurs.php

Entreprises

Lister toutes les entreprises

[
  {
    "id_entreprise": "1375",
    "numero": "1",
    "numero_complet": "",
    "numero_compte_client": "",
    "siret": "1678637863 00013",
    "raison_sociale": "EDF",
    "appellation": "",
    "sigle": "Entreprise privée",
    "statut_juridique": "SARL",
    "telephone": "04 76 76 54 53",
    "fax": "04 67 65 53 64",
    "site_internet": "",
    "email_standard": "",
    "adresse": "8 AVenue du Gal ",
    "code_postal": "75002",
    "ville": "Paris",
    "pays": "France",
    "facturation_raison_sociale": "",
    "facturation_adresse": "",
    "facturation_code_postal": "",
    "facturation_ville": "",
    "facturation_pays": "",
    "mode_financement_par_defaut": "entreprise",
    "nb_employes": "0",
    "enjeu": "0",
    "client": "0",
    "id_contact": "0",
    "id_contact_secondaire": "0",
    "commentaires": "",
    "particulier": "0",
    "id_externe": "",
    "tva_intra": "16786387 00013",
    "id_centre_de_formation": "0"
  }
]

Il est possible de filtrer les entreprises via les paramètres suivant :

search : La raison_sociale ou le siret de l'entreprise

Exemple : GET https://pro.dendreo.com/demo/api/entreprises.php?search=EDF

numero_complet : Le numéro complet de l'entreprise

Exemple : GET https://pro.dendreo.com/demo/api/entreprises.php?numero_complet=ENT_2019001

Requête HTTP

GET https://pro.dendreo.com/demo/api/entreprises.php

Afficher une entreprise

{
  "id_entreprise": "1375",
  "numero": "1",
  "numero_complet": "",
  "numero_compte_client": "",
  "siret": "1678637863 00013",
  "raison_sociale": "EDF",
  "appellation": "",
  "sigle": "Entreprise privée",
  "statut_juridique": "SARL",
  "telephone": "04 76 76 54 53",
  "fax": "04 67 65 53 64",
  "site_internet": "",
  "email_standard": "",
  "adresse": "8 AVenue du Gal ",
  "code_postal": "75002",
  "ville": "Paris",
  "pays": "France",
  "facturation_raison_sociale": "",
  "facturation_adresse": "",
  "facturation_code_postal": "",
  "facturation_ville": "",
  "facturation_pays": "",
  "mode_financement_par_defaut": "entreprise",
  "nb_employes": "0",
  "enjeu": "0",
  "client": "0",
  "id_contact": "0",
  "id_contact_secondaire": "0",
  "commentaires": "",
  "particulier": "0",
  "id_externe": "",
  "tva_intra": "16786387 00013",
  "id_centre_de_formation": "0"
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/entreprises.php?id=1375

Ajouter une entreprise

Seule la présence de l'attribut raison_sociale est validée.

{
  "id_entreprise": "1375",
  "numero": "1",
  "numero_complet": "",
  "numero_compte_client": "",
  "siret": "1678637863 00013",
  "raison_sociale": "EDF",
  "appellation": "",
  "sigle": "Entreprise privée",
  "statut_juridique": "SARL",
  "telephone": "04 76 76 54 53",
  "fax": "04 67 65 53 64",
  "site_internet": "",
  "email_standard": "",
  "adresse": "8 Avenue du Gal ",
  "code_postal": "75002",
  "ville": "Paris",
  "pays": "France",
  "facturation_raison_sociale": "",
  "facturation_adresse": "",
  "facturation_code_postal": "",
  "facturation_ville": "",
  "facturation_pays": "",
  "mode_financement_par_defaut": "entreprise",
  "nb_employes": "0",
  "enjeu": "0",
  "client": "0",
  "id_contact": "0",
  "id_contact_secondaire": "0",
  "commentaires": "",
  "particulier": "0",
  "id_externe": "",
  "tva_intra": "16786387 00013",
  "id_centre_de_formation": "0"
}

Paramètres

Intitulé Obligatoire Description
raison_sociale oui Raison sociale
siret non N° SIRET
appellation non Appellation
sigle non Sigle
statut_juridique non Statut juridique
telephone non Téléphone
fax non Fax
site_internet non Site internet
telephone non Téléphone
email_standard non Email standard
adresse non Adresse
code_postal non Code postal
ville non Ville
pays non Pays
nb_employes non Nombre d'employés
commentaires non Commentaires
id_administrateur non Commercial associé (existence vérifiée)
id_externe non ID externe (synchro)
facturation_raison_sociale non Raison sociale (facturation)
facturation_adresse non Adresse (facturation)
facturation_code_postal non Code postal (facturation)
facturation_ville non Ville (facturation)
facturation_pays non Pays (facturation)
id_entreprise_parente (ou entreprise_id) non ID de l'Entreprise parente. Vous pouvez aussi utiliser :
entreprise_parente (ou entreprise_parente_raison_sociale) non Raison sociale de l'Entreprise parente, pour rechercher automatiquement un ID Entreprise parente
id_centre_de_formation non ID Centre de formation (existence vérifiée)

Requête HTTP

POST https://pro.dendreo.com/demo/api/entreprises.php

Contacts

Lister tous les contacts

[
  {
    "id_contact": "3",
    "id_entreprise": "3",
    "civilite": "Mme",
    "nom": "Marue ",
    "prenom": "",
    "fonction": "Responsable Formation ",
    "telephone_direct": "01 02 03 04 05",
    "portable": "",
    "email": "maru@domaine.fr",
    "particulier": "0",
    "id_externe": "",
    "id_centre_de_formation": "0"
  }
]

Il est possible de n'afficher que les contacts appartenants à une entreprise en renseignant l'attribut id_entreprise.

Exemple : GET https://pro.dendreo.com/demo/api/contacts.php?id_entreprise=3

Il est aussi possible de filtrer les contacts sur les attributs nom ou email ainsi que d'inclure les informations de l'entreprise via l'attribut include.

Exemple : GET https://pro.dendreo.com/demo/api/contacts.php?include=entreprise

Requête HTTP

GET https://pro.dendreo.com/demo/api/contacts.php

Afficher un contact

{
  "id_contact": "3",
  "id_entreprise": "3",
  "civilite": "Mme",
  "nom": "Marue ",
  "prenom": "",
  "fonction": "Responsable Formation ",
  "telephone_direct": "01 02 03 04 05",
  "portable": "",
  "email": "maru@domaine.fr",
  "particulier": "0",
  "id_externe": "",
  "id_centre_de_formation": "0"
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/contacts.php?id=3

Il est possible de récupérer l'url de la photo de profil du contact dans la réponse, en rajoutant include=photo à votre requête.

Exemple : GET https://pro.dendreo.com/demo/api/contacts.php?id=5&include=photo

Ajouter un contact

{
  "id_contact": "3",
  "id_entreprise": "3",
  "civilite": "Mme",
  "nom": "Marue ",
  "prenom": "",
  "fonction": "Responsable Formation ",
  "telephone_direct": "01 02 03 04 05",
  "portable": "",
  "email": "maru@domaine.fr",
  "particulier": "0",
  "id_externe": "",
  "id_centre_de_formation": "0"
}

Rattacher le contact à une entreprise

Il existe trois façons de rattacher un contact à une entreprise qui sont évaluées dans l'ordre de préférence suivant :

Paramètres

Intitulé Obligatoire Description
id_entreprise non ID Entreprise (existence vérifiée)
nom oui Nom
prenom non prénom
civilite non Civilité (format vérifié)
fonction non Fonction
telephone_direct non Téléphone direct
portable non Portable
email non Email
id_externe non ID Externe (synchro)
entreprise_raison_sociale non Liaison avec l'entreprise via la raison sociale
entreprise_id_externe non Liaison avec l'entreprise via son id externe

Requête HTTP

POST https://pro.dendreo.com/demo/api/contacts.php

Particuliers

Ajouter un particulier

L'ajout d'un particulier se fait sur le même URL qu'un contact avec la variable particulier égale à 1.

{
  "id_contact": "3",
  "id_entreprise": "3",
  "civilite": "Mme",
  "nom": "Marue ",
  "prenom": "",
  "fonction": "Responsable Formation ",
  "telephone_direct": "01 02 03 04 05",
  "portable": "",
  "email": "maru@domaine.fr",
  "particulier": "1",
  "id_externe": "",
  "id_participant": 5
}

Paramètres

Intitulé Obligatoire Description
particulier oui valeur égale à 1 sinon ajout d'un contact
nom oui Nom
prenom oui prénom
civilite non Civilité (format vérifié)
fonction non Fonction
telephone_direct non Téléphone direct
portable non Portable
email non Email
id_externe non ID Externe (synchro)
adresse non Adresse
code_postal non Code postal
ville non Ville
pays non Pays
id_administrateur non Commercial associé (existence vérifiée)
statut_bpf non independant,cpf_autonome,recherche_emploi,hors_bpf

Requête HTTP

POST https://pro.dendreo.com/demo/api/contacts.php

Participants

Lister tous les participants

[
  {
    "id_participant": "17",
    "id_add": "0",
    "id_edit": "0",
    "id_delete": "0",
    "civilite": "Mme",
    "nom": "Duru ",
    "prenom": "Françoise ",
    "email": "",
    "commentaires": "",
    "portable": "",
    "fonction": "Assistante RH",
    "statut_bpf": "salarie",
    "date_de_naissance": "0000-00-00",
    "departement_naissance": "",
    "adresse": "",
    "code_postal": "",
    "ville": "",
    "pays": "",
    "id_entreprise": "4",
    "particulier": "0",
    "id_externe": "",
    "id_centre_de_formation": "0",
    "id_contact": "",
    "responsable_type": "",
    "responsable_id": ""
  }
]

Il est possible de n'afficher que les participants appartenants à une entreprise en renseignant l'attribut id_entreprise.

Exemple : GET https://pro.dendreo.com/demo/api/participants.php?id_entreprise=4

Il est aussi possible de filtrer les participants sur les attributs nom ou email (via l'attribut search qui fera une recherche “OR” sur email ou nom). Si vous souhaitez chercher juste sur l'email ou le nom (ou faire une recherche “AND”), vous pouvez le faire via les attributs email ou nom en GET qui sont aussi acceptés (par exemple participants.php?email=test@example.com&nom=dupont pour chercher les participants ayant cet email ET ce nom). Vous pouvez aussi inclure les informations de l'entreprise via l'attribut include.

Exemple : GET https://pro.dendreo.com/demo/api/participants.php?search=user@domain.tld

Exemple : GET https://pro.dendreo.com/demo/api/participants.php?include=entreprise

Requête HTTP

GET https://pro.dendreo.com/demo/api/participants.php

Afficher un participant

{
  "id_participant": "17",
  "id_add": "0",
  "id_edit": "0",
  "id_delete": "0",
  "civilite": "Mme",
  "nom": "Duru ",
  "prenom": "Françoise ",
  "email": "",
  "commentaires": "",
  "portable": "",
  "fonction": "Assistante RH",
  "statut_bpf": "salarie",
  "date_de_naissance": "0000-00-00",
  "departement_naissance": "",
  "adresse": "",
  "code_postal": "",
  "ville": "",
  "pays": "",
  "id_entreprise": "4",
  "particulier": "0",
  "id_externe": "",
  "id_centre_de_formation": "0",
  "id_contact": "",
  "responsable_type": "",
  "responsable_id": ""
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/participants.php?id=17

Il est possible de récupérer l'url de la photo de profil du participant dans la réponse, en rajoutant include=photo à votre requête.

Exemple : GET https://pro.dendreo.com/demo/api/participants.php?id=5&include=photo

Il est aussi possible de requêter directement les informations de l'entreprise, du contact principal de l'entreprise, et du contact secondaire de l'entreprise du ou des participants via l'attribut include.

Exemple : GET https://pro.dendreo.com/demo/api/participants.php?id=12,14,28&include=entreprise,entreprise_contact,entreprise_contact_secondaire

Ajouter un participant

{
  "id_participant": "17",
  "id_add": "0",
  "id_edit": "0",
  "id_delete": "0",
  "civilite": "Mme",
  "nom": "Duru ",
  "prenom": "Françoise ",
  "email": "",
  "commentaires": "",
  "portable": "",
  "fonction": "Assistante RH",
  "statut_bpf": "salarie",
  "date_de_naissance": "0000-00-00",
  "departement_naissance": "",
  "adresse": "",
  "code_postal": "",
  "ville": "",
  "pays": "",
  "id_entreprise": "4",
  "particulier": "0",
  "id_externe": "",
  "id_centre_de_formation": "0",
  "id_contact": "",
  "responsable_type": "",
  "responsable_id": ""
}

Attention, si votre Participant est un Particulier (personne en recherche d'emploi, indépendant, CPF Auotonme), vous ne devriez pas utiliser cet endpoint, mais plutôt l'endpoint Particuliers. En savoir plus.

Rattacher le participant à une entreprise

Il existe trois façons de rattacher un participant à une entreprise qui sont évaluées dans l'ordre de préférence suivant :

Paramètres

Intitulé Obligatoire Description
id_entreprise non ID Entreprise (existence vérifiée)
nom oui Nom
prenom oui prénom
civilite non Civilité (format vérifié)
fonction non Fonction
commentaires non Commentaires
portable non Portable
email non Email
date_de_naissance non Date de naissance (format “AAAA-MM-JJ” ou “JJ/MM/AAAA”)
id_externe non ID Externe (synchro)
entreprise_raison_sociale non Liaison avec l'entreprise via la raison sociale
entreprise_id_externe non Liaison avec l'entreprise via son id externe
statut_bpf non salarie,agent_public,non_salarie,benevole,autre
id_centre_de_formation non ID Centre de formation (existence vérifiée)
id_contact non Liaison avec une fiche contact (même personne, existence vérifiée)
responsable_id non Liaison avec un participant ou un contact en tant que responsable hierarchique (existence vérifiée)
responsable_type non Type du responsable hierarchique : participant ou contact

Requête HTTP

POST https://pro.dendreo.com/demo/api/participants.php

Etapes

Lister toutes les étapes

[
  {
    "id_etape_process": "2",
    "intitule": "Réalisation",
    "id_parent": "0",
    "status": "1",
    "ordre": "2",
    "name": "real",
    "cible": "intra"
  }
]

Accède à toutes les étapes présentes sur Dendreo.

Requête HTTP

GET https://pro.dendreo.com/demo/api/etapes.php

Afficher une étape

{
  "id_etape_process": "2",
  "intitule": "Réalisation",
  "id_parent": "0",
  "status": "1",
  "ordre": "2",
  "name": "real",
  "cible": "intra"
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/etapes.php?id=2

Centres de formation

Lister tous les centres de formation

[
  {
    "id_centre_de_formation": "1",
    "raison_sociale": "Centre principal"
  }
]

Accède à tous les centres de formation présents sur Dendreo.

Requête HTTP

GET https://pro.dendreo.com/demo/api/centres_de_formation.php

Afficher un centre de formation

{
  "id_centre_de_formation": "1",
  "raison_sociale": "Centre principal"
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/centres_de_formation.php?id=1

Salles de formation

Lister toutes les salles de formation

[
  {
    "id_salle_de_formation": "3",
    "intitule": "Salle Einstein",
    "color": "",
    "status": "1",
    "capacite_max": "20",
    "adresse": "",
    "code_postal": "",
    "ville": "",
    "pays": "",
    "id_centre_de_formation": "0",
    "lien_google_maps": "https://www.google.fr/maps",
    "acces": "Porte extérieure : appuyer sur P",
    "inside": "1",
    "telephone": "01 23 45 67 89",
    "email": "",
    "accueil": "",
    "nom_contact": "",
    "commentaires_internes": "",
    "no_conflits": "0",
    "elearning": "0",
    "url_connexion": "",
    "emplacement_type": "CentresDeFormation",
    "emplacement_id": "1"
  }
]

Accède à toutes les salles de formation présentes sur Dendreo.

L'emplacement de la salle peut être CentresDeFormation ou Entreprise. Dans les 2 cas, le champ inside peut être à 1 ou 0. Dans le cas où c'est une salle elearning, le champ elearning sera à 1, et le champ inside à 0.

Requête HTTP

GET https://pro.dendreo.com/demo/api/salles_de_formation.php

Afficher une salle de formation

{
  "id_salle_de_formation": "4",
  "intitule": "Salle Amandre",
  "color": "",
  "status": "1",
  "capacite_max": "42",
  "adresse": "",
  "code_postal": "",
  "ville": "",
  "pays": "",
  "id_centre_de_formation": "0",
  "lien_google_maps": "",
  "acces": "",
  "inside": "1",
  "telephone": "",
  "email": "",
  "accueil": "",
  "nom_contact": "",
  "commentaires_internes": "",
  "no_conflits": "0",
  "elearning": "0",
  "url_connexion": "",
  "emplacement_type": "CentresDeFormation",
  "emplacement_id": "1"
}

L'emplacement de la salle peut être CentresDeFormation ou Entreprise. Dans les 2 cas, le champ inside peut être à 1 ou 0. Dans le cas où c'est une salle elearning, le champ elearning sera à 1, et le champ inside à 0.

Requête HTTP

GET https://pro.dendreo.com/demo/api/salles_de_formation.php?id=4

Ajouter une salle de formation

{
  "id_salle_de_formation": "4",
  "intitule": "Salle Amandre",
  "color": "",
  "status": "1",
  "capacite_max": "42",
  "adresse": "",
  "code_postal": "",
  "ville": "",
  "pays": "",
  "id_centre_de_formation": "0",
  "lien_google_maps": "",
  "acces": "",
  "inside": "1",
  "telephone": "",
  "email": "",
  "accueil": "",
  "nom_contact": "",
  "commentaires_internes": "",
  "no_conflits": "0",
  "elearning": "0",
  "url_connexion": "",
  "emplacement_type": "CentresDeFormation",
  "emplacement_id": "1"
}

Paramètres

Intitulé Obligatoire Description
intitule oui Nom de la salle
emplacement_cible oui Emplacement de la salle (‘cdf_outside’, ‘elearning’, ‘client’, ‘client_outside’ ou un id_centre_de_formation valide)
id_entreprise oui si emplacement_cible = client ou client_outside Entreprise lié à cette salle (existance vérifiée)
color non Couleur de la salle
id_centre_de_formation non Visiblité de la salle
capacite_max non Capaxité maximum de la salle
commentaires_internes non Commentaires internes de la salle
no_conflits non Détecter ou non les conflit de la salle (0 ou 1)

En emplacement_cible client_outside ou cdf_outside uniquement

Intitulé Obligatoire Description
nom_contact non Nom du contact
adresse non Adresse de la salle
code_postal non Code postal de la salle
ville non Ville de la salle
pays non Pays de la salle
telephone non Téléphone de la salle
email non Email de la salle (structure vérifiée)
lien_google_maps non Lien Google Maps
acces non Informations pratiques d'accès de la salle
accueil non Informations d'accueil de la salle

En emplacement_cible elearning uniquement

Intitulé Obligatoire Description
url_connexion non Url de connexion de la salle

Actions de Formation

Lister toutes les Actions de Formation

[
  {
    "id_action_de_formation": "37",
    "id_centre_de_formation": "0",
    "id_salle_de_formation": "0",
    "numero": "1",
    "numero_complet": "",
    "numero_comptable": "",
    "type": "intra",
    "intitule": "Intitulé",
    "description": "Description",
    "id_entreprise": "4",
    "id_contact": "4",
    "id_etape_process": "10",
    "date_debut": "2016-01-20 09:00:00",
    "date_fin": "2016-01-21 16:00:00",
    "date_etape_realisation": "2016-01-23 16:21:44",
    "date_etape_archivage": "2016-02-06 14:17:06",
    "date_etape_echec": "0000-00-00 00:00:00",
    "lieu": "",
    "nb_participants_min": "0",
    "nb_participants_max": "12",
    "objectif": "autre",
    "nature": "2",
    "inscription_online": "1",
    "include_in_bpf": "1",
    "total_heures_participants": "14",
    "total_participants": "10"
  }
]

Accède à toutes les actions de formation présentes sur Dendreo.

Il est possible d'afficher des données supplémentaires pour les actions de formations en renseignant le paramètre include.

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?include=stats,modules,participants,formateurs,creneaux,visuel

Il est possible de filtrer les actions de formation via les paramètres suivant :

nb_jours : les actions ajoutées et/ou modifiées sur les N derniers jours

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?nb_jours=3

id_entreprise : les actions INTRA liées à l'entreprise sélectionnée

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?type=intra&id_entreprise=38

id_module : les actions qui contiennent le module sélectionné

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?id_module=657

date_fin : les actions de formation dont la date de fin est supérieure à la date passée en paramètre

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?date_fin=2018-09-12

numero_complet : les actions de formation comportant se numero complet

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?numero_complet=ADF_2019001

Attention, par défaut, seules les actions de formation de la dernière année sont retournées !

Requête HTTP

GET https://pro.dendreo.com/demo/api/actions_de_formation.php

Listing pour Catalogue public

Si vous souhaitez afficher un petit widget sur votre site web qui indique par exemple “Nos 3 prochaines sessions de formation”, vous pouvez utiliser cet endpoint spécial qui a pour effet de vous retourner une liste pré-compilées de prochaines Actions de Formation.

Il ne s'agit pas exactement de l'objet Action de Formation, le retour est un mélange d'informations simples du Module, et de l'Action de Formation, ainsi que certaines infos concernant le prix, le remplissage et le lieux de la session.

Cet endpoint a l'avantage de filtrer automatiquement les Modules et Actions de Formation pour ne prendre en compte uniquement :

Le résultat est donc identique à ce que notre option Catalogue en ligne affiche si vous l'utilisez.

[
    {
        "intitule": "Intitule",
        "date_debut": "2019-07-31 08:00:00",
        "date_fin": "2019-07-31 17:00:00",
        "categorie": "Catégorie",
        "slug_categorie": "https://pro.dendreo.com/demo/public/catalogue/categorie/1/categorie",
        "remplissage": "2/5",
        "total_participants": "2",
        "nb_participants_max": "5",
        "prix_formation": "100",
        "prix_module": "300",
        "slug": "https://pro.dendreo.com/demo/public/catalogue/formation/117/intitule/75",
        "lieux": [
            {
                "intitule": "Salle 1",
                "adresse": "4 rue du Test",
                "ville": "Paris",
                "code_postal": "75008",
                "pays": "France",
                "lien_google_maps": "",
                "acces": "",
                "telephone": "01 02 03 04 05",
                "email": "",
                "accueil": "",
                "nom_contact": ""
            }
        ]
    }
]

Requête HTTP

Notez que l'endpoint n'est pas actions_de_formation !

GET https://pro.dendreo.com/demo/api/catalogue_prochaines_sessions.php

Paramètres

Intitulé Obligatoire Description
limit non Nombre d'Actions de Formation renvoyées (défaut: 10)
id_centre_de_formation non Id du centre de formation à afficher

Afficher une Action de Formation

{
  "id_action_de_formation": "37",
  "id_centre_de_formation": "0",
  "id_salle_de_formation": "0",
  "numero": "1",
  "numero_complet": "",
  "numero_comptable": "",
  "type": "intra",
  "intitule": "Intitulé",
  "description": "Description",
  "id_entreprise": "4",
  "id_contact": "4",
  "id_etape_process": "10",
  "date_debut": "2016-01-20 09:00:00",
  "date_fin": "2016-01-21 16:00:00",
  "date_etape_realisation": "2016-01-23 16:21:44",
  "date_etape_archivage": "2016-02-06 14:17:06",
  "date_etape_echec": "0000-00-00 00:00:00",
  "lieu": "",
  "nb_participants_min": "0",
  "nb_participants_max": "12",
  "objectif": "autre",
  "nature": "2",
  "inscription_online": "1",
  "include_in_bpf": "1",
  "total_heures_participants": "14",
  "total_participants": "10",
  "nb_participants_inscrits": "6",
  "nb_participants_non_inscrits": "2",
  "nb_participants_en_attente": "1"
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/actions_de_formation.php?id=37

Il est possible de récupérer l'url du visuel associé à l'action de formation dans la réponse, en rajoutant include=visuel à votre requête.

Exemple : GET https://pro.dendreo.com/demo/api/actions_de_formation.php?id=37&include=visuel

Ajouter / Editer une Action de Formation

Les validations effectuées sont dépendantes du type fourni.

{
  "id_action_de_formation": "37",
  "id_centre_de_formation": "0",
  "id_salle_de_formation": "0",
  "numero": "1",
  "numero_complet": "",
  "numero_comptable": "",
  "type": "intra",
  "intitule": "Intitulé",
  "description": "Description",
  "id_entreprise": "4",
  "id_contact": "4",
  "id_etape_process": "10",
  "date_debut": "2016-01-20 09:00:00",
  "date_fin": "2016-01-21 16:00:00",
  "date_etape_realisation": "2016-01-23 16:21:44",
  "date_etape_archivage": "2016-02-06 14:17:06",
  "date_etape_echec": "0000-00-00 00:00:00",
  "lieu": "",
  "nb_participants_min": "0",
  "nb_participants_max": "12",
  "objectif": "autre",
  "nature": "2",
  "inscription_online": "1",
  "include_in_bpf": "1",
  "total_heures_participants": "14",
  "total_participants": "10",
  "nb_participants_inscrits": "6",
  "nb_participants_non_inscrits": "2",
  "nb_participants_en_attente": "1"
}

Paramètres

Intitulé Obligatoire Description
id non ID de l'Action de Formation (si vide -> ajout d'une nouvelle action de formation, sinon -> edition)
intitule oui Intitulé
intitule_court non Si non vide remplace l'Intitulé dans l'Agenda
type oui Type (inter ou intra, non disponible en edition)
include_in_bpf oui Booléen. Inclure dans le BPF, par défaut “1”
date_debut oui Date de début (format vérifié : “AAAA-MM-JJ”, non disponible en edition)
date_fin oui Date de fin (format vérifié : “AAAA-MM-JJ”, non disponible en edition)
id_salle_de_formation non ID Salle de formation (existence vérifiée)
id_centre_de_formation non ID Centre de formation (existence vérifiée, non disponible en edition)
id_entreprise oui si (type = ‘intra’) ID Entreprise (existence vérifiée, paramètre interdit si type = ‘inter’)
id_contact non ID Contact (existence vérifiée, paramètre interdit si type = ‘inter’)
id_etape_process non ID Etape (existence vérifiée)
numero non Numéro
numero_complet non numero_complet
nb_participants_min non Nombre minimum de participants
nb_participants_max non Nombre maximum de participants
id_responsable non Responsable Dendreo
id_commercial non Commercial rattaché à action de formation
mode_pricing non En ajout et en INTRA seulement. Valeurs : par_jour ou global
commentaires non Commentaires Internes
commentaires_agenda non Commentaires visibles sur l'agenda (disponible pour les Formateurs)

Requête HTTP

POST https://pro.dendreo.com/demo/api/actions_de_formation.php

Créneaux

Afficher les créneaux

Vous pouvez sélectionner les créneaux d'une seule Action de formation via l'attribut id_action_de_formation. De même vous pouvez sélectionner tous les créneaux d'un Lam (Lien Action de formation - Module) via l'attribut id_lam et tous les créneaux d'un Module (quelque soit l'Action de formation) via l'attribut id_module.

Exemple : GET https://pro.dendreo.com/demo/api/creneaux.php?id_action_de_formation=12

Vous pouvez également inclure la liste des formateurs effectuant ces créneaux en ajoutant le paramètre include=formateurs

Exemple : GET https://pro.dendreo.com/demo/api/creneaux.php?id_action_de_formation=12&include=formateurs

[
    {
        "id_creneau": "864",
        "id_add": "5",
        "id_edit": "0",
        "id_action_de_formation": "617",
        "id_lam": "619",
        "date_debut": "2017-01-10 10:00:00",
        "date_fin": "2017-01-10 11:00:00",
        "name": "",
        "icon": ""
    },
    {
        "id_creneau": "1544",
        "id_add": "5",
        "id_edit": "0",
        "id_action_de_formation": "1297",
        "id_lam": "1299",
        "date_debut": "2017-01-11 10:00:00",
        "date_fin": "2017-01-11 12:00:00",
        "name": "",
        "icon": ""
    }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/creneaux.php

Afficher un créneau

{
    "id_creneau": "950",
    "id_add": "5",
    "id_edit": "0",
    "id_action_de_formation": "617",
    "id_lam": "619",
    "date_debut": "2017-01-11 10:00:00",
    "date_fin": "2017-01-11 12:00:00",
    "name": "Théorie",
    "icon": "star",
    "id_salle_de_formation": "",
    "lcps": [
        {
            "id_lcp": "93",
            "id_add": "0",
            "id_edit": "0",
            "id_creneau": "950",
            "id_lmp": "28",
            "id_lap": "25",
            "presence": "1",
            "justified": "0",
            "justification": "",
            "lap": {
                "id_lap": "25",
                "id_participant": "2",
                "id_entreprise": "1",
                "participant": {
                    "id_participant": "2",
                    "nom": "Duru",
                    "prenom": "Françoise",
                    "email": "",
                    "id_entreprise": "2",
                    "particulier": "0"
                }
            }
        }
    ]
}

Vous pouvez inclure :

Un lcp est le lien entre un creneau et un lap, puis le lap, fait le lien avec le participant à proprement parlé. Dans le lcp vous avez accès aux variables concernant les présences

Exemple : GET https://pro.dendreo.com/demo/api/creneaux.php?id=950&include=lcps

Requête HTTP

GET https://pro.dendreo.com/demo/api/creneaux.php?id=950

Inscription d'un participant

Afficher les inscriptions d'une action de formation

Attention, la sélection d'une action de formation, via id_action_de_formation, id_participant ou id_entreprise est obligatoire.

Il est possible d'ajouter à la réponse les informations du participant via le paramètre include=participant.

Exemple : https://pro.dendreo.com/demo/api/laps.php?id_entreprise=371&include=participant

Il est également possible d'enrichir les informations de l'inscription d'un participant via le paramètre include=lmps.

Exemple : https://pro.dendreo.com/demo/api/laps.php?id_entreprise=371&include=lmps

Vous pouvez aussi utiliser les 2 paramètres conjointement :

Exemple : https://pro.dendreo.com/demo/api/laps.php?id_entreprise=371&include=lmps,participant

[
  {
    "id_lap": "950",
    "id_action_de_formation": "330",
    "id_entreprise": "170",
    "id_participant": "0",
    "satisfaction_status": "0",
    "status": "1",
    "source": "dendreo",
    "inscription_lmp": "1",
    "lmps": [
      {
        "id_lam": "799",
        "status": "1",
        "prix": "670.00",
        "prix_personnalise": "1",
        "total_heures_presence": "0.00"
      }
    ],
    "participant" : {
        "id_participant": "17",
        "id_add": "0",
        "id_edit": "0",
        "id_delete": "0",
        "civilite": "Mme",
        "nom": "Duru ",
        "prenom": "Françoise "
        ...
      }
  }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/laps.php?id_action_de_formation=330

Afficher une inscription

{
  "id_lap": "950",
  "id_action_de_formation": "330",
  "id_entreprise": "170",
  "id_participant": "0",
  "satisfaction_status": "0",
  "status": "1",
  "source": "dendreo",
  "inscription_lmp": "1"
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/laps.php?id=950

Ajouter une inscription

Il est par ailleurs possible d'ajouter un participant “Inconnu” (à renseigner ultérieurement dans Dendreo) en ne renseignant pas l’id_participant (En inter, un id_entreprise est requis).

{
  "id_lap": "950",
  "id_action_de_formation": "330",
  "id_entreprise": "170",
  "id_participant": "0",
  "satisfaction_status": "0",
  "status": "1",
  "source": "dendreo",
  "inscription_lmp": "1"
}

Paramètres

Intitulé Obligatoire Description
id_action_de_formation oui ID action de formation (existence vérifiée)
id_participant non ID participant (existence vérifiée, entreprise vérifiée)
id_entreprise non, sauf si id_participant non fourni en inter ID entreprise (existence vérifiée)
prix non Prix personnalisé par participant (Valable uniquement dans le cas où l'action de formation ne contient qu'un seul module)

Requête HTTP

POST https://pro.dendreo.com/demo/api/laps.php

Programmation d'un module

Afficher les programmations d'une action de formation

Sélectionnez l'Action de Formation via id_action_de_formation.

Exemple : GET https://pro.dendreo.com/demo/api/lams.php?id_action_de_formation=26

[
    {
        "id_lam": "474",
        "id_add": "16",
        "id_edit": "16",
        "id_action_de_formation": "472",
        "id_module": "66",
        "date_debut": "2017-10-02 09:30:00",
        "date_fin": "2017-12-13 17:00:00",
        "prix": "450",
        "prix_achat": "0",
        "quantite": "0",
        "formateurs": [
        {
            "id_laf": "62",
            "id_lmf": "44",
            "id_formateur": "74",
            "civilite": "M.",
            "nom": "DUPONT",
            "prenom": "Jean"
        }
        ]

    }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/lams.php

Afficher une programmation

Exemple : GET https://pro.dendreo.com/demo/api/lams.php?id=474

Il est possible d'afficher les données du module du LAM, ou ses créneaux en renseignant le paramètre include.

Exemple : GET https://pro.dendreo.com/demo/api/lams.php?id=474&include=module,creneaux

[
    {
        "id_lam": "474",
        "id_add": "16",
        "id_edit": "16",
        "id_action_de_formation": "472",
        "id_module": "66",
        "date_debut": "2017-10-02 09:30:00",
        "date_fin": "2017-12-13 17:00:00",
        "prix": "450",
        "prix_achat": "0",
        "quantite": "0",
        "formateurs": [
        {
            "id_laf": "62",
            "id_lmf": "44",
            "id_formateur": "74",
            "civilite": "M.",
            "nom": "DUPONT",
            "prenom": "Jean"
        }
        ]
    } 
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/lams.php?id=474

Ajouter une programmation

{
  "id_lam": "197",
  "id_action_de_formation": "330",
  "id_module": "17",
  "quantite": "0",
  "prix": "0.00",
  "prix_achat": "0.00",
  "id_shadow_lam": "0"
}

Option “Multi-Produits”

Par défaut, l'option “Multi-Produits” n'est pas activée sur Dendreo, tous les modules correspondent donc à de la formation.

Si l'option Multi-Produits est activée, et que vous souhaitez programmer un module qui n'est pas de la formation mais qui a l'option hors_formation_dates activée (produit ayant des dates), il faudra renseigner les paramètres date_debut et date_fin. Ces deux paramètres sont optionnels si le produit est réglé sur hors_formation_dates à 0.

Par ailleurs, si un produit a des dates ET si l'option hors_formation_prix_par_jour est désactivée (produit non configuré en tarification par jour), vous pouvez utiliser l'attribut quantite. Si hors_formation_prix_par_jour est réglé à 1 sur le produit, la quantité est automatiquement égale à la durée du produit en jours.

Paramètres

Intitulé Obligatoire Description
id_action_de_formation oui ID action de formation (existence vérifiée)
id_module oui ID module (existence vérifiée)
date_debut oui* Date de début (format vérifié : “AAAA-MM-JJ”) *Sauf en Multi-Produits, si l'option hors_formation_dates est désactivée sur le produit concerné
date_fin non* Date de fin (format vérifié : “AAAA-MM-JJ”). *Sauf en Multi-Produits, si l'option hors_formation_dates est activée sur le produit concerné
id_formateur non ID du formateur à staffer (si non fourni, le formateur par défaut du Module -si il est défini- sera staffé)
prix non Prix
prix_achat non Prix d'achat
quantite non* Quantité *Sauf si l'option hors_formation_prix_par_jour (tarification à la journée) est désactivée sur le module concerné
id_salle_de_formation non ID de la salle. Si vide, la salle programmée pour l'ADF sera utilisée, le cas échéant, ou alors la salle par défaut du module.

Requête HTTP

POST https://pro.dendreo.com/demo/api/lams.php

Financeurs (externes)

Lister tous les financeurs

[
  {
      "id_opca": "2",
      "opca": "1",
      "raison_sociale": "AGEFOS-PME PACA",
      "description": "FAF des petites et moyennes entreprises",
      "cible": "",
      "site_internet": "http://www.agefos-pme.org",
      "adresse": "146 RUE PARADIS\r\nCS 30002",
      "code_postal": "13294",
      "ville": "MARSEILLE CEDEX 06",
      "telephone": "0488445160",
      "pays": "France"
  }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/financeurs.php

Afficher un financeur

[
  {
      "id_opca": "2",
      "opca": "1",
      "raison_sociale": "AGEFOS-PME PACA",
      "description": "FAF des petites et moyennes entreprises",
      "cible": "",
      "site_internet": "http://www.agefos-pme.org",
      "adresse": "146 RUE PARADIS\r\nCS 30002",
      "code_postal": "13294",
      "ville": "MARSEILLE CEDEX 06",
      "telephone": "0488445160",
      "pays": "France"
  }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/financeurs.php?id=1

Financements

Lister toutes les Financements

Accède à tous les financements présents sur Dendreo.

Il est possible d'afficher des données supplémentaires pour les Financements en renseignant le paramètre include.

En ajoutant entreprise (Entreprise bénéficiaire du Financement = lié à id_finance), financeur (Financeur du Financement = lié à id_financeur), factures (toutes les Factures liées à ce Financement), lfps (LFP = Lien Financement Participant), vous pouvez obtenir directement des informations supplémentaires sur les Financements.

La paramètre lfps vous donnera à la fois les LFPs, les LAPs liés à ces LFPs, et les Participants liés à ces LAPs.

Exemple : GET https://pro.dendreo.com/demo/api/financements.php?include=entreprise,financeur,factures,lfps

[
  {
    "id_financement": "790",
    "id_add": "0",
    "id_edit": "0",
    "id_delete": "0",
    "id_action_de_formation": "39",
    "type": "opca",
    "categorie": "",
    "id_finance": "522",
    "id_financeur": "1",
    "montant_finance": "2000",
    "id_categorie_produit": "1",
    "montant_finance_hors_formation": "0",
    "montant_refacture": "0",
    "numero_dossier": "",
    "montant_total_finance": "2000",
    "montant_total_facture": "2000",
    "montant_total_paye": "0"
  }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/financements.php

Paramètres

Intitulé Obligatoire Description
id_action_de_formation non Filtrer sur les Financements d'une Action de Formation
id_facture non Filtrer sur les Financements liés à une Facture
id_lap non Filtrer sur les Financements liés à un LAP
id_participant non Filtrer sur les les Financements liés à un Participant
id_entreprise non Filtrer sur les Financements financés pour cette Entreprise
id_financeur non Filtrer sur les Financements à destination de ce Financeur (si type est également fourni
type non, oui si id_financeur Un type est obligatoire pour rechercher par Financeur : entreprise (Entreprise, Particulier, Sous-traitance, Financeur public client) ou financeur_externe (OPCA ou Financeur public externe)

Afficher un Financement

  {
    "id_financement": "790",
    "id_add": "0",
    "id_edit": "0",
    "id_delete": "0",
    "id_action_de_formation": "39",
    "type": "opca",
    "categorie": "",
    "id_finance": "522",
    "id_financeur": "1",
    "montant_finance": "2000",
    "id_categorie_produit": "1",
    "montant_finance_hors_formation": "0",
    "montant_refacture": "0",
    "numero_dossier": "",
    "montant_total_finance": "2000",
    "montant_total_facture": "2000",
    "montant_total_paye": "0"
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/financements.php?id=790

Factures

Lister toutes les Factures émises

Accède à toutes les Factures présentes sur Dendreo.

Il est possible d'afficher des données supplémentaires pour les Factures en renseignant le paramètre include.

En ajoutant financements vous pouvez obtenir tous les financements associés à cette facture, et si vous avez ajouté ce paramètre vous pouvez aussi ajouter les paramètres entreprise (Entreprise bénéficiaire du Financement = lié à id_finance), financeur (Financeur du Financement = lié à id_financeur), factures (toutes les Factures liées à ce Financement), lfps (LFP = Lien Financement Participant) pour obtenir des informations additionnels sur ces Financements.

Exemple : GET https://pro.dendreo.com/demo/api/factures.php?include=financements,entreprise,financeur,factures,lfps

Il est possible de filtrer les factures via le paramètre suivant :

numero_complet : Le numéro complet de la facture

Exemple : GET https://pro.dendreo.com/demo/api/factures.php?numero_complet=FA_2019001

[
  {
    "id_facture": "19",
    "date_emission": "2016-10-09 10:42:59",
    "date_paiement": "0000-00-00 00:00:00",
    "moyen_paiement": "",
    "numero": "1",
    "numero_complet": "",
    "id_entreprise": "876",
    "id_opca": "0",
    "id_participant": "0",
    "montant_total_ht": "870.00",
    "montant_total_ttc": "744",
    "raison_sociale": "EDF",
    "adresse": "28 rue Bigleuil",
    "code_postal": "75006",
    "ville": "Paris",
    "pays": "FRANCE",
    "remarque": "",
    "id_avoir": "0",
    "id_centre_de_formation": "0",
    "public_url": "https://public.dendreo.com/xxxxx/facture/..."
  }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/factures.php

Paramètres

Intitulé Obligatoire Description
date_emission non Filtrer sur la date d'émission (format vérifié : “AAAA-MM-JJ”)
date_paiement non Filtrer sur la date de paiement (format vérifié : “AAAA-MM-JJ”)
id_entreprise non Filtrer sur les factures à destination de cette entreprise
id_opca non Filtrer sur les factures à destination de ce Financeur (opca ou financeur public)

Afficher une Facture

[
  {
    "id_facture": "19",
    "date_emission": "2016-10-09 10:42:59",
    "date_paiement": "0000-00-00 00:00:00",
    "moyen_paiement": "",
    "numero": "1",
    "numero_complet": "",
    "id_entreprise": "876",
    "id_opca": "0",
    "id_participant": "0",
    "montant_total_ht": "870.00",
    "montant_total_ttc": "744",
    "raison_sociale": "EDF",
    "adresse": "28 rue Bigleuil",
    "code_postal": "75006",
    "ville": "Paris",
    "pays": "FRANCE",
    "remarque": "",
    "id_avoir": "0",
    "id_centre_de_formation": "0",
    "public_url": "https://public.dendreo.com/demo/facture/..."
  }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/factures.php?id=19

Pour télécharger la facture, utilisez le lien contenu dans la propriété ‘public_url’.

Vous pouvez ajouter les paramètres suivants à cette URL :

Exemple : GET https://public.dendreo.com/demo/facture/82wr61vkha?pdf=1&inline=1

Modifier les informations de paiement d'une facture

[
  {
    "id_facture": "19",
    "date_emission": "2019-05-09 10:42:59",
    "date_paiement": "2019-06-09 00:00:00",
    "moyen_paiement": "",
    "numero": "1",
    "numero_complet": "",
    "id_entreprise": "876",
    "id_opca": "0",
    "id_participant": "0",
    "montant_total_ht": "870.00",
    "montant_total_ttc": "744",
    "raison_sociale": "EDF",
    "adresse": "28 rue Bigleuil",
    "code_postal": "75006",
    "ville": "Paris",
    "pays": "FRANCE",
    "remarque": "",
    "id_avoir": "0",
    "id_centre_de_formation": "0",
    "public_url": "https://public.dendreo.com/demo/facture/..."
  }
]

Requête HTTP

Seules les informations concernant le paiement d'une facture est modifiable via l'api.

POST https://pro.dendreo.com/demo/api/factures.php

Paramètres

Intitulé Obligatoire Description
id_facture oui ID Facture (existence vérifiée)
date_paiement non Date de paiement format (format vérifié : “AAAA-MM-JJ”)
moyen_paiement non Moyen de paiement (“”, “virement”, “cheque”, “prelevement”, “cb”, “paypal”, “especes”)
reference_paiement non La référence du paiement.

Mails

Logs des mails envoyé par Dendreo

[
    {
        "id_mail": "1",
        "cible": "",
        "id_entite": "0",
        "id_action_de_formation": "0",
        "id_mail_type": "0",
        "id_add": "0",
        "date_add": "0000-00-00 00:00:00",
        "from_email": "nom@domaine.fr",
        "domain": "dendreo.com",
        "title": "Intitule",
        "http_response_code": "200",
        "http_error_msg": "",
        "destinataires": [
            {
                "id": "1",
                "id_mail": "1",
                "email": "nom@domaine.fr",
                "type_destinataire": "to",
                "event": "",
                "code": "0",
                "error": "",
                "notification": "",
                "reason": "",
                "description": ""
            },
            {
                "id": "2",
                "id_mail": "1",
                "email": "nom@domaine.fr",
                "type_destinataire": "cc",
                "event": "",
                "code": "0",
                "error": "",
                "notification": "",
                "reason": "",
                "description": ""
            }
        ]
    },
]

Affiche la liste des emails envoyés par Dendreo

Exemple : GET https://pro.dendreo.com/demo/api/emails.php?key=123456

Un email contient les données qui lui sont propre, ainsi qu'un tableau de destinataires.

Le champ http_response_code d'un email, définit s'il est bien parvenu à la plateforme d'emailing.

Ses valeurs possibles sont :

Le champs destinataires contient un tableau de destinataires.

Chaque destinataire possède un email, un type de destinataire (‘to’, ‘cc’ ou ‘bcc’), ainsi que des informations de statut.

Les valeurs possibles de event sont :

Un destinataire ayant correctement reçu l'email doit donc associer un http_response_code à 200 et un event à delivered.

En cas d'erreur, les champs http_error_msg, code, error, notification, reason et description peuvent contenir des informations de diagnostique. Le champ le plus utile et explicite est en général reason.

Paramètres

Intitulé Obligatoire Description
key oui Clé api
id_action_de_formation non ID Action de formation (existence vérifiée)
to_email non Destinataire
http_response_code non Code de réponse de l'email
event non delivered, dropped, bounced, complained
offset non Pagination (affiche 100 résultats à partir de cette valeur)

Checklists

Lister les Checklists suivant un type de cible

Pour les checklists de type action_de_formation_inter, action_de_formation_intra, action_de_formation , lap, laf, n'affiche que celles dont l'action de formation n'a pas été supprimée.

[
    {
        "id_checklist": "4",
        "id_add": "0",
        "id_edit": "0",
        "type_cible": "formateur",
        "id_cible": "65",
        "remarque": "Exemple de remarque",
        "checks_total": "2",
        "checks_done": "1",
        "checks": [
            {
                "id_check": "7",
                "id_add": "0",
                "id_edit": "0",
                "intitule": "première étape",
                "done": "0"
            },
            {
                "id_check": "8",
                "id_add": "0",
                "id_edit": "0",
                "intitule": "deuxième étape",
                "done": "1"
            }
        ]
    }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/checklists.php?cible=formateur

Paramètres

Intitulé Obligatoire Description
cible oui Afficher toutes les checklists d'un type de cible (formateur, action_de_formation_inter, action_de_formation_intra, action_de_formation (inter et intra), lap, laf)
id_cible non Filtrer sur une ou plusieurs cibles particulières (id_cible=44,45,47)
include_deleted non Inclut les checklists des actions de formation supprimées.

Afficher une Checklist

[
    {
        "id_checklist": "4",
        "id_add": "0",
        "id_edit": "0",
        "type_cible": "formateur",
        "id_cible": "65",
        "remarque": "Exemple de remarque",
        "checks_total": "2",
        "checks_done": "1",
        "checks": [
            {
                "id_check": "7",
                "id_add": "0",
                "id_edit": "0",
                "intitule": "première étape",
                "done": "0"
            },
            {
                "id_check": "8",
                "id_add": "0",
                "id_edit": "0",
                "intitule": "deuxième étape",
                "done": "1"
            }
        ]
    }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/checklists.php?id=4

Checks

Modifier un check existant

{
    "id_check": "7",
    "id_add": "0",
    "id_edit": "0",
    "id_checklist": "4",
    "intitule": "première étape",
    "done": "1"
}

Requête HTTP

POST https://pro.dendreo.com/demo/api/checks.php

Paramètres

Intitulé Obligatoire Description
id_check oui L'id du check à modifier
intitule non L'intitule du check
done non Le status du check (0,1)

Créer un check pour une checklist existante

{
    "id_check": "8",
    "id_add": "0",
    "id_edit": "0",
    "id_checklist": "4",
    "intitule": "seconde étape",
    "done": "0"
}

Requête HTTP

POST https://pro.dendreo.com/demo/api/checks.php

Paramètres

Intitulé Obligatoire Description
id_checklist oui L'id de la checklist
intitule oui L'intitule du check
done non Le status du check (0,1)

Administrateurs

Lister tous les administrateurs

[
  {
      "id_administrateur": "1",
      "id_add": "0",
      "id_edit": "0",
      "id_delete": "1",
      "nom": "DUPONT",
      "prenom": "Mathieu",
      "email": "dupont@dendreo.com",
      "login": "mdupont",
      "date_derniere_connexion": "2017-06-26 14:33:21",
      "niveau": "40",
      "fonction": "",
      "telephone": "",
      "use_email": "0",
      "use_signature": "0",
      "nom_complet": "Mathieu DUPONT"
  }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/administrateurs.php

Afficher un administrateur

[
  {
      "id_administrateur": "1",
      "id_add": "0",
      "id_edit": "0",
      "id_delete": "1",
      "nom": "DUPONT",
      "prenom": "Mathieu",
      "email": "dupont@dendreo.com",
      "login": "mdupont",
      "date_derniere_connexion": "2017-06-26 14:33:21",
      "niveau": "40",
      "fonction": "",
      "telephone": "",
      "use_email": "0",
      "use_signature": "0",
      "nom_complet": "Mathieu DUPONT"
  }
]

Requête HTTP

GET https://pro.dendreo.com/demo/api/administrateurs.php?id=1

Actions Commerciales

Lister toutes les actions commerciales

[
    {
        "id_action_commerciale": "1",
        "id_add": "2",
        "id_edit": "3",
        "id_contact": "18",
        "date_action": "2018-09-26 00:00:00",
        "id_categorie_ac": "3",
        "compte_rendu": "En attente du bon de commande pour formation ScrumMaster. A relancer si rien sous une huitaine.",
        "date_relance": "2018-10-05 00:00:00",
        "priorite": "1",
        "commercial_id": "3",
        "devis_id": ""
    },
    ...
]

Il est possible de filtrer les actions commerciales via les paramètres suivant :

id_entreprise : les actions commerciales liées à l'entreprise sélectionnée

Exemple : GET https://pro.dendreo.com/demo/api/actions_commerciales.php?id_entreprise=3

id_categorie_ac : les actions commerciales de la catégorie sélectionnée

Exemple : GET https://pro.dendreo.com/demo/api/actions_commerciales.php?id_categorie_ac=1

commercial_id : les actions commerciales rattachée à l'administrateur sélectionné

Exemple : GET https://pro.dendreo.com/demo/api/actions_commerciales.php?commercial_id=19

relance : les actions commerciales qui ont une relance à venir (Dans ce cas, les actions commerciales seront triées par date de relance les plus anciennes)

Exemple : GET https://pro.dendreo.com/demo/api/actions_commerciales.php?relance=1

Attention, les actions commerciales sont triées par date la plus récente, et retournées par série de 100. Vous devez utiliser le paramètre ‘offset’ pour récupérer les précédentes actions commerciales

Exemple : GET https://pro.dendreo.com/demo/api/actions_commerciales.php?offset=500

Requête HTTP

GET https://pro.dendreo.com/demo/api/actions_commerciales.php

Afficher une action commerciale

{
    "id_action_commerciale": "1",
    "id_add": "2",
    "id_edit": "3",
    "id_contact": "18",
    "date_action": "2018-09-26 00:00:00",
    "id_categorie_ac": "3",
    "compte_rendu": "En attente du bon de commande pour formation ScrumMaster. A relancer si rien sous une huitaine.",
    "date_relance": "2018-10-05 00:00:00",
    "priorite": "1",
    "commercial_id": "3",
    "devis_id": ""
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/actions_commerciales.php?id=1

Ajouter / Editer une action commerciale

{
    "id_action_commerciale": "40",
    "id_add": "1",
    "date_action": "2018-09-26 14:14:42",
    "id_categorie_ac": "2",
    "id_contact": "25",
    "priorite": "3",
    "commercial_id": "21",
    "compte_rendu": "En attente du bon de commande pour formation ScrumMaster. A relancer si rien sous une huitaine.",
    "date_relance": "2018-10-20",
}

Paramètres

Intitulé Obligatoire Description
id non ID de l'action commercial (si vide -> ajout d'une nouvelle action commerciale, sinon -> edition)
id_entreprise non ID de l'entreprise rattachée à cette action commerciale (possibilité de passer ‘entreprise_raison_sociale’ au lieu de ‘id_entreprise’)
id_contact non ID du contact rattaché à cette action commerciale (possibilité de passer ‘contact_prenom_nom’ au lieu de ‘id_contact’)
id_participant non ID du participant rattaché à cette action commerciale (possibilité de passer ‘participant_prenom_nom’ au lieu de ‘id_participant’)
commercial_id oui ID de l'administrateur auteur de cette action commerciale
date_action non Date au format AAAA-MM-JJ (Si vide prendra la date du jour)
date_relance non Date au format AAAA-MM-JJ
id_categorie_ac non ID de catégorie (Si vide en mode ajout, prendra la valeur de la configuration par défaut)
priorite non Priorité de l'action commerciale (0,1,2)

Une action commerciale DOIT être rattachée à un interlocuteur : entreprise, contact, ou participant. Pour ajouter une action commerciale à un particulier, vous devez envoyer l'id_entreprise de celui-ci.

Requête HTTP

POST https://pro.dendreo.com/demo/api/actions_commerciales.php

Convertir vers Particulier

Exemple de réponse

{
  "status":"success"
}

Vous pouvez convertir un Participant en Particulier si :

Vous pouvez convertir une Entreprise en Particulier si :

Requête HTTP

POST https://pro.dendreo.com/demo/api/convert_particulier.php

Paramètres

Intitulé Obligatoire Description
id_entreprise oui (sauf si id_participant fourni) ID Entreprise (existence vérifiée)
id_participant oui (sauf si id_entreprise fourni) ID Participant (existence vérifiée)

Fichiers

Afficher un fichier

{
    "id": "1",
    "collection_name": "avatar",
    "name": "sample",
    "mime_type": "image/jpeg",
    "size": "20461",
    "created_at": "2018-10-26 12:44:49",
    "updated_at": "2018-10-26 12:44:49",
    "deleted_at": "",
    "id_add": "1",
    "id_edit": "0",
    "public_url": "",
    "cible": "formateur",
    "id_cible": "59",
    "entite_liee": {
        "Entreprise": {
            "id_entreprise": "482",
            "id_add": "2",
            "id_edit": "0",
            "numero": "8",
            "numero_complet": "ENT_2018001",
            "...":
        }
    }
}

Requête HTTP

GET https://pro.dendreo.com/demo/api/fichiers.php?id=1

Rechercher un fichier

Il est possible de rechercher les fichiers d'une ‘collection’, au sein d'une ‘cible’.

Si le paramètre ‘collection_name’ est omis, les fichiers de l'espace de stockage seront retournés par défaut (Se reporter au tableau de correspondance cible/collection plus bas).

Exemple : GET https://pro.dendreo.com/demo/api/cible=action-de-formation&id_cible=1&collection_name=visuel

Il est ensuite possible de filtrer les fichiers via les paramètres suivant :

id_doc_type : les fichiers uploadés via QR Code qui ont été reconnus comme étant ce modèle de document

Exemple : GET https://pro.dendreo.com/demo/api/cible=action-de-formation&id_cible=1&id_doc_type=2

id_formateur : les fichiers ‘liés’ à un Formateur au sein d'une Action de formation

Exemple : GET https://pro.dendreo.com/demo/api/cible=action-de-formation&id_cible=1&id_formateur=2

id_entreprise : les fichiers ‘liés’ à une Entreprise au sein d'une Action de formation

Exemple : GET https://pro.dendreo.com/demo/api/cible=action-de-formation&id_cible=1&id_entreprise=2

id_participant : les fichiers ‘liés’ à un Participant au sein d'une Action de formation

Exemple : GET https://pro.dendreo.com/demo/api/cible=action-de-formation&id_cible=1&id_participant=2

id_module : les fichiers ‘liés’ à un Module au sein d'une Action de formation

Exemple : GET https://pro.dendreo.com/demo/api/cible=action-de-formation&id_cible=1&id_module=2

Ajouter un fichier

{
    "id": "1",
    "collection_name": "avatar",
    "name": "sample",
    "mime_type": "image/jpeg",
    "size": "20461",
    "created_at": "2018-10-30 15:17:06",
    "updated_at": "2018-10-30 15:17:06",
    "deleted_at": "",
    "id_add": "1",
    "id_edit": "0",
    "cible": "formateur",
    "id_cible": "59"
}

Paramètres

Intitulé Obligatoire Description
file oui Fichier à envoyer
cible oui Type de la cible à laquelle rattacher le fichier (ex: formateur)
id_cible oui ID de la cible à laquelle rattacher le fichier
collection oui Le nom de la collection à laquelle associer le fichier (voir tableau ci-dessous)

Voici la liste des correspondances entre cible et collection possibles :

cible collection
action-de-formation visuel, docssaved
formateur avatar, docssaved
contact avatar
participant avatar, docssaved
module visuel, presentation, docssaved
entreprise logo, docssaved
salle-de-formation image_map, pdf_map
centre-de-formation logo, image_map, pdf_map, header, footer, cgv, reglement_interieur, centre_signature, docssaved
doctype docstype
expense expense

La collection ‘docssaved’ correspond à l'espace de stockage. Vous pouvez y ajouter plusieurs fichiers.

La collection ‘expense’ correspond aux justificatifs des notes de frais. Vous pouvez également y ajouter plusieurs fichiers.

Toutes les autres collections sont des fichiers ‘uniques’ c'est à dire que l'ajout d'un nouveau fichier écrasera celui qui serait déjà présent.

Vous pouvez également avoir d'autres collections relatives aux Champs personnalisés de type fichier. Dans ce cas, le nom de la collection sera le ‘Nom technique’ du champ personnalisé, disponible dans votre interface d'administration Dendreo

Requête HTTP

POST https://pro.dendreo.com/demo/api/fichiers.php

Catalogue en ligne - Prochaines sessions

Cliquez ici