Aller au contenu principal

Endpoints

Vue d'ensemble de tous les groupes d'endpoints disponibles dans l'API v1.

Formations

Catalogue, création, publication, modules et leçons.

Voir tout
  • GET/courses
  • POST/courses
  • GET/courses/:id
  • PATCH/courses/:id
  • DELETE/courses/:id

Inscriptions

Inscrire des apprenants, suivre leur progression, complétion.

Voir tout
  • GET/enrollments
  • POST/enrollments
  • GET/enrollments/:id
  • GET/enrollments/:id/progress
  • DELETE/enrollments/:id

Paiements

Intentions de paiement, remboursements, historique.

Voir tout
  • POST/payments/intent
  • POST/payments/:id/capture
  • POST/payments/:id/refund
  • GET/payments

Webhooks

Configuration, événements disponibles, vérification HMAC.

Voir tout
  • GET/webhooks
  • POST/webhooks
  • PUT/webhooks/:id
  • DELETE/webhooks/:id

Qualiopi

Export du dossier d'audit par formation, validation pré-publication.

Voir tout
  • GET/qualiopi/courses/:courseId/audit-export/preview
  • GET/qualiopi/courses/:courseId/audit-export
  • GET/qualiopi/check-publication

Conformité

Analyse des besoins, parcours adaptatifs, timeline PAF.

Voir tout
  • POST/needs-analysis
  • POST/adaptive-paths
  • GET/paf/enrollments/:id/timeline

Codes d'erreur

Codes d'erreur HTTP renvoyés par l'API REST QualiForma
CodeStatutDescription
400Bad RequestPayload invalide ou champ manquant
401UnauthorizedToken manquant, invalide ou expiré
403ForbiddenRôle insuffisant pour cette opération
404Not FoundRessource inexistante ou inaccessible
409ConflictRessource déjà existante (doublon)
422UnprocessableValidation métier échouée (ex. : capacité max atteinte)
429Too Many RequestsRate limiting dépassé (1000 req/h)
500Server ErrorErreur interne — signaler au support