Authentifizierung

Jede Anfrage an die SubscribeFlow API erfordert einen API-Key.

API-Key-Format

Präfix	Umgebung	Zweck
`sf_live_`	Produktion	Echte Subscriber, echte E-Mails
`sf_test_`	Test	Sandbox-Daten, keine E-Mails gesendet

Erstellen Sie Keys im Dashboard unter Einstellungen > API Keys.

Warning

API-Keys werden nur einmal bei der Erstellung angezeigt. Speichern Sie sie sicher -- Sie können sie später nicht abrufen.

API-Key senden

Fügen Sie den Key in jede Anfrage über einen dieser Header ein:

X-API-Key HeaderAuthorization Header

X-API-Key: sf_live_...

Authorization: Bearer sf_live_...

Beispiel einer authentifizierten Anfrage

PythonTypeScriptcURL

from subscribeflow import SubscribeFlowClient

async with SubscribeFlowClient(api_key="sf_live_...") as client:
    subscribers = await client.subscribers.list(limit=10)

import { SubscribeFlowClient } from '@subscribeflow/sdk';

const client = new SubscribeFlowClient({
  apiKey: 'sf_live_...',
});

const { items } = await client.subscribers.list({ limit: 10 });

curl https://api.subscribeflow.net/api/v1/subscribers?limit=10 \
  -H "X-API-Key: sf_live_..."

Berechtigungen (Scopes)

Jeder API-Key kann auf bestimmte Scopes eingeschränkt werden. Ohne gesetzte Scopes hat der Key vollen Zugriff.

Scope	Beschreibung
`subscribers:read`	Subscriber auflisten und abrufen
`subscribers:write`	Subscriber erstellen und aktualisieren
`subscribers:delete`	Subscriber löschen
`tags:read`	Tags auflisten und abrufen
`tags:write`	Tags erstellen, aktualisieren und löschen
`templates:read`	E-Mail-Templates auflisten und abrufen
`templates:write`	Templates erstellen, aktualisieren und löschen
`emails:send`	Transaktionale E-Mails senden
`campaigns:read`	Campaigns auflisten und abrufen
`campaigns:write`	Campaigns erstellen, aktualisieren, senden und abbrechen
`triggers:read`	E-Mail-Triggers auflisten und abrufen
`triggers:write`	Triggers erstellen, aktualisieren und löschen
`webhooks:manage`	Webhooks erstellen, aktualisieren, löschen und testen
`api-keys:manage`	API-Keys erstellen und widerrufen

Tip

Folgen Sie dem Prinzip der minimalen Berechtigung. Ein Key, der nur E-Mails sendet, sollte ausschließlich den Scope emails:send haben.

Rate Limits

Alle API-Keys sind auf 1.000 Anfragen pro Minute begrenzt. Bei Überschreitung gibt die API HTTP 429 Too Many Requests mit einem Retry-After-Header zurück, der die Wartezeit in Sekunden angibt.

PythonTypeScriptcURL

from subscribeflow import RateLimitError

try:
    await client.subscribers.list()
except RateLimitError:
    print("Rate Limit erreicht -- warten und erneut versuchen")

import { SubscribeFlowError } from '@subscribeflow/sdk';

try {
  await client.subscribers.list();
} catch (error) {
  if (error instanceof SubscribeFlowError && error.status === 429) {
    console.log('Rate Limit erreicht -- warten und erneut versuchen');
  }
}

# Rate-Limit-Header in der Antwort pruefen:
# X-RateLimit-Limit: 1000
# X-RateLimit-Remaining: 998
# X-RateLimit-Reset: 1710000060