Technische Dokumentation: alle aktuellen API-Routen, Berechtigungen und Beispiele findest du unter docs.fitsociety.io. Beginne als Entwickler mit dem Public API-Schnellstart.
Arbeitest du mit einem externen Entwickler zusammen? Vereinbart vorher, welches System angebunden wird, welche Daten nötig sind, welche Aktionen die Verbindung ausführen darf und wer sie verwaltet. Lass den Administrator den Client im richtigen Unternehmen erstellen. Gib deinem Entwickler den Dokumentationslink und nur die nötigen Verbindungsdaten über einen sicheren Kanal. Teile nicht dein Coach-Passwort. Nutze einen eigenen Client je Integration, damit du den Zugriff später gezielt widerrufen kannst.
Ein API-Client ist der Zugang für eine externe Integration innerhalb deines Unternehmens. Ein berechtigter Administrator legt ihn an. Dein Entwickler richtet die Verbindung technisch mit Client-ID und Client-Secret ein.
In diesem Artikel
1. Einen API-Client erstellen
Wähle im Coach-Dashboard das richtige Unternehmen.
Gehe zu Einstellungen → Plugins und Integrationen → Public API.
Öffne OAuth clients und wähle Add API client.
Vergib einen erkennbaren Namen, etwa „CRM-Integration“, und prüfe die ausgewählten Scopes.
Erteile nur die für diese Integration erforderlichen Datenzustimmungen und wähle Create client.
Kopiere die Client-ID und das einmalig angezeigte Client-Secret. Bewahre sie sicher auf und übermittle sie deinem Entwickler auf sicherem Weg.
Verwende einen eigenen Client pro Integration. Teile kein Coach-Passwort und schreibe Secrets nicht in eine Supportnachricht oder in öffentlichen Code.
2. Nur benötigte Rechte auswählen
Scopes bestimmen, was die Integration darf. clients:read erlaubt beispielsweise das Lesen von Klientendaten; clients:write gibt Zugriff auf unterstützte Schreibaktionen. Prüfe die Vorauswahl: Reiner Lesezugriff ist nicht automatisch für jede neue Integration eingestellt.
Gesundheitsdaten und private Kommunikation erfordern eine zusätzliche, ausdrückliche Zustimmung. Für unternehmensweite Statusautomatisierung gibt es eigene Rechte: client_status_automation:read und client_status_automation:write. Das Recht, nur Klienten zu ändern, umfasst diese letzte Berechtigung nicht.
Die Rechte bestehender API-Clients werden nicht automatisch erweitert. Möchtest du andere Scopes verwenden? Erstelle in diesem Bildschirm einen neuen Client mit den gewünschten Rechten, lass den Entwickler umstellen und widerrufe danach den alten Client.
3. Die Verbindung prüfen lassen
Der Entwickler tauscht die Zugangsdaten per OAuth gegen ein temporäres Zugriffstoken. Dieses Token ist eine Stunde gültig. Beginne gemäß dem technischen Schnellstart mit einem Leseaufruf, zum Beispiel zum Profil des API-Clients.
Für die öffentliche API gibt es keine separate Sandbox. Schreibaktionen wirken sich auf echte Unternehmensdaten aus. Prüft gemeinsam zuerst einen vereinbarten Workflow, bevor du weitere Aktionen automatisierst.
4. Erneuern, widerrufen oder einen Fehler beheben
Rotate secret: Verwende dies, wenn das Secret verloren gegangen oder offengelegt worden ist. Die alten Zugangsdaten und aktiven Zugriffstokens werden ungültig; aktualisiere die Integration sofort.
Revoke: Stoppt diesen API-Client und macht die aktiven Tokens ungültig. Das lässt sich nicht rückgängig machen; für eine neue Verbindung erstellst du einen neuen Client.
401: Lass Token und Zugangsdaten prüfen.
403: Prüfe Scopes, Datenzustimmung und den Zugriff des Unternehmens.
429: Die Integration sendet zu viele Anfragen; der Entwickler muss die Wartezeit beachten.
Brauchst du Hilfe? Teile dem Support den Fehlercode, den Zeitpunkt und gegebenenfalls die Request-ID mit, ohne Secrets oder Zugriffstokens.
Weiterlesen
Technische Dokumentation für deinen Entwickler (Englisch)