Bienvenue sur la documentation technique de l’API du Tableau de bord de l’apprentissage.

Notre API permettra d’envoyer automatiquement des données au Tableau de bord :

Si vous êtes un ERP, vous pourrez interfacer votre ERP avec le Tableau de bord afin de permettre à vos clients OFA d’activer la transmission automatique de leurs données au Tableau de bord de l’apprentissage.
Si vous êtes un OFA avec un ERP maison ou un SI maison, vous pourrez vous interfacer de la même manière, et pour le même objectif.

Ces données enrichiront le Tableau de bord : https://cfas.apprentissage.beta.gouv.fr

Procédure d'interfaçage

RDV exploratoire : Présentation du Tableau de bord de l'apprentissage + cadrage initial
Lire la documentation technique ici présente :
📐 la page présente
🟢 Schema Swagger : https://cfas-recette.apprentissage.beta.gouv.fr/api/doc/#/v3/post_v3_dossiers_apprenants
📊 Guide du modèle de données
Nous créons vos accès à l’environnement test (comptes user et clé API) sur un organisme test : indiquez-nous le couple UAI-SIRET d’un de vos clients.
Tests de transmission, échanges, recette et validation avec notre équipe technique
Bascule en production
Communication auprès de vos clients. Webinaire et support assurés par l’équipe Tableau de bord.

💬 Contactez-nous pour planifier le rendez-vous exploratoire.

Transfert des données

La procédure pour envoyer les données est d'appeler l'URL suivante : https://cfas-recette.apprentissage.beta.gouv.fr/api/v3/dossiers-apprenants en POST avec le token en header (Authorization: Bearer xxxx-xxxx-xxxx) et de passer un tableau d'apprenants dans le body.

Le transfert de données est à réaliser par OFA sur la route API suivante.

Method

POST

Endpoint

https://cfas-recette.apprentissage.beta.gouv.fr/api/v3/dossiers-apprenants?siret=XXXXX&uai=YYYYY&erp=ZZZZZ
Avec ?siret=XXXXX&uai=YYYYY&erp=ZZZZZ à paramétrer par l’éditeur dynamiquement en fonction du client.

Headers

Authorization: Bearer api_key

Body

API v3 schema : https://cfas-recette.apprentissage.beta.gouv.fr/api/doc/#/v3/post_v3_dossiers_apprenants

Réponses API

200, nous avons pu traiter la donnée et la sauvegarder chez nous, en revanche il se peut que certaines données ne soient pas valides (voir le tableau validation_errors) (voir également le rapport Transmissions https://cfas-recette.apprentissage.beta.gouv.fr/transmissions)
400, nous avons essayé de traiter la donnée, mais nous n'avons pas réussi à la sauvegarder dans notre base (l'erreur est dans le payload de la réponse)
403, clé d'API non valide
500, erreur inattendue

Informations utiles pour votre intégration

Clé d'identification d'un apprenant

Pour information, un effectif unique est déterminé par le n-uplet suivant
"id_erp_apprenant"
"etablissement_lieu_de_formation_uai"
"etablissement_lieu_de_formation_siret"
"formation_cfd"
"annee_scolaire"

Environnements

En RECETTE : https://cfas-recette.apprentissage.beta.gouv.fr/

Url de génération de clé API : https://cfas-recette.apprentissage.beta.gouv.fr/connexion-api?siret=XXXXX&uai=YYYYY&erp=ZZZZZ
Url de vérification/validation de clé API (après saisie dans l’ERP) : https://cfas-recette.apprentissage.beta.gouv.fr/connexion-api?siret=XXXXX&uai=YYYYY&erp=ZZZZZ&api_key=TTTTT

En PRODUCTION : https://cfas.apprentissage.beta.gouv.fr/

Url de génération de clé API : https://cfas.apprentissage.beta.gouv.fr/connexion-api?siret=XXXXX&uai=YYYYY&erp=ZZZZZ

Url de vérification/validation de clé API (après saisie dans l’ERP) : https://cfas.apprentissage.beta.gouv.fr/connexion-api?siret=XXXXX&uai=YYYYY&erp=ZZZZZ&api_key=TTTTT

Mis à jour le : 02/09/2024