API-autentisering

Rivya API använder API-nycklar för server-till-server-åtkomst.

En API-nyckel är inte samma sak som en inloggningssession i webbläsaren. Använd inte cookies, Better Auth-sessionstillstånd eller en personlig webbläsartoken som offentlig API-legitimation.

Headerformat

Skicka nyckeln i Authorization-headern:

Authorization: Bearer rvya_sk_...

Den fullständiga nyckeln visas bara en gång när den skapas. Rivya lagrar en hash och ett synligt prefix, inte hela hemligheten.

Skapa en nyckel

1. Logga in på Rivya.
2. Öppna inställningar för API-nycklar.
3. Skapa en nyckel med de scopes du behöver.
4. Kopiera hela nyckeln direkt.
5. Spara den i en hemlighetshanterare på serversidan eller i en miljövariabel.

Lägg inte nyckeln i JavaScript på klientsidan, mobilappspaket, offentliga repo, analys-events eller loggar.

Aktuella scopes

Den första versionen dokumenterar dessa scopes:

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

Nya nycklar som skapas i Settings innehåller de dokumenterade scopes som standard. Äldre nycklar kan behöva skapas om innan Files API, API Webhooks eller Chat API används.

Återkalla och rotera

Om en nyckel exponeras:

1. Återkalla den gamla nyckeln från Settings.
2. Skapa en ny nyckel.
3. Uppdatera din serverhemlighet.
4. Bekräfta att den nya nyckeln fungerar med GET /api/v1/credits.
5. Ta bort den gamla nyckeln från byggsystem, loggar och distributionsvariabler.

Återkallade nycklar returnerar api_key_revoked.

Autentiseringsfel

Vanliga autentiseringsfel:

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

Se API-fel och gränser för hela den offentliga feltabellen.

Relaterade sidor

• API-snabbstart
• API-credits
• API-fel och gränser
• Autentisering och åtkomst i Rivya