Administration de l’établissement
Connecter vos systèmes à l’API Smrt English
Consultez les dossiers des apprenants et des classes de votre établissement depuis vos propres systèmes, avec une clé d’API fournie par Smrt English.
L’API Smrt English permet aux systèmes de votre établissement, comme un logiciel de gestion de la scolarité ou un tableau de bord de suivi, de consulter les dossiers de vos apprenants et de vos classes. Elle fonctionne en lecture seule : elle ne peut rien ajouter, modifier ni supprimer dans Smrt English.
Obtenir une clé d’API
Contactez Smrt English pour demander une clé d’API (API key) pour votre établissement. Smrt English délivre et gère les clés. Une clé ne renvoie jamais que les apprenants et les classes de votre propre établissement.
Une fois que votre établissement dispose d’une clé, ouvrez le Dashboard, cliquez sur Home, puis sur Settings. L’encadré Client API indique le nombre de clés actives et le nombre de requêtes effectuées au cours des 30 derniers jours.
!L’encadré Client API sur la page des paramètres du Dashboard
Remettez la clé à la personne chargée de votre intégration. Elle l’envoie dans l’en-tête X-API-Key de chaque requête.
Ce que vous pouvez consulter
- Students : la liste de vos apprenants avec filtres et recherche, ou un apprenant par identifiant utilisateur ou par adresse e-mail, avec 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’apprenants.
- Auth : un test qui vérifie que votre clé fonctionne.
La référence complète, avec des exemples en PHP, Python et JavaScript, se trouve dans la documentation de l’API. Votre développeur peut tester chaque point de terminaison (endpoint) dans le navigateur depuis la page de test accessible à partir de cette documentation.
Traitez la clé comme un mot de passe. Conservez-la sur votre serveur, jamais dans une page web ni dans une application. Si vous pensez qu’elle a été exposée, contactez immédiatement Smrt English.
