Leitfaden zur Nutzung der FoxPlan-API

Überblick

Die FoxPlan-API ermöglicht es Entwicklern, die Projektmanagement-Funktionen in ihre Anwendungen zu integrieren, um Projektdaten abzurufen und zu verwalten.

Wichtiger Hinweis

Nutzung auf eigene Gefahr

„Die Nutzung der FoxPlan-API erfolgt auf eigene Gefahr. Da sämtliche Funktionen über die API verfügbar sind, können Sie Ihre Daten beschädigen, löschen oder korrumpieren." Es wird dringend empfohlen, zuerst in einer nicht produktiven Umgebung zu testen.

Auf die API-Dokumentation zugreifen

Eine vollständige Swagger-Dokumentation ist in FoxPlan unter Einstellungen > Arbeitsplatz > Tab API verfügbar, mit den detaillierten Endpoint-Spezifikationen für authentifizierte Benutzer.

Swagger-Dokumentation der FoxPlan-API

Erste Schritte: drei zentrale Etappen

1. Ein API-Konto anlegen

Legen Sie im Tab API ein API-Konto an, indem Sie einen Namen eingeben. Das System liefert eine Auth ID und einen Auth Token, die für die Authentifizierung kombiniert und Base64-kodiert werden müssen.

Tab API: Beschreibungsfeld und Schaltfläche „Add API account"

Popup mit Auth ID und Auth Token des angelegten API-Kontos

2. Berechtigungen zuweisen

Geben Sie diesem API-Konto spezifische Rollen (zum Beispiel Workspace Manager), um seine Rechte in der Anwendung festzulegen.

Zuweisung einer Rolle an das API-Konto per Drag & Drop im Tab Mitglied

3. Einen Access Token abrufen

Senden Sie eine Anfrage an https://app.fox-plan.com/api/auth mit Basic-Authentifizierung und Ihren Base64-kodierten Zugangsdaten. Die Antwort enthält ein id_token, das für die folgenden Aufrufe zu verwenden ist.

POST-Anfrage /api/auth in Postman, die das id_token zurückgibt

Format der API-Anfragen

Standard-Header:

Authorization: Bearer <id_token>

Beispiel-Endpoint:

GET https://app.fox-plan.com/api/vacations?email=prenom.nom@domaine.com

Klappen Sie in Swagger einen Endpoint auf und klicken Sie auf Try it out, um ihn direkt zu testen:

Endpoint GET /api/vacations in Swagger mit der Schaltfläche „Try it out"

Eingabe der Parameter und Schaltfläche „Execute" in Swagger

200-Antwort der API mit dem curl-Befehl und dem JSON-Body

Derselbe Aufruf kann aus einem Client wie Postman erfolgen, indem der Bearer <id_token> im Header Authorization übergeben wird:

Aufruf eines Endpoints mit dem Bearer Token in Postman

Bewährte Praktiken

Halten Sie die Richtlinien zur Ratenbegrenzung ein
Implementieren Sie eine vollständige Fehlerbehandlung
Bewahren Sie die API-Schlüssel sicher auf — niemals fest im Code hinterlegen

HTTP-Statuscodes

Code	Bedeutung
200	Erfolg
400	Ungültige Anfrage
401	Nicht authentifiziert
403	Verboten
404	Nicht gefunden
500	Serverfehler

Überblick​

Wichtiger Hinweis​

Auf die API-Dokumentation zugreifen​

Erste Schritte: drei zentrale Etappen​

1. Ein API-Konto anlegen​

2. Berechtigungen zuweisen​

3. Einen Access Token abrufen​

Format der API-Anfragen​

Bewährte Praktiken​

HTTP-Statuscodes​