API-Referenz

API-Einführung

Erste Schritte mit der Flowsery Analytics API

1. API-Schluessel erstellen

Gehen Sie zu Ihren Website-Einstellungen > API-Tab im Flowsery Analytics-Dashboard. Generieren Sie einen neuen API-Schluessel. Kopieren Sie ihn sofort, da er nicht erneut angezeigt wird. Behandeln Sie Ihre API-Schluessel wie Passwoerter -- speichern Sie sie sicher und geben Sie sie niemals in clientseitigem Code oder oeffentlichen Repositories preis. Alle Schluessel verwenden das Praefix <code>flow_</code> (z. B. <code>flow_sk_live_abc123</code>).

2. Anfragen authentifizieren

Jeder API-Aufruf muss den <code>Authorization</code>-Header mit dem Bearer-Schema enthalten. Ersetzen Sie <code>YOUR_API_KEY</code> durch den Schluessel, den Sie erstellt haben.

Authorization-Header
Authorization: Bearer YOUR_API_KEY

3. Anfragen stellen

Die Basis-URL fuer alle v1-Endpunkte lautet: <code>https://analytics.flowsery.com/api/v1/</code>

Antwortformat

Erfolgreiche Antworten geben den Status 200 OK mit einer wie folgt strukturierten Antwort zurueck:

Erfolgreiche Antwort
{
  "status": "success",
  "data": { ... }
}

Fehlerantworten geben den entsprechenden HTTP-Statuscode (4xx oder 5xx) mit folgendem Format zurueck:

Fehlerantwort
{
  "status": "error",
  "error": {
    "code": "HTTP_STATUS_CODE",
    "message": "A descriptive error message"
  }
}

Standard-Fehlercodes

<strong>400 Bad Request</strong> -- Die Eingabe ist ungueltig oder erforderliche Parameter fehlen.<br /><strong>401 Unauthorized</strong> -- Der API-Schluessel fehlt oder ist ungueltig.<br /><strong>404 Not Found</strong> -- Die angeforderte Ressource existiert nicht.<br /><strong>500 Internal Server Error</strong> -- Auf dem Server ist ein unerwartetes Problem aufgetreten.