Um eine bessere Verbindung mit Ihren bestehenden Tools und Prozessen herzustellen, bietet Workpath eine REST-basierte JSON-API. Typische Anwendungsfälle sind:
- Automatisches Aktualisieren von KPIs aus Ihrer internen BI-Datenbank oder ähnlichen Tools
- Regelmäßiges Abfragen aller Ziele, Key Results und Initiativen für Reporting-Zwecke
- Aufbau interner Dashboards (z. B. auf Team- oder Organisationsebene), die Ziele und deren Fortschritt anzeigen
- Automatisierung von Prozessen wie die Aktualisierung des Fortschritts bei Key Results
🚀 So erstellen Sie einen API-Client
Hinweis: Nur Administratoren können API-Clients erstellen.
- Klicken Sie unten links auf Einstellungen und dann auf Organisationseinstellungen.
- Wählen Sie links den Reiter API-Clients.
- Klicken Sie auf das blaue „+"-Symbol oder die graue Schaltfläche „API-Client erstellen".
- Geben Sie einen Namen ein.
- Wählen Sie eine Zugriffsebene:
- Nur-Lese-Zugriff – für Tools, die ausschließlich Daten abrufen (z. B. BI-Tools, Dashboards, Berichte)
- Vollzugriff – für Tools, die auch Daten schreiben oder löschen müssen
- Klicken Sie auf API-Client erstellen.
- Kopieren Sie den Token aus der Meldung unten rechts und speichern Sie ihn sicher.
⚙️ Zugriffsebenen
Beim Erstellen eines API-Clients können Sie jetzt zwischen zwei Zugriffsebenen wählen:
- Nur-Lese-Zugriff beschränkt den API-Client auf den reinen Datenabruf. Diese Option empfiehlt sich für BI-Tools, Dashboards und Reporting-Setups.
- Vollzugriff erlaubt das Lesen, Schreiben und Löschen von Daten über die API.
Alle bestehenden API-Clients wurden automatisch auf Vollzugriff gesetzt. Wenn Sie einen vorhandenen Client auf Nur-Lese-Zugriff umstellen möchten, müssen Sie ihn ersetzen: Löschen Sie den bestehenden API-Client in den Organisationseinstellungen (er wird damit sofort ungültig) und erstellen Sie anschließend einen neuen mit Nur-Lese-Zugriff.
❓ Häufige Fragen
F: Muss ich meine bestehenden API-Clients ersetzen? Nein. Bestehende Clients mit Vollzugriff funktionieren weiterhin wie gewohnt. Der Wechsel zu Nur-Lese-Zugriff ist optional, wird aber empfohlen, wenn Ihr Anwendungsfall ausschließlich Lesezugriff erfordert.
Für eine Übersicht aller verfügbaren Endpunkte, technische Spezifikationen und Anwendungsbeispiele konsultiere bitte unsere API-Dokumentation.
Fehlt dir ein Endpunkt oder hast du eine Idee? Schreib uns gerne an product@workpath.com – wir freuen uns immer über Feedback!