API-todennus

Rivya API käyttää API-avaimia palvelimelta palvelimelle tapahtuvaan käyttöön.

API-avain ei ole sama asia kuin selaimen kirjautumisistunto. Älä käytä evästeitä, Better Auth -istuntotilaa tai henkilökohtaista selaintokenia julkisena API-tunnisteena.

Header-muoto

Lähetä avain Authorization-headerissa:

Authorization: Bearer rvya_sk_...

Täysi avain näytetään vain kerran sen luonnin yhteydessä. Rivya tallentaa hashin ja näkyvän etuliitteen, ei koko salaisuutta.

Luo avain

1. Kirjaudu Rivyaan.

2. Avaa API-avainten asetukset.

3. Luo avain tarvitsemillasi käyttöoikeuksilla.

4. Kopioi koko avain heti.

5. Tallenna se palvelinpuolen salaisuuksien hallintaan tai ympäristömuuttujaan.

Älä sijoita avainta asiakaspuolen JavaScriptiin, mobiilisovelluspaketteihin, julkisiin repoihin, analytiikkatapahtumiin tai lokeihin.

Nykyiset käyttöoikeudet

Ensimmäinen versio määrittelee seuraavat käyttöoikeudet:

• models:read

• generations:create

• generations:read

• files:create

• files:read

• credits:read

• webhooks:manage

• chat:create

• chat:read

Asetuksissa luodut uudet avaimet sisältävät dokumentoidut käyttöoikeudet oletuksena. Vanhemmat avaimet voi joutua luomaan uudelleen ennen tiedosto-API:n, API-webhookien tai Chat API:n käyttöä.

Peru ja kierrätä

Jos avain paljastuu:

1. Peru vanha avain asetuksista.

2. Luo uusi avain.

3. Päivitä palvelinpuolen salaisuus.

4. Varmista, että uusi avain toimii pyynnöllä GET /api/v1/credits.

5. Poista vanha avain build-järjestelmistä, lokeista ja käyttöönoton muuttujista.

Perutut avaimet palauttavat virheen api_key_revoked.

Todennusvirheet

Yleisiä todennusvirheitä:

• api_key_missing

• api_key_invalid

• api_key_revoked

• api_key_expired

• api_scope_denied

• public_api_disabled

Katso koko julkinen virhetaulukko kohdasta API-virheet ja rajoitukset.

Liittyvät sivut

• API-pika-aloitus

• API-krediitit

• API-virheet ja rajoitukset

• Todennus ja pääsy Rivyassa