Référence Directory API

APIIntégrateurResponsable informatiqueDisponible⏱ 10 min

ℹ️

Page générée

Cette page est générée à partir du contrat OpenAPI du dépôt. Ne la modifiez pas à la main : toute correction se fait dans le contrat, puis le build la répercute. En cas de divergence apparente avec le comportement observé, le contrat fait foi.

API publique, sans authentification, permettant à une application cliente de retrouver un établissement et l'adresse de son instance avant toute connexion. Elle n'expose aucune donnée scolaire nominative.

Version du contrat : 1.0.0

Serveurs

• https://directory.modernschools.online/api/directory/v1 — Annuaire de production

Authentification

Cette API est publique : aucune authentification n'est requise.

Points de terminaison

Établissements

Recherche et consultation des établissements publiés.

Rechercher un établissement

GET/establishments

Rechercher un établissement

Généré depuis le contrat ModernSchools Directory API

Recherche par nom, ville ou région. Seuls les établissements publiés dans l'annuaire sont retournés.

Paramètres

		Type
q	query	string	obligatoire — Terme de recherche (nom ou fragment de nom).
region	query	string	optionnel — Filtre optionnel sur la région administrative.
limit	query	integer	optionnel

Réponses

200	Liste des établissements correspondants. objet
400	Requête invalide. Error

Consulter un établissement

GET/establishments/{slug}

Consulter un établissement

Généré depuis le contrat ModernSchools Directory API

Retourne la fiche publique d'un établissement, dont l'adresse de son instance. C'est cette adresse qu'un client mobile mémorise après le rattachement.

Paramètres

		Type
slug	path	string	obligatoire — Identifiant public de l'établissement.

Réponses

200	Fiche de l'établissement. Establishment
404	Ressource introuvable. Error

Lister les régions couvertes

GET/regions

Lister les régions couvertes

Généré depuis le contrat ModernSchools Directory API

Régions administratives dans lesquelles au moins un établissement est publié.

Réponses

200	Liste des régions. objet

Découverte

Configuration publique d'une instance.

Découvrir la configuration d'une instance

GET/establishments/{slug}/configuration

Découvrir la configuration d'une instance

Généré depuis le contrat ModernSchools Directory API

Points d'entrée à utiliser par un client : API, authentification, documentation et versions supportées. Un client doit les découvrir plutôt que les coder en dur.

Paramètres

		Type
slug	path	string	obligatoire

Réponses

200	Configuration publique de l'instance. InstanceConfiguration
404	Ressource introuvable. Error

Schémas

EstablishmentSummary

Champs	Type
slug	string	obligatoire	Identifiant public stable de l'établissement.
name	string	obligatoire	—
city	string	obligatoire	—
region	string	obligatoire	—
kind	string	obligatoire	Type d'établissement. — Valeurs admises : secondary-general, secondary-technical, primary, other

Establishment

EstablishmentSummary + :

Champs	Type
instanceUrl	string (uri)	optionnel	Adresse de l'instance de l'établissement.
status	string	optionnel	État de publication de l'établissement. — Valeurs admises : active, suspended
documentationUrl	string (uri)	optionnel	—

InstanceConfiguration

Champs	Type
apiBaseUrl	string (uri)	obligatoire	Racine de l'API mobile de l'instance.
authorizationServer	string (uri)	obligatoire	Serveur d'autorisation OAuth 2.0.
documentationUrl	string (uri)	optionnel	—
supportedVersions	string[]	obligatoire	Versions majeures d'API servies par l'instance.

Region

Champs	Type
code	string	obligatoire	—
name	string	obligatoire	—

Error

Champs	Type
code	string	obligatoire	Code applicatif stable, sur lequel brancher la logique client.
message	string	obligatoire	Message destiné aux journaux, pas à l'utilisateur final.