API-hitelesítés

A Rivya API API-kulcsokat használ szerver-szerver hozzáféréshez.

Az API-kulcs nem ugyanaz, mint egy böngészős bejelentkezési munkamenet. Ne használj cookie-kat, Better Auth munkamenetállapotot vagy személyes böngészőtokent nyilvános API hitelesítő adatként.

Header formátum

A kulcsot az Authorization headerben küldd:

Authorization: Bearer rvya_sk_...

A teljes kulcs csak egyszer látható a létrehozásakor. A Rivya hash-t és látható prefixet tárol, nem a teljes titkot.

Kulcs létrehozása

1. Jelentkezz be a Rivyába.
2. Nyisd meg az API-kulcs beállításokat.
3. Hozz létre kulcsot a szükséges scope-okkal.
4. Azonnal másold ki a teljes kulcsot.
5. Tárold szerveroldali titokkezelőben vagy környezeti változóban.

Ne tedd a kulcsot kliensoldali JavaScriptbe, mobilalkalmazás-csomagokba, nyilvános repókba, analitikai eseményekbe vagy logokba.

Jelenlegi scope-ok

Az első verzió ezeket a scope-okat dokumentálja:

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

A Beállításokban létrehozott új kulcsok alapértelmezés szerint tartalmazzák a dokumentált scope-okat. Régebbi kulcsokat lehet, hogy újra kell létrehozni a Files API, API Webhooks vagy Chat API használata előtt.

Visszavonás és rotáció

Ha egy kulcs kiszivárog:

1. Vond vissza a régi kulcsot a Beállításokban.
2. Hozz létre új kulcsot.
3. Frissítsd a szerveroldali titkot.
4. Erősítsd meg, hogy az új kulcs működik a GET /api/v1/credits kéréssel.
5. Távolítsd el a régi kulcsot a buildrendszerekből, logokból és deploy változókból.

A visszavont kulcsok api_key_revoked választ adnak.

Hitelesítési hibák

Gyakori hitelesítési hibák:

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

A teljes nyilvános hibatáblázatért lásd az API hibák és limitek oldalt.

Kapcsolódó oldalak

• API gyorskezdés
• API kreditek
• API hibák és limitek
• Hitelesítés és hozzáférés a Rivyában