Les établissements scolaires s'appuient de plus en plus sur plusieurs systèmes pour gérer les élèves, le personnel et les activités. La synchronisation de ces données impliquait traditionnellement une ressaisie manuelle ou des solutions de contournement spécifiques. L'API publique SchoolsBuddy change la donne en offrant aux écoles un moyen sûr et direct de connecter SchoolsBuddy aux outils qu'elles utilisent déjà.

Conçue autour de la gestion des utilisateurs et des activités, l'API offre aux équipes de développement un moyen évolutif et flexible d'interagir avec SchoolsBuddy par programmation, l'accès étant strictement contrôlé par les super administrateurs de l'organisation afin de garantir la sécurité de chaque intégration.

Aperçu

L'API publique SchoolsBuddy est conçue pour réduire la saisie manuelle de données et assurer la synchronisation des données au sein de l'écosystème de votre établissement scolaire. Elle est destinée aux équipes techniques, généralement les super administrateurs de l'organisation et leurs développeurs, qui ont besoin d'automatiser des tâches administratives en masse ou d'intégrer SchoolsBuddy à une plateforme SIG/SIS personnalisée ou développée en interne.

Quoi de neuf

L'API comprend des points de terminaison pour les entités de données principales, notamment les étudiants, les contacts, le personnel, les événements, les lieux, les groupes, les préférences et les inscriptions à la réservation instantanée. Ses principales fonctionnalités sont les suivantes :

• Gestion des lieux : Créer et gérer des lieux dédiés à utiliser pour toutes les activités scolaires.
• Exportation des données : Exportez les activités SchoolsBuddy par élève ou par événement pour un affichage et une intégration fluides avec d’autres systèmes internes.
• API de gestion des présences : Lisez et écrivez par programmation les enregistrements de présence aux événements afin de maintenir la synchronisation en temps réel de l’ensemble de votre écosystème scolaire.
• Inscription d'élèves externes : Ajoutez et gérez les élèves qui ne figurent pas dans le système d'information scolaire de l'établissement, tels que les élèves préinscrits, les participants aux cours d'été ou les participants aux activités d'enrichissement externes.
• Dossiers du personnel et des animateurs : Gérer le personnel externe non répertorié dans le SIS, y compris les animateurs invités, les entraîneurs externes, les responsables de voyage ou le personnel du district.
• Intégration virtuelle : Mettez à jour et gérez les identifiants de réunion en ligne des enseignants pour les plateformes de communication numérique choisies par votre établissement.
• Création et gestion : inscriptions aux préférences et aux réservations instantanées, groupes pour la planification d’événements sportifs ou de voyages, groupes pour les frais de scolarité et classes par matière pour les rencontres parents-professeurs (uniquement nécessaire si vous n’avez pas d’autre source d’importation de données).

Navigation étape par étape

Configuration de votre client API

Paramètres d'administration > Intégrations > API publique

1. Veuillez confirmer que vous êtes connecté en tant que super administrateur de l'organisation, car ce rôle est requis pour fournir un accès à l'API.
2. Suivez le guide d'installation dédié pour enregistrer votre client API et générer des identifiants.
3. Configurez l'authentification OAuth 2.0 pour votre intégration en utilisant les informations d'identification fournies.
4. Consultez la documentation Swagger pour connaître les points de terminaison disponibles (Étudiants, Contacts, Personnel, Événements, Lieux, Groupes, Inscriptions).
5. Testez votre intégration sur un jeu de données hors production, si possible, avant de déployer la synchronisation des données en direct.

Les instructions complètes d'installation sont disponibles ici : Comment configurer l'API publique SchoolsBuddy .

Conseils et bonnes pratiques

• La sécurité avant tout : utilisez la norme d’authentification OAuth 2.0 fournie pour garantir un accès sécurisé à vos données.
• Documentation de référence : Les développeurs doivent consulter le portail d’intégration et la page Swagger pour obtenir les spécifications complètes des points de terminaison et les instructions d’authentification.
• Efficacité : Utilisez les métadonnées de pagination pour une récupération efficace des données lors du traitement de grands ensembles de données.

Avertissements et notes importantes

Articles connexes

• Comment configurer l'API publique SchoolsBuddy
• Gestion des autorisations de super administrateur de l'organisation

Foire aux questions

Quelle méthode d'authentification est utilisée ?

L'API utilise l'authentification OAuth 2.0 pour garantir des normes de sécurité modernes pour toutes les intégrations.

La documentation technique est-elle disponible ?

Oui, une documentation complète pour les développeurs, incluant les définitions OpenAPI/Swagger, est disponible via le portail d'intégration .

Qui peut configurer l'accès API ?

Seuls les super administrateurs de l'organisation peuvent fournir un accès client API, ce qui permet de contrôler étroitement la sécurité de l'intégration.

En résumé

• L'API connecte SchoolsBuddy aux systèmes internes ou tiers afin d'automatiser les flux de données.
• Il couvre actuellement les étudiants, le personnel, les événements, les lieux, les groupes, ainsi que les inscriptions par préférence et par réservation instantanée.
• L'accès est exclusivement géré par les super administrateurs de l'organisation via OAuth 2.0.

Améliorez l'efficacité opérationnelle de votre établissement scolaire grâce à l'API publique SchoolsBuddy .