API publique ManageBac+
Découvrez le fonctionnement de l'API publique ManageBac+ , comment créer et gérer des jetons d'API, et où trouver les champs, fonctions, autorisations, notes et informations sur les modifications prises en charge.
L'API publique ManageBac+ permet aux établissements scolaires de connecter leur compte ManageBac+ à des plateformes externes qui ne sont pas directement intégrées à ManageBac+ .
Seul un administrateur du compte de votre établissement scolaire peut configurer ces paramètres. Ce guide aborde la configuration, la gestion des jetons, les fonctionnalités prises en charge, les notes techniques, les autorisations et les questions fréquentes.
Aperçu
L'API publique ManageBac+ est conçue pour les établissements scolaires qui doivent établir des connexions personnalisées avec des systèmes tiers. L'accès à l'API est contrôlé par des jetons créés et gérés par les administrateurs.
Depuis l'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 consulter le journal des modifications de l'API.
Concepts clés / Nouveautés
Domaines et fonctions pris en charge
Ouvrez l'onglet « Documentation de référence » dans le menu de gauche pour obtenir des instructions détaillées sur la configuration des connexions API, ainsi que des exemples de requêtes et de réponses. Cette page comprend également un menu déroulant en haut permettant de sélectionner la version de l'API parmi les requêtes disponibles.
Autorisations API
Pour les champs d'autorisation, vous pouvez choisir « Aucun » , sélectionner uniquement ceux disposant de droits de lecture seule ou sélectionner « Tous » . Vous pouvez également sélectionner des champs individuels en cochant la case correspondante.
É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 d'années
- indice
- conseillers
- étudiants
- ajouter-étudiants
- supprimer-étudiants
- fréquentation scolaire
- présence à la date
Cours
- indice
- montrer
- étudiants
- ajouter-étudiants
- supprimer-étudiants
- fréquentation scolaire
- présence à la date
Évaluations en classe
- notestrimestres
Adhésions
- indice
École
- montrer
- années universitaires
- sujets
- notes
Tâches
- indexshowstudents
Fonctions API
Groupes d'années
- Obtenir tous les groupes d'âge
- Obtenez des conseillers
- Recruter des élèves pour un groupe d'âge
- Ajouter des élèves à un groupe d'âge
- Retirer des élèves d'un groupe d'âge
- Consultez les statistiques de présence en classe pour une année et un trimestre.
- Obtenir les statistiques de présence en classe pour un niveau scolaire donné à une date précise.
Cours
- Obtenir tous les cours
- Inscrivez-vous à un cours
- Trouver des élèves pour une classe
- Ajouter des élèves à une classe
- Retirer des élèves d'une classe
- Obtenir des tâches pour une classe
- Obtenir une tâche pour un cours
- Obtenir les résultats d'évaluation des élèves pour une tâche et une classe
- Obtenir les notes trimestrielles d'un cours
- Obtenir toutes les notes d'un cours pour un trimestre universitaire
- Obtenir les présences à un cours pendant un trimestre universitaire
- Obtenir le relevé de présence en cours pour une date donnée
Adhésions
- Obtenez tous les abonnements
Étudiants
- Obtenir tous les étudiants
- Trouver un étudiant
- Créer un nouvel étudiant
- Mettre à jour les informations d'un étudiant
- Archiver un étudiant
- Désarchiver un étudiant
Enseignants
- Obtenir tous les enseignants
- Trouver un professeur
- Créer un nouvel enseignant
- Mise à jour d'un enseignant
Parents
- Obtenir tous les parents
- Obtenir un parent
- Créer un nouveau parent
- Mise à jour pour les parents
- Archiver un parent
- Désarchiver un parent
École
- Obtenir les détails de l'école
- Obtenez des années académiques
- Obtenir ses notes scolaires
- Obtenir les matières scolaires
Services publics
- Ping
- Obtenir Avatar
Journal des modifications de l'API
Vous pouvez consulter l' historique des modifications de l'API dans ManageBac+ en accédant à Paramètres > Développement > Gestionnaire d'API . En bas de cette page, vous trouverez la section « Historique des modifications » , où les mises à jour récentes de l'API sont listées par ordre chronologique, notamment les nouveaux champs, les points de terminaison ajoutés ou modifiés, ainsi que d'autres modifications techniques importantes.
Navigation étape par étape
Activez l'API publique ManageBac+ et ajoutez un jeton
- Accédez à Paramètres > Développement > Gestionnaire d'API > Ajouter un nouveau jeton .
- Cliquez sur Ajouter un nouveau jeton .
- Saisissez un nom de jeton clair et utile afin qu'il soit facile d'identifier à quoi il sert.
- Sélectionnez les points que vous souhaitez mettre à jour et récupérer, notamment les données des élèves, des parents et des enseignants, les groupes IB, les classes et les paramètres de l'établissement.
- Cliquez sur Ajouter un jeton pour générer le jeton.
Modifier ou gérer un jeton d'API
- Ouvrez Paramètres > Développement > Gestionnaire d'API .
- Utilisez l'icône du presse-papiers pour copier le jeton et l'utiliser dans un autre système de confiance.
- Survolez 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 corbeille lorsque l'intégration n'est plus nécessaire.
Avertissements et notes importantes
Alerte de sécurité
Votre jeton API ne doit être partagé qu'avec des tiers de confiance. Il ne doit jamais être envoyé par e-mail ni enregistré dans des formulaires sans chiffrement SSL. Une fois l'intégration inutilisée, nous vous recommandons de désactiver le jeton API en cliquant sur l'icône de suppression.
Notes sur l'API
- Les valeurs nulles ne sont jamais affichées.
- 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 s'il ne parvient pas à trouver un utilisateur pour l'affectation en masse, par exemple parent_ids ou child_ids .
- Les paramètres disponibles pour les actions d'indexation s'empilent selon la logique ET . L'utilisation simultanée de modified_since et deleted_since peut ne pas donner le résultat escompté, car la suppression ne modifie pas l'horodatage de modification de l'enregistrement.
- Pour des raisons de sécurité, les utilisateurs ayant le rôle d'administrateur ont un accès en lecture seule à l'API.
- Tous les champs d'horodatage sont au format ISO8601, par exemple yyyy-mm-ddThh:mm:ss.sssTZ comme 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 débit
La limite de requêtes API est de 200 requêtes par minute provenant 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 , cela signifie qu'il n'existe aucun partenariat officiel. Dans ce cas, votre établissement scolaire pourra peut-être tout de même établir une intégration personnalisée via l'API publique.
L'assistance ManageBac+ peut-elle mettre en place une intégration pour notre école ?
Faites-nous savoir quel système vous souhaitez intégrer à ManageBac+ , et nous examinerons s'il est judicieux pour nous, en tant qu'entreprise et produit, de devenir un partenaire direct de cet outil ou service.
L'assistance ManageBac+ peut-elle rédiger la requête API pour nous ?
L'équipe d'assistance ManageBac+ peut vous aider concernant les questions et problèmes liés à l'API, mais toutes les demandes d'API doivent être effectuées directement par votre établissement. 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 provenant de la même adresse IP.
Où puis-je trouver des instructions sur l'utilisation de l'API publique ManageBac+ ?
Veuillez consulter Paramètres > Développement > Documentation de référence pour plus de détails sur chaque champ et les dernières notes de modification.
Ma requête API rencontre un problème. Qui dois-je contacter ?
Veuillez envoyer un courriel à api@managebac.com en précisant clairement votre demande et l'erreur rencontrée.
En résumé
- L'API publique ManageBac+ permet aux établissements scolaires de connecter ManageBac+ à des systèmes externes via des jetons gérés par l'administrateur.
- Vous pouvez créer, consulter, modifier, désactiver et supprimer des jetons depuis Paramètres > Développement > Gestionnaire d'API .
- Les documents de référence, les autorisations, les notes d'API, les détails du journal des modifications et les conseils d'assistance communs sont tous disponibles dans le flux de travail d'API Manager.
ManageBac+ offre aux établissements scolaires une méthode contrôlée pour créer des intégrations personnalisées tout en garantissant un accès API sécurisé et basé sur les autorisations.