Administration de l’établissement
Relier vos systèmes à l’API de Smrt English
Lisez les dossiers des élèves et des classes de votre établissement depuis vos propres systèmes avec une clé d’API fournie par Smrt English.
L’API de Smrt English permet aux systèmes de votre établissement, comme un système de gestion des dossiers étudiants ou un tableau de bord de rapports, de lire les dossiers de vos élèves et de vos classes. Elle est en lecture seule : elle ne peut rien ajouter, modifier ni supprimer dans Smrt English.
Obtenir une clé d’API
Communiquez avec Smrt English pour demander une clé d’API pour votre établissement. Smrt English délivre et gère les clés. Une clé ne renvoie jamais que les élèves et les classes de votre propre établissement.
Une fois que votre établissement a une clé, ouvrez le Dashboard (tableau de bord), cliquez sur Home, puis sur Settings. La zone Client API indique combien de clés sont actives et combien de requêtes elles ont faites au cours des 30 derniers jours.
Remettez la clé à la personne qui développe votre intégration. Elle l’envoie dans l’en-tête X-API-Key de chaque requête.
Ce que vous pouvez lire
- Students : la liste de vos élèves, avec filtres et recherche, ou un élève par identifiant d’utilisateur ou par adresse courriel, y compris ses classes, ses devoirs terminés, ses évaluations et son temps d’apprentissage.
- Classes : la liste de vos classes, ou une classe avec son enseignant et sa liste d’élèves.
- Auth : un test qui vérifie que votre clé fonctionne.
La référence complète, avec des exemples en PHP, en Python et en JavaScript, se trouve dans la documentation de l’API. Votre développeur peut essayer chaque point de terminaison dans le navigateur à partir de la page de test qui y est liée.
Traitez la clé comme un mot de passe. Gardez-la sur votre serveur, jamais dans une page Web ni dans une application. Si vous pensez qu’elle a été exposée, communiquez immédiatement avec Smrt English.
