Ce guide explique comment configurer et gérer l'accès API dans SchoolsBuddy . Ce processus permet à votre équipe technique de s'authentifier via OAuth 2.0 et de commencer à connecter vos systèmes externes à SchoolsBuddy .

L'accès à ces paramètres nécessite des autorisations spécifiques ; assurez-vous d'être connecté en tant que super administrateur de l'organisation avant de continuer.

Aperçu

L'espace Gestionnaire d'API publiques est accessible aux super administrateurs de l'organisation. Ce hub central vous permet de créer, modifier et sécuriser les clients utilisés pour l'intégration des données de votre établissement scolaire.

Concepts clés

Avant de commencer l'installation, vérifiez que les conditions préalables suivantes sont remplies :

• Vous êtes connecté en tant que super administrateur de l'organisation .
• Vous disposez de votre documentation technique pour configurer les autorisations et les étendues nécessaires.

Navigation étape par étape

Conseils et bonnes pratiques

• Environnement de test : Testez toujours votre intégration dans un environnement de test, si disponible, avant de la connecter à votre instance SchoolsBuddy en production.
• Opérations en masse : Avant de lancer des opérations d’écriture en masse, veuillez consulter attentivement la documentation technique afin de garantir l’intégrité des données.
• Gestion des identifiants : dans l’API Manager, vous pouvez modifier les autorisations, régénérer les identifiants ou désactiver/supprimer les clients afin de maintenir la sécurité.

Avertissements et notes importantes

Accès sécurisé : les identifiants API offrent un accès important aux données de votre établissement. Assurez-vous que seul le personnel autorisé dispose des droits d’administrateur principal pour gérer ces paramètres.

Partage public : Ne partagez jamais publiquement votre secret client ; ces identifiants sont liés de manière unique à votre instance SchoolsBuddy et vous donnent un accès direct à votre écosystème de données.

Articles connexes

• Présentation de l'API publique SchoolsBuddy

Foire aux questions

Que se passe-t-il si je perds mon secret client ?

Pour des raisons de sécurité, SchoolsBuddy ne réaffiche pas le secret client. Vous devrez utiliser l'API Manager pour régénérer les identifiants de ce client.

Puis-je limiter les fonctionnalités de l'API ?

Oui. Lors de la configuration, vous pouvez définir des autorisations et des étendues spécifiques pour n'accorder que l'accès en lecture (GET) ou en écriture (POST/PUT) nécessaire à cette intégration spécifique.

En résumé

• Accédez au gestionnaire d'API via les paramètres du gestionnaire d'API .
• Générez des identifiants en créant un nouveau client avec des autorisations spécifiques.
• Stockez les identifiants et secrets des clients en toute sécurité et ne les partagez jamais publiquement.

Votre intégration SchoolsBuddy est maintenant prête à commencer la synchronisation des données.