Uwierzytelnianie
Reigniter API używa API kluczy. Każdy klucz należy do jednego konta i pełni rolę tego konta: wydaje kredyty tego konta i widzi tylko jego zadania.
Stwórz klucz
Dział zatytułowany „Stwórz klucz”API klucze są częścią planu Agency.
- Zaloguj się do Reigniter.
- Otwórz klucze konta > API (
/app/account/api-keys). - W sekcji Utwórz nowy klucz wpisz etykietę, którą później rozpoznasz, na przykład
CI pipelinelubCMS sync. - Wybierz Create.
- Natychmiast skopiuj klucz.
Klucz wygląda tak: emp_ a następnie 64 znaki szesnastkowe.
Wyślij klucz
Dział zatytułowany „Wyślij klucz”Umieść klucz w nagłówku Authorization jako token Bearer przy każdym żądaniu:
curl https://reigniter.ai/v1/me \ -H "Authorization: Bearer $REIGNITER_API_KEY"Ważny klucz zwraca 200 z Twoim kontem:
{ "user_id": "3f1c2a9e-8b7d-4c1e-9f0a-2d6b5e4c3a21", "email": "dev@example.com", "name": "Sam", "credits_remaining": 42}Gdy klucz zostaje odrzucony
Dział zatytułowany „Gdy klucz zostaje odrzucony”| Status | code |
Znaczenie |
|---|---|---|
401 |
NO_API_KEY |
Brak nagłówka Authorization, bo token nie zaczyna się od emp_. |
401 |
INVALID_API_KEY |
Klucz jest nieznany lub został cofnięty. |
402 |
PLAN_UPGRADE_REQUIRED |
Klucz jest ważny, ale konto nie znajduje się na Agency planie. |
403 |
ACCOUNT_SUSPENDED |
Konto, które posiada klucz, zostaje zawieszone. |
Jeśli konto opuści plan Agency, jego klucze przestają działać, dopóki nie wróci do Agency.
Trzymaj klucze w tajemnicy
Dział zatytułowany „Trzymaj klucze w tajemnicy”- Przechowuj klucze w menedżerze sekretów lub zmiennej środowiskowej. Nigdy nie zatwierdzaj ich w kontroli wersji źródłowej.
- Dzwoń do API tylko z serwera. Nigdy nie wysyłaj klucza na stronie internetowej ani w aplikacji mobilnej. Żądania przeglądarki do API i tak nie są dozwolone przez politykę CORS.
- Używaj jednego klucza na system, z wyraźną etykietą. Wtedy możesz cofnąć jeden klucz, nie psując pozostałych.
- Ekran API klawiszy pokazuje, kiedy ostatnio użyto każdego klawisza. Klucz, którego nie rozpoznajesz, lub użyty, gdy nie powinieneś, powinien zostać cofnięty.
Cofnij klucz
Dział zatytułowany „Cofnij klucz”- Otwórz konto > API klucze.
- W sekcji Aktywne klucze znajdź klucz według jego etykiety.
- Wybierz ikonę klawisza Renule (bin).
Odwołany klucz jest odrzucany natychmiast 401 INVALID_API_KEY. Unieważnienia nie można cofnąć. Renderowania już rozpoczęte z kluczem nadal działają.