API-autentisering

Rivya API bruker API-nøkler for server-til-server-tilgang.

En API-nøkkel er ikke det samme som en nettleserinnloggingsøkt. Ikke bruk cookies, Better Auth-økttilstand eller en personlig nettlesertoken som offentlig API-legitimasjon.

Header-format

Send nøkkelen i Authorization-headeren:

Authorization: Bearer rvya_sk_...

Hele nøkkelen vises bare én gang når den opprettes. Rivya lagrer en hash og et synlig prefiks, ikke hele hemmeligheten.

Opprett en nøkkel

1. Logg inn på Rivya.
2. Åpne API Keys-innstillinger.
3. Opprett en nøkkel med scopene du trenger.
4. Kopier hele nøkkelen med en gang.
5. Lagre den i en hemmelighetsbehandler på serversiden eller som en miljøvariabel.

Ikke legg nøkkelen i klientbasert JavaScript, mobilapp-pakker, offentlige repositorier, analytics-hendelser eller logger.

Nåværende scopes

Den første versjonen dokumenterer disse scopene:

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

Nye nøkler som opprettes i Settings, inkluderer de dokumenterte scopene som standard. Eldre nøkler må kanskje opprettes på nytt før de kan brukes med Files API, API Webhooks eller Chat API.

Tilbakekall og roter

Hvis en nøkkel blir eksponert:

1. Tilbakekall den gamle nøkkelen fra Settings.
2. Opprett en ny nøkkel.
3. Oppdater hemmeligheten på serversiden.
4. Bekreft at den nye nøkkelen fungerer med GET /api/v1/credits.
5. Fjern den gamle nøkkelen fra byggsystemer, logger og distribusjonsvariabler.

Tilbakekalte nøkler returnerer api_key_revoked.

Autentiseringsfeil

Vanlige autentiseringsfeil:

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

Se API-feil og begrensninger for hele den offentlige feiltabellen.

Relaterte sider

• API-hurtigstart
• API-credits
• API-feil og begrensninger
• Autentisering og tilgang i Rivya