Utilisez l'API publique ManageBac+ pour connecter d'autres systèmes. Créez et gérez des jetons API et recherchez les champs et autorisations pris en charge.
Découvrez comment fonctionne l'API publique ManageBac+ , comment créer et gérer des jetons d'API et où trouver les champs, fonctions, autorisations, notes et informations du journal des modifications pris en charge.
L'API publique ManageBac+ permet aux écoles de connecter leur compte ManageBac+ à des plateformes externes qui ne sont pas directement intégrées à ManageBac+ .
Seul un administrateur du compte de votre école peut configurer ces paramètres. Ce guide couvre la configuration, la gestion des jetons, les fonctions prises en charge, les notes techniques, les autorisations et les questions fréquemment posées.
Aperçu
L'API publique ManageBac+ est conçue pour les écoles qui doivent établir des connexions personnalisées avec des systèmes tiers. L'accès à l'API est contrôlé via des jetons créés et gérés par les administrateurs.
À partir d'API Manager, vous pouvez créer des jetons, contrôler les autorisations, consulter l'état des jetons, accéder à la documentation de référence et afficher le journal des modifications de l'API.
Paramètres > Développer dispose désormais de deux gestionnaires d'API. API Manager (Legacy) crée les jetons API décrits dans ce guide. API Manager (OAuth2) émet les informations d'identification OAuth2. Utilisez celui pris en charge par le système que vous connectez.
Concepts clés / Quoi de neuf
Champs et fonctions pris en charge
Ouvrez l'onglet Documents de référence dans le menu de gauche pour obtenir des conseils détaillés sur la configuration des connexions API, y compris des notes avec des exemples de demandes et de réponses. Cette page comprend également une liste déroulante de versions en haut afin que vous puissiez utiliser les requêtes disponibles répertoriées pour différentes versions d'API.
Autorisations API
Pour les champs d'autorisation, vous pouvez choisir Aucun, sélectionner uniquement ceux disposant de droits en lecture seule ou sélectionner Tous. Vous pouvez également sélectionner des champs individuels en cochant la case.
Étudiants
- indice
- montrer
- créer
- mise à jour
- archive
- désarchiver
Parents
- indice
- montrer
- créer
- mise à jour
- archive
- désarchiver
Enseignants
- indice
- montrer
- créer
- mise à jour
Groupes annuels
- indice
- conseillers
- étudiants
- ajouter des étudiants
- supprimer des étudiants
- fréquentation trimestrielle
- date de présence
Cours
- indice
- montrer
- étudiants
- ajouter des étudiants
- supprimer des étudiants
- fréquentation trimestrielle
- date de présence
Évaluations de classe
- notesterm-grades
Adhésions
- indice
École
- montrer
- années académiques
- sujets
- notes
Tâches
- indexshowétudiants
Fonctions API
Groupes annuels
- Obtenez tous les groupes annuels
- Obtenez des conseillers
- Obtenez des étudiants pour un groupe d'un an
- Ajouter des étudiants à un groupe annuel
- Supprimer des étudiants d'un groupe annuel
- Obtenez une fréquentation en classe pour un groupe d'un an et un trimestre
- Obtenez une fréquentation en classe pour un groupe annuel à une date spécifiée
Cours
- Obtenez tous les cours
- Obtenez un cours
- Invitez des étudiants à suivre un cours
- Ajouter des étudiants à une classe
- Supprimer des étudiants d'une classe
- Obtenir des tâches pour une classe
- Obtenez une tâche pour une classe
- Obtenir les résultats de l'évaluation des élèves pour une tâche et un cours
- Obtenir les notes trimestrielles d'une classe
- Obtenez toutes les notes d'une classe au cours d'une session académique
- Obtenez une participation à un cours pendant une session académique
- Obtenez une participation aux cours pour un rendez-vous
Adhésions
- Obtenez tous les abonnements
Étudiants
- Obtenez tous les étudiants
- Obtenez un étudiant
- Créer un nouvel étudiant
- Mettre à jour un étudiant
- Archiver un étudiant
- Désarchiver un étudiant
Enseignants
- Obtenez tous les professeurs
- Obtenez un professeur
- Créer un nouvel enseignant
- Mettre à jour un enseignant
Parents
- Obtenez tous les parents
- Obtenez un parent
- Créer un nouveau parent
- Mettre à jour un parent
- Archiver un parent
- Désarchiver un parent
École
- Obtenir les détails de l'école
- Obtenez des années académiques
- Obtenez des notes scolaires
- Obtenez des matières scolaires
Utilitaires
- Ping
- Obtenir un avatar
Journal des modifications de l'API
Vous pouvez afficher le journal des modifications de l'API dans ManageBac+ en accédant à Paramètres > Développer > API Manager (Legacy). Au bas de cette page, vous trouverez la section Changelog, où les mises à jour récentes de l'API sont répertoriées par ordre chronologique, y compris les nouveaux champs, les points de terminaison ajoutés ou modifiés et d'autres modifications techniques pertinentes.
Navigation étape par étape
Activez l'API publique ManageBac+ et ajoutez un jeton
- Accédez à Paramètres > Développer > API Manager (Legacy) > Ajouter un nouveau jeton.
- Cliquez sur Ajouter un nouveau jeton.
- Entrez un nom de jeton clair et utile afin qu'il soit facile d'identifier à quoi sert le jeton.
- Sélectionnez les points que vous souhaitez mettre à jour et récupérer, notamment les données sur les élèves, les parents et les enseignants, les groupes de l'IB, les classes et les paramètres de l'école.
- Cliquez sur Ajouter un jeton pour générer le jeton.
Modifier ou gérer un jeton API
- Ouvrez Paramètres > Développer > API Manager (Legacy).
- Utilisez l'icône du presse-papiers pour copier le jeton afin de l'utiliser dans un autre système approuvé.
- Passez la souris sur l'icône i pour afficher les autorisations du jeton.
- Vérifiez l'état du jeton pour voir s'il est activé ou désactivé.
- Cliquez sur Modifier pour ajuster les autorisations ou désactiver ou activer le jeton.
- Supprimez le jeton à l'aide de l'icône de la poubelle lorsque l'intégration n'est plus nécessaire.
Avertissements et remarques importantes
Avertissement de sécurité
Votre jeton API ne doit être partagé qu'avec des parties de confiance. Les jetons API ne doivent jamais être envoyés par e-mail ou enregistrés sur des formulaires sans cryptage SSL. Une fois qu'une intégration n'est plus utilisée, nous vous recommandons de désactiver le jeton API en cliquant sur l'icône de suppression.
Remarques sur l'API
- Les valeurs nulles ne sont jamais rendues.
- Les valeurs nulles sont ignorées dans les requêtes POST.
- Les valeurs de chaîne vides ne sont pas ignorées et écraseront les valeurs existantes.
- Tout appel renverra une erreur lorsqu'il ne trouvera pas d'utilisateur pour une affectation en masse, par exemple parent_ids ou child_ids.
- Paramètres disponibles pour la pile d'actions d'indexation à l'aide de la logique ET. L’utilisation simultanée de selected_since et delete_since peut ne pas renvoyer le résultat attendu car la suppression ne modifie pas l’horodatage de modification de l’enregistrement.
- Tous les utilisateurs disposant du rôle d'administrateur sont en lecture seule via l'API pour des raisons de sécurité.
- Tous les champs d'horodatage sont au format ISO8601, par exemple aaaa-mm-jjThh:mm:ss.sssTZ tel que 2017-11-06T04:35:00.000GST.
- Si vous avez des questions ou des préoccupations concernant l'API, veuillez contacter api@managebac.com.
Limite de taux
La limite de requêtes API est de 200 requêtes par minute à partir de la même adresse IP.
Foire aux questions
ManageBac+ s'intègre-t-il à une autre plateforme ?
Si le produit n'est pas répertorié sous Paramètres > Intégrations > Partenaires, il n'existe aucune relation formelle. Dans ces cas, votre école peut toujours être en mesure d'établir une intégration personnalisée en utilisant l'API publique.
ManageBac+ Support peut-il créer une intégration pour notre école ?
Faites-nous savoir quel système vous souhaitez intégrer à ManageBac+ et nous examinerons s'il est logique pour nous, en tant qu'entreprise et produit, de devenir un partenaire direct de cet outil ou service.
Le support ManageBac+ peut-il rédiger la demande API pour nous ?
L'équipe d'assistance ManageBac+ peut fournir des conseils sur les questions et problèmes liés à l'API, mais toutes les demandes d'API doivent être complétées directement par votre école. Si vous établissez une connexion personnalisée, veuillez consulter votre service informatique.
Quelle est la limite de débit de l’API ManageBac+ ?
La limite de requêtes API est de 200 requêtes par minute à partir de la même adresse IP.
Où puis-je trouver des conseils sur la façon d'utiliser l'API publique ManageBac+ ?
Veuillez vous référer à Paramètres > Développer > Documents de référence pour plus de détails sur chaque champ et les dernières notes du journal des modifications.
Ma requête API a un problème. Qui dois-je contacter ?
Veuillez envoyer un e-mail à api@managebac.com avec des détails clairs sur la demande et l'erreur que vous rencontrez.
En résumé
- L'API publique ManageBac+ permet aux écoles de connecter ManageBac+ à des systèmes externes via des jetons gérés par l'administrateur.
- Vous pouvez créer, réviser, modifier, désactiver et supprimer des jetons depuis Paramètres > Développer > API Manager (Legacy).
- Les documents de référence, les autorisations, les notes sur l'API, les détails du journal des modifications et les conseils d'assistance courants sont tous disponibles dans le flux de travail API Manager.
ManageBac+ offre aux écoles un moyen contrôlé de créer des intégrations personnalisées tout en gardant l'accès aux API sécurisé et basé sur les autorisations.