Zum Hauptinhalt springen

API-Übersicht

Willkommen bei der Exeoflow API-Dokumentation. Diese API ermöglicht es Ihnen, Exeoflow programmatisch zu steuern und in Ihre Anwendungen zu integrieren.

Basis-URL​

https://api.exeoflow.com/v1

Für On-Premises Installationen:

http://ihre-domain.com/api/v1

Authentifizierung​

Die Exeoflow API verwendet API-Keys für die Authentifizierung. Fügen Sie Ihren API-Key in den Header jeder Anfrage ein:

Authorization: Bearer IHR_API_KEY

API-Key erstellen​

  1. Melden Sie sich in Ihrem Exeoflow-Account an
  2. Navigieren Sie zu Einstellungen → API-Keys
  3. Klicken Sie auf "Neuer API-Key"
  4. Geben Sie einen Namen ein und wählen Sie die Berechtigungen
  5. Kopieren Sie den generierten Key (er wird nur einmal angezeigt)

Rate Limiting​

Die API ist rate-limited, um eine faire Nutzung zu gewährleisten:

  • Standard: 100 Anfragen pro Minute
  • Premium: 1000 Anfragen pro Minute
  • Enterprise: Individuell konfigurierbar

Rate-Limit-Informationen werden in den Response-Headern zurückgegeben:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

Datenformat​

Die API verwendet JSON für Request- und Response-Bodies.

Request-Header​

Content-Type: application/json
Accept: application/json
Authorization: Bearer IHR_API_KEY

Response-Format​

Erfolgreiche Antworten:

{
  "success": true,
  "data": {
    // Antwortdaten
  }
}

Fehlerantworten:

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Fehlerbeschreibung"
  }
}

HTTP-Statuscodes​

Die API verwendet Standard-HTTP-Statuscodes:

  • 200 OK: Anfrage erfolgreich
  • 201 Created: Ressource erfolgreich erstellt
  • 400 Bad Request: Ungültige Anfrage
  • 401 Unauthorized: Authentifizierung fehlgeschlagen
  • 403 Forbidden: Keine Berechtigung
  • 404 Not Found: Ressource nicht gefunden
  • 429 Too Many Requests: Rate-Limit überschritten
  • 500 Internal Server Error: Serverfehler

Versionierung​

Die API-Version ist Teil der URL. Die aktuelle Version ist v1.

Bei Breaking Changes wird eine neue Version veröffentlicht. Ältere Versionen werden für mindestens 12 Monate nach Veröffentlichung einer neuen Version unterstützt.

Nächste Schritte​