Authentifizierung
Der Reigniter API verwendet API Schlüssel. Jeder Schlüssel gehört einem Konto und fungiert als dieses Konto: Er gibt die Guthaben dieses Kontos aus und sieht nur die Aufgaben dieses Kontos.
Erstellen Sie einen Schlüssel
Abschnitt betitelt „Erstellen Sie einen Schlüssel“API Schlüssel sind Teil des Agency Plans.
- Melden Sie sich bei Reigniteran.
- Konto > API Schlüssel öffnen (
/app/account/api-keys). - Unter Neuen Schlüssel erstellen gibst du ein Label ein, das du später wiedererkennen wirst, wie
CI pipelineoderCMS sync. - Wählen Sie Erstellen.
- Kopieren Sie den Schlüssel sofort.
Ein Schlüssel sieht so aus: emp_ gefolgt von 64 hexadezimalen Zeichen.
Schick den Schlüssel
Abschnitt betitelt „Schick den Schlüssel“Fügen Sie den Schlüssel in den Authorization-Header als Bearer-Token bei jeder Anfrage ein:
curl https://reigniter.ai/v1/me \ -H "Authorization: Bearer $REIGNITER_API_KEY"Ein gültiger Schlüssel bringt 200 mit Ihrem Konto zurück:
{ "user_id": "3f1c2a9e-8b7d-4c1e-9f0a-2d6b5e4c3a21", "name": "Sam", "credits_remaining": 42}Wenn ein Schlüssel abgelehnt wird
Abschnitt betitelt „Wenn ein Schlüssel abgelehnt wird“| Status | code |
Bedeutung |
|---|---|---|
401 |
NO_API_KEY |
Kein Authorization Header, sonst beginnt der Token nicht mit emp_. |
401 |
INVALID_API_KEY |
Der Schlüssel ist unbekannt oder wurde widerrufen. |
402 |
PLAN_UPGRADE_REQUIRED |
Der Schlüssel ist gültig, aber das Konto ist nicht im Tarif Agency. |
403 |
ACCOUNT_SUSPENDED |
Das Konto, das den Schlüssel besitzt, wird gesperrt. |
Wenn ein Konto den Agency Plan verlässt, funktionieren seine Schlüssel nicht mehr, bis es wieder auf Agency ist.
Schlüssel geheim halten
Abschnitt betitelt „Schlüssel geheim halten“- Speichere Schlüssel in einem Secret-Manager oder in einer Umgebungsvariable. Binde sie niemals in die Versionskontrolle.
- Rufen Sie die API nur von Ihrem Server aus. Senden Sie niemals einen Schlüssel auf einer Webseite oder in einer mobilen App. Browseranfragen an die API sind laut der CORS-Richtlinie ohnehin nicht erlaubt.
- Verwende pro System einen Schlüssel mit einem klaren Etikett. Dann kannst du einen entziehen, ohne die anderen zu zerstören.
- Der Bildschirm mit den API Tasten zeigt, wann jede Taste zuletzt verwendet wurde. Ein Schlüssel, den Sie nicht erkennen, oder einer, der verwendet wurde, obwohl er es nicht sollte, sollte widerrufen werden.
Widerrufe einen Schlüssel
Abschnitt betitelt „Widerrufe einen Schlüssel“- Konto > API Schlüssel öffnen.
- Unter Active-Schlüssel finden Sie den Schlüssel anhand seines Labels.
- Wählen Sie das Symbol für den Widerruf-Schlüssel (Bin).
Ein widerrufener Schlüssel wird sofort mit 401 INVALID_API_KEY abgelehnt. Das Widerrufen kann nicht rückgängig gemacht werden. Bereits mit dem Schlüssel gestartete Renderings laufen weiterhin.