14 points d'entrée (13 en lecture, 1 en écriture), 7 portées de clé, des erreurs au format stable. Cette page est générée à partir du document OpenAPI 3.1.0 du moteur, version 1.0.0.
L'adresse de base est https://votre-espace/api/v1, où votre-espace est l'adresse de votre organisme. Une clé d'intégration, créée par un administrateur dans l'écran Intégrations, se passe dans l'en-tête Authorization: Bearer s4mk_…. Chaque clé est limitée à son organisme et à ses portées.
La même clé ouvre le serveur MCP pour les assistants IA : voir la page API, MCP et webhooks.
Télécharger la copie du document OpenAPI (le champ « servers » y contient l'adresse générique votre-espace, à remplacer par la vôtre).
# 1. Qui suis-je ? (toute clé valide)
curl -s https://votre-espace/api/v1/moi \
-H "Authorization: Bearer $CLE"
# 2. Réponse
{
"organisme_id": "of-…",
"cle": "CRM HubSpot",
"portees": ["organisme:lecture", "catalogue:lecture", "sessions:lecture"],
"version": "1.0.0"
}Chaque ligne renvoie à son détail plus bas : paramètres, codes de retour, exemple d'appel.
| Méthode | Chemin | Portée | Ce que vous obtenez |
|---|---|---|---|
| GET | /organisme | organisme:lecture | Identité publique de l'organisme |
| GET | /formations | catalogue:lecture | Catalogue des formations |
| GET | /sessions | sessions:lecture | Sessions disponibles à la vente |
| GET | /organisme/identite | organisme:lecture | Design system de l'organisme |
| GET | /organisme/dossier-documentaire | organisme:lecture | Dossier documentaire de l'organisme |
| GET | /certifications | catalogue:lecture | Certifications RS / RNCP de l'organisme |
| GET | /dossiers | dossiers:lecture | Dossiers de formation |
| GET | /dossiers/{id} | dossiers:lecture | Un dossier |
| GET | /indicateurs | qualite:lecture | Indicateurs de résultats |
| GET | /bpf | qualite:lecture | Bilan pédagogique et financier calculé |
| GET | /pilotage | qualite:lecture | Pilotage |
| GET | /editorial/calendrier | editorial:lecture | Calendrier éditorial des réseaux sociaux |
| POST | /leads | leads:ecriture | Déposer une demande de contact dans la boîte de réception de l'organisme |
| GET | /moi | toute clé | La clé utilisée |
Une clé ne voit que ce que l'administrateur a coché à sa création. Les libellés ci-dessous sont ceux du document OpenAPI.
| Portée | Ce qu'elle ouvre |
|---|---|
organisme:lecture | Identité publique de l'organisme (raison sociale, NDA, certificat) |
catalogue:lecture | Catalogue des formations |
sessions:lecture | Sessions disponibles à la vente (dates, lieux, places restantes, prix) |
qualite:lecture | Indicateurs qualité, BPF et pilotage (chiffres agrégés, sans donnée personnelle) |
dossiers:lecture | Dossiers de formation (contient des noms d'apprenants : données personnelles) |
leads:ecriture | Déposer une demande (prospect, contact) dans la boîte de réception |
editorial:lecture | Calendrier éditorial des réseaux sociaux (contenus prévus, validés, publiés) |
Identité publique de l'organisme (NDA, certificat Qualiopi, référent handicap)
200Succès : Identité de l'organisme401Clé absente ou refusée403Portée manquante429Trop de requêtescurl -s https://votre-espace/api/v1/organisme \
-H "Authorization: Bearer $CLE"Catalogue des formations
| Nom | Emplacement | Type | Requis | Précisions |
|---|---|---|---|---|
archivees | adresse (query) | string, parmi oui, non | non | par défaut non |
200Succès : Formations401Clé absente ou refusée403Portée manquante429Trop de requêtescurl -s https://votre-espace/api/v1/formations \
-H "Authorization: Bearer $CLE"Sessions disponibles à la vente (inter et intra) : dates, lieu, places restantes, prix HT en euros
| Nom | Emplacement | Type | Requis | Précisions |
|---|---|---|---|---|
formation_id | adresse (query) | string | non | |
du | adresse (query) | string (date) | non | Sessions qui commencent à partir de cette date. |
au | adresse (query) | string (date) | non | Sessions qui commencent au plus tard à cette date. |
modalite | adresse (query) | string, parmi presentiel, distanciel, mixte | non | |
lieu | adresse (query) | string | non | Texte cherché dans le nom et l'adresse du lieu. |
places | adresse (query) | integer | non | Places restantes minimales.. minimum 1 |
type | adresse (query) | string, parmi inter, intra | non |
200Succès : Sessions vendables401Clé absente ou refusée403Portée manquante429Trop de requêtescurl -s https://votre-espace/api/v1/sessions \
-H "Authorization: Bearer $CLE"Design system de l'organisme : palette (contrastes AA), typographies, rayons, boutons
200Succès : Design system401Clé absente ou refusée403Portée manquante429Trop de requêtescurl -s https://votre-espace/api/v1/organisme/identite \
-H "Authorization: Bearer $CLE"Dossier documentaire de l'organisme : activité, formations repérées, coordonnées publiques de fonction, ton éditorial (aucune donnée de personne physique)
200Succès : Dossier documentaire401Clé absente ou refusée403Portée manquante429Trop de requêtescurl -s https://votre-espace/api/v1/organisme/dossier-documentaire \
-H "Authorization: Bearer $CLE"Certifications RS / RNCP de l'organisme
200Succès : Certifications401Clé absente ou refusée403Portée manquante429Trop de requêtescurl -s https://votre-espace/api/v1/certifications \
-H "Authorization: Bearer $CLE"Dossiers de formation (pagination par `apres` et `limite`)
| Nom | Emplacement | Type | Requis | Précisions |
|---|---|---|---|---|
etape | adresse (query) | string | non | |
statut | adresse (query) | string | non | |
archives | adresse (query) | string, parmi oui, non, tous | non | par défaut non |
limite | adresse (query) | integer | non | par défaut 50 ; minimum 1 ; maximum 200 |
apres | adresse (query) | integer | non | par défaut 0 ; minimum 0 |
200Succès : Page de dossiers401Clé absente ou refusée403Portée manquante429Trop de requêtescurl -s https://votre-espace/api/v1/dossiers \
-H "Authorization: Bearer $CLE"Un dossier : avancement, pièces manquantes, statut de chaque pièce
| Nom | Emplacement | Type | Requis | Précisions |
|---|---|---|---|---|
id | chemin | string | oui | Identifiant ou référence du dossier. |
200Succès : Dossier401Clé absente ou refusée403Portée manquante404Introuvable429Trop de requêtescurl -s https://votre-espace/api/v1/dossiers/ID_OU_REFERENCE \
-H "Authorization: Bearer $CLE"Indicateurs de résultats (Qualiopi, indicateur 2) et publications
| Nom | Emplacement | Type | Requis | Précisions |
|---|---|---|---|---|
exercice | adresse (query) | integer | non | Exercice civil (par défaut : le plus récent).. exemple 2026 |
200Succès : Indicateurs401Clé absente ou refusée403Portée manquante429Trop de requêtescurl -s https://votre-espace/api/v1/indicateurs \
-H "Authorization: Bearer $CLE"Bilan pédagogique et financier calculé
| Nom | Emplacement | Type | Requis | Précisions |
|---|---|---|---|---|
exercice | adresse (query) | integer | non | Exercice civil (par défaut : le plus récent).. exemple 2026 |
200Succès : BPF401Clé absente ou refusée403Portée manquante429Trop de requêtescurl -s https://votre-espace/api/v1/bpf \
-H "Authorization: Bearer $CLE"Pilotage : chiffre d'affaires facturé, dossiers par étape, alertes
| Nom | Emplacement | Type | Requis | Précisions |
|---|---|---|---|---|
annee | adresse (query) | integer | non |
200Succès : Pilotage401Clé absente ou refusée403Portée manquante429Trop de requêtescurl -s https://votre-espace/api/v1/pilotage \
-H "Authorization: Bearer $CLE"Calendrier éditorial des réseaux sociaux : contenus datés de la période (30 jours à partir d'aujourd'hui par défaut, 400 au plus)
| Nom | Emplacement | Type | Requis | Précisions |
|---|---|---|---|---|
debut | adresse (query) | string (date) | non | AAAA-MM-JJ (par défaut : aujourd'hui). |
fin | adresse (query) | string (date) | non | AAAA-MM-JJ (par défaut : début + 30 jours). |
statut | adresse (query) | string, parmi idee, brouillon, a_valider, valide, programme, publie, abandonne | non | Un seul statut (par défaut : tous sauf « abandonne »). |
200Succès : Contenus de la période400Requête invalide401Clé absente ou refusée403Portée manquante429Trop de requêtescurl -s https://votre-espace/api/v1/editorial/calendrier \
-H "Authorization: Bearer $CLE"Déposer une demande de contact dans la boîte de réception de l'organisme
| Champ | Type | Requis | Précisions |
|---|---|---|---|
prenom | string | oui | 80 caractères au plus |
nom | string | oui | 80 caractères au plus |
email | string (email) | oui | |
telephone | string | non | 30 caractères au plus |
formation_souhaitee | string | non | 400 caractères au plus |
objectif | string | oui | 5 caractères au moins ; 1000 caractères au plus |
message | string | non | 2500 caractères au plus |
source | string | non | Outil ou campagne d'origine (par défaut : le nom de la clé).. 120 caractères au plus |
201Créé : Demande enregistrée400Requête invalide401Clé absente ou refusée403Portée manquante429Trop de requêtescurl -s -X POST https://votre-espace/api/v1/leads \
-H "Authorization: Bearer $CLE" \
-H "content-type: application/json" \
-d '{"prenom":"Paul","nom":"Durand","email":"paul@exemple.fr",
"objectif":"Formation Excel","source":"HubSpot"}'La clé utilisée : organisme et permissions (pour tester une connexion)
200Succès : Clé401Clé absente ou refusée403Portée manquante429Trop de requêtescurl -s https://votre-espace/api/v1/moi \
-H "Authorization: Bearer $CLE"Trois exemples. Les champs sont ceux que le moteur renvoie ; les valeurs sont fictives et les points de suspension marquent ce qui est omis ici.
{
"total": 37,
"suivant": 5,
"etapes": [ … ],
"dossiers": [
{
"id": "…",
"reference": "ADF-2026-0042",
"statut": "dossier_valide",
"libelle_statut": "…",
"etape": "B",
"archive": false,
"formation": "…",
"date_debut": "2026-12-01",
"date_fin": "2026-12-03",
"formateur": "…",
"apprenants": …,
"pieces": { "validees": 4, "total": 9 },
"avancement": { "pourcentage": 44, "manquants": [ … ] },
"maj_le": "2026-11-13T09:12:44.120Z"
}
]
}Pagination : le champ suivant donne la valeur à passer dans le paramètre apres ; il vaut null à la dernière page.
HTTP 201
{
"numero": "…",
"id": "…",
"statut": "nouveau"
}{
"erreur": "message en français",
"code": "non_authentifie | interdit | introuvable | invalide | conflit | trop_de_requetes"
}Un 429 porte l'en-tête Retry-After.
À l'adresse /api/v1/openapi.json de votre espace : il est public et ne contient aucune donnée. Make, Zapier, n8n et Postman savent l'importer. Cette page en est tirée ; une copie est téléchargeable ci-dessous.
Selon la documentation livrée avec le moteur : 600 requêtes par minute et par clé, et au plus 200 éléments par page. Au-delà, l'API répond 429 avec l'en-tête Retry-After.
Pas dans cette version : l'écriture se limite au dépôt d'une demande de contact (POST /leads). La création de dossiers, d'apprenants et le dépôt de pièces sont prévus pour une version suivante, sans date annoncée.
Seulement avec la portée dossiers:lecture, qui n'est jamais cochée par défaut. Les autres portées ne donnent que des chiffres agrégés, des informations publiques ou le catalogue.
Non. Les champs listés sont ceux que le moteur renvoie, les valeurs sont fictives, et les points de suspension marquent ce qui est omis. Le document OpenAPI décrit chaque réponse comme un objet JSON ; le détail champ par champ se voit en appelant votre espace avec une clé.
L'écran Intégrations est ouvert dans l'essai : vous créez une clé, vous la testez avec la requête GET /moi, vous voyez ce qu'elle ouvre. Données fictives, gratuit pendant 30 jours.