Uwierzytelnianie API

Rivya API używa kluczy API do dostępu server-to-server.

Klucz API nie jest tym samym co sesja logowania w przeglądarce. Nie używaj cookies, stanu sesji Better Auth ani osobistego tokena przeglądarki jako publicznego poświadczenia API.

Format Header

Wyślij klucz w headerze Authorization:

Authorization: Bearer rvya_sk_...

Pełny klucz jest pokazywany tylko raz podczas tworzenia. Rivya przechowuje hash i widoczny prefix, a nie pełny sekret.

Utwórz Klucz

1. Zaloguj się do Rivya.
2. Otwórz ustawienia API Keys.
3. Utwórz klucz z potrzebnymi scope.
4. Natychmiast skopiuj pełny klucz.
5. Zapisz go w menedżerze sekretów po stronie serwera albo zmiennej środowiskowej.

Nie umieszczaj klucza w JavaScript po stronie klienta, paczkach aplikacji mobilnych, publicznych repozytoriach, zdarzeniach analitycznych ani logach.

Bieżące Scope

Pierwsza wersja dokumentuje te scope:

• models:read
• generations:create
• generations:read
• files:create
• files:read
• credits:read
• webhooks:manage
• chat:create
• chat:read

Nowe klucze tworzone w Settings domyślnie zawierają udokumentowane scope. Starsze klucze mogą wymagać ponownego utworzenia przed użyciem Files API, API Webhooks albo Chat API.

Unieważnianie i Rotacja

Jeśli klucz został ujawniony:

1. Unieważnij stary klucz w Settings.
2. Utwórz nowy klucz.
3. Zaktualizuj sekret po stronie serwera.
4. Potwierdź, że nowy klucz działa z GET /api/v1/credits.
5. Usuń stary klucz z systemów build, logów i zmiennych wdrożeniowych.

Unieważnione klucze zwracają api_key_revoked.

Błędy Uwierzytelniania

Typowe błędy uwierzytelniania:

• api_key_missing
• api_key_invalid
• api_key_revoked
• api_key_expired
• api_scope_denied
• public_api_disabled

Pełną publiczną tabelę błędów znajdziesz w Błędy i limity API.

Powiązane Strony

• Szybki start Rivya API
• Kredyty API
• Błędy i limity API
• Uwierzytelnianie i dostęp w Rivya