ELRM developer Bac à sable

L'espace client#

Les routes de votre espace sur le portail, ouvertes à votre clé : ce que vous faites à l'écran, vous pouvez le faire par l'API.

Le principe#

Le portail client d'ELRM appelle lui-même ces routes. Elles évoluent donc avec lui : une fonction ajoutée au portail est disponible ici le jour même, avec la même logique et les mêmes contrôles.

Elles vivent sous /espace :

Route Droit Portée
GET /espace/formations/dossiers, …/dossiers/{id} Consulter ses dossiers clients:dossiers:read
GET /espace/formations/sessions, …/sessions/{id} Consulter ses dossiers clients:dossiers:read
GET /espace/formations/apprenants, …/certifications Consulter ses apprenants clients:apprenants:read
GET, POST, PUT, DELETE …/dossiers/{id}/inscription/… Inscrire et répartir ses apprenants clients:apprenants:write
GET /espace/formations/factures, …/{id}, …/{id}/pdf Consulter ses factures clients:factures:read

La référence détaille chaque route (tag « Espace client ») et annonce les droits qu'elle exige (x-droits).

Vos droits#

Vos droits sont réglés par ELRM sur votre fiche client, un seul jeu pour le portail et pour l'API. Pour chaque droit, ELRM décide s'il vaut aussi pour vos clés :

  • une clé reçoit en général tous les droits API de votre fiche, et suit leurs évolutions ;
  • elle peut aussi n'en recevoir qu'une partie (une clé en lecture seule pour un outil de reporting, par exemple) ;
  • certains droits restent propres au portail : le règlement d'une facture par carte, par exemple, ne se fait qu'à l'écran.

Un droit absent répond 403 forbidden, sans détail.

Exemple : lister ses dossiers#

curl https://developer.elrm.app/sandbox/v1/espace/formations/dossiers \
  -H "Authorization: Bearer pk_test_…"

Inscription pas à pas#

L'inscription suit les mêmes étapes que le portail :

  1. GET …/dossiers/{id}/inscription : l'état du dossier (apprenants, lignes, sessions proposées).
  2. POST …/inscription/apprenants puis, pour chacun, PUT …/apprenants/{id}/lignes : la liste des apprenants et les formations de chacun.
  3. POST …/apprenants/{id}/documents (envoi multipart/form-data, 10 Mo par fichier) : leurs pièces (CACES, diplôme…).
  4. POST …/inscription/etape-apprenants : la liste est arrêtée.
  5. POST …/inscription/affectations : chaque apprenant dans une session.
  6. POST …/inscription/valider : les inscriptions sont définitives, l'organisme prend le relais.

Chaque étape renvoie l’état complet du dossier. Une action hors étape répond 400 validation_error avec un message lisible.

Pour une intégration « machine à machine », les routes du guide Inscrire et répartir les apprenants restent disponibles : elles ajoutent l'idempotence (Idempotency-Key) et le contrôle de version (If-Match).