Die Teachworks API ist eine Anwendungsprogrammierschnittstelle, die es Ihnen ermöglicht, auf die Daten in Ihrem Teachworks-Konto zuzugreifen, um benutzerdefinierte Integrationen und Software zu entwickeln.
HINWEIS: Der API-Zugriff ist nur für Unternehmen mit den Abonnements „Growth“ und „Premium“ verfügbar.
Aktivierung der API
Klicken Sie auf „Konto“ und anschließend auf „Integrationen & Add-ons“.
Verwenden Sie das Suchfeld oben und geben Sie „API“ ein.
Schalten Sie den Schalter auf „Ein“, um die API zu aktivieren.
Verwendung
Nachdem Sie die API aktiviert haben, können Sie auf den Link „Einstellungen“ klicken. Sie können Ihr Teachworks-API-Token generieren, indem Sie auf die Schaltfläche „API-Token generieren“ klicken.
Sie benötigen diesen Schlüssel, um über die API auf Ihr Konto zuzugreifen. Schützen Sie diesen Schlüssel wie ein Passwort und geben Sie ihn nicht auf öffentlichen Webseiten an (er sollte serverseitig für öffentlich zugängliche Webseiten verwendet werden).
Sie können auch auf die Schaltfläche „Sandbox-Konto erstellen“ klicken, wenn Sie ein Sandbox-Konto zum Testen Ihrer API-Integration erstellen möchten, bevor Sie diese mit dem Live-Konto Ihres Unternehmens verbinden.
API-Dokumentation
Die Dokumentation unserer API finden Sie hier: Teachworks API-Dokumentation. Wir werden die API um weitere Endpunkte erweitern, um auf zusätzliche Datentypen zuzugreifen und Datensätze zu verwalten.
Wenn Sie an einem Endpunkt interessiert sind, der derzeit nicht verfügbar ist, kontaktieren Sie uns bitte unter support@teachworks.com. Wir werden dann prüfen, ob wir ihn hinzufügen können.