API Scoliom Scolarité · lecture seule · version 1

Branchez vos autres logiciels sur Scoliom Scolarité, en lecture seule

Votre logiciel de comptabilité, votre outil de statistiques ou un tableau de bord peut lire les élèves, les classes, les niveaux, les échéances, les paiements et les absences de l'école grâce à une API REST (JSON, HTTPS) — sans pouvoir rien modifier. L'API reste fermée tant que votre direction n'a pas créé de clé.

Lire la documentation développeur Poser une question technique
Les faits

Six règles que l'API respecte

Lecture seule, par construction

L'API ne répond qu'aux requêtes GET (et HEAD) : elle ne peut ni créer, ni modifier, ni supprimer quoi que ce soit dans la plateforme, et toute autre méthode est refusée. Les données se modifient toujours dans Scoliom Scolarité, par les utilisateurs autorisés.

Sept ressources

L'école, les niveaux, les classes, les élèves, les échéances, les paiements et les absences (retards compris). Les listes sont paginées, jusqu'à 200 éléments par page, et les élèves se synchronisent par différence, à partir d'une date donnée.

Une clé par logiciel, décidée par l'école

La direction crée une clé dans Paramètres › API, au nom du logiciel qu'elle branche : cinq clés actives au plus par école. La clé ne s'affiche qu'une fois : Scoliom n'en garde qu'une empreinte. Chacune se révoque à tout moment, sans toucher aux autres.

Fermée par défaut, cloisonnée par école

Sans clé, l'API ne répond rien. Une clé ne voit que son école. HTTPS seulement ; la clé passe dans un en-tête (Authorization: Bearer ou X-Api-Key), jamais dans l'adresse.

Un débit clair, un journal de chaque appel

60 appels par minute et par clé. Chaque appel est journalisé (date, ressource, nombre d'éléments, adresse IP) et conservé 90 jours ; la direction voit, pour chaque clé, son dernier usage et son nombre d'appels.

Seulement les données utiles

Selon le principe de minimisation de la loi 09-08 et du RGPD, l'API ne rend pas les adresses, les photos, les lieux de naissance, les notes internes, le motif d'une absence ni son justificatif, les commentaires libres sur les paiements, ni les coordonnées des parents.

Pour être clair : la version 1 lit, elle n'écrit pas. Des champs peuvent s'y ajouter, mais aucun ne sera renommé ni retiré sans une nouvelle version, annoncée à l'avance. L'école reste responsable du traitement : c'est elle qui décide quel logiciel reçoit une clé.

En pratique

Un appel, un en-tête, du JSON en retour

L'adresse de l'API figure dans Paramètres › API. Un appel qui liste les élèves inscrits ressemble à ceci :

curl -H "Authorization: Bearer sco_…" \
  "https://app.scoliom.com/api/v1.php?resource=students&status=inscrit&per_page=100"
  • school — l'école de la clé et son année scolaire en cours
  • levels — les niveaux, avec le niveau de passage
  • classes — les classes d'une année scolaire, avec leur nombre d'élèves inscrits
  • students — les élèves : numéro, numéro national (code Massar au Maroc), noms en lettres latines et arabes, statut, classe et niveau
  • installments — les échéances : montant, montant payé, reste dû, date d'échéance, statut
  • payments — les paiements encaissés : montant, date, mode de paiement, numéro de reçu, état du chèque
  • absences — les absences et les retards, avec leur statut de justification

Chaque ressource, chaque champ, chaque paramètre et chaque code d'erreur est décrit dans la documentation développeur, aussi disponible en anglais.

Questions fréquentes

L'API : les questions des directions et de leurs prestataires

Non. La version 1 est en lecture seule : elle ne répond qu'aux requêtes GET et HEAD et refuse toute autre méthode. Les données se modifient dans la plateforme, par les utilisateurs autorisés.

Éditeur de logiciel, prestataire informatique, service comptable ?

Dites-nous ce que vous voulez brancher

Nous répondons par écrit aux questions techniques : une ressource, un champ, la bonne façon de synchroniser.

Nous écrire

Réponse écrite · Sans engagement