Erste Schritte
Authentifizierung
Nutzen Sie serverseitige API-Schlüssel für Produktintegrationen und Browser-Sitzungen für die Workspace-Verwaltung.
API-Schlüssel
Authentifizieren Sie Kunden-API-Anfragen mit Authorization: Bearer re_…. Schlüssel gehören zu genau einem Workspace und dürfen nie in Browser-, Mobile-, Desktop-, Template- oder E-Mail-Inhalte eingebettet werden.
Authorization: Bearer re_your_key_hereBrowser-Sitzungen
Das Dashboard verwendet ein HTTP-only-Sitzungs-Cookie, das sich widerrufen lässt. Änderungen an der Abrechnung sowie das Erstellen oder Widerrufen von API-Schlüsseln erfordern diese Browser-Sitzung und sind mit Bearer-Schlüsseln nicht möglich. Ein Bearer-Schlüssel kann denselben Konto-, Nutzungs- und Abrechnungsstatus über GET /account, Dashboard-Analytics über GET /analytics und Schlüssel-Metadaten (Name, Präfix, letzte Nutzung) über GET /keys lesen.
Rotation
- Erstellen Sie in einer authentifizierten Dashboard-Sitzung einen Ersatzschlüssel.
- Rollen Sie den Ersatzschlüssel in jedem aufrufenden Dienst aus.
- Prüfen Sie, dass der Traffic das neue Präfix verwendet.
- Widerrufen Sie den alten Schlüssel.
Fehlgeschlagene Authentifizierung
Fehlende, abgelaufene, widerrufene oder unbekannte Zugangsdaten liefern 401 im standardisierten Fehler-Envelope. Wiederholen Sie fehlgeschlagene Authentifizierungen nicht automatisch.
{
"error": {
"message": "Unauthorized — provide a valid API key or session",
"status": 401
}
}