L'API Teachworks est une interface de programmation d'applications qui vous permet d'accéder aux données de votre compte Teachworks afin de développer des intégrations et des logiciels personnalisés.
REMARQUE : L’accès à l’API est uniquement disponible pour les entreprises ayant souscrit aux abonnements « Growth » et « Premium ».
Activation de l'API
Cliquez sur « Compte », puis sur « Intégrations et modules complémentaires ».
Utilisez le champ « Recherche » en haut et saisissez « API ».
Basculez le bouton sur « Activé » pour activer l’API.
Usage
Une fois l'API activée, cliquez sur le lien « Paramètres ». Vous pouvez ensuite générer votre jeton d'API Teachworks en cliquant sur le bouton « Générer un jeton d'API ».
Vous utiliserez cette clé pour accéder à votre compte via l'API. Protégez-la comme un mot de passe et ne l'affichez sur aucune page web publique (elle doit être utilisée côté serveur pour les pages web accessibles au public).
Vous pouvez également cliquer sur le bouton « Créer un compte sandbox » si vous souhaitez créer un compte sandbox pour tester l’intégration de votre API avant de la connecter au compte de production de votre entreprise.
Documentation de l'API
Vous trouverez la documentation de notre API ici : Documentation de l’API Teachworks. Nous ajouterons prochainement des points de terminaison supplémentaires à l’API pour accéder à d’autres types de données et gérer les enregistrements.
Si vous êtes intéressé par un point de terminaison qui n'est pas actuellement disponible, veuillez nous contacter à l' adresse support@teachworks.com et nous étudierons la possibilité de l'ajouter.