Aller au contenu principal

Introduction à l'API ModernSchools

APIIntégrateurResponsable informatiqueDisponible⏱ 5 min

Objectif​

Savoir quelle API utiliser, comment s'y authentifier et quelles règles s'appliquent aux intégrations.

Deux API publiques​

La Directory API (/api/directory/v1) est publique et sans authentification : elle sert à retrouver un établissement et son instance. La Mobile API (/api/mobile/v1) est authentifiée : elle porte le travail de l'enseignant, des classes jusqu'à la soumission des bordereaux.

Ce que les API publiques n'exposent pas​

Aucun accès d'infrastructure, aucun secret, aucune procédure de sauvegarde ou de restauration, aucun détail du plan de contrôle opérateur. Ces éléments ne sont pas documentés publiquement, par conception.

Identifier un élève de façon durable​

Une intégration qui suit un élève dans le temps doit s'appuyer sur son identityUuid. Le matricule institutionnel peut être rectifié, le nom peut être corrigé : ni l'un ni l'autre ne constituent une clé stable.

Règle de soumission des notes​

La soumission d'un bordereau est une transaction unique portant sur une évaluation complète. Il n'existe pas d'endpoint de soumission note par note, et la disponibilité du réseau ne déclenche aucun envoi automatique côté client.

Source de cette référence​

Les pages Directory API et Mobile API sont générées à partir des fichiers OpenAPI du dépôt. En cas de divergence apparente entre une page et le comportement observé, le contrat OpenAPI fait foi.

Cette page vous a-t-elle aidé ?

Toujours bloqué ? Écrivez au support : support@modernschools.online