API Kimlik Doğrulaması

Rivya API, sunucudan sunucuya erişim için API anahtarları kullanır.

API anahtarı tarayıcı oturumuyla aynı şey değildir. Cookie, Better Auth oturum durumu veya kişisel tarayıcı token'ını herkese açık API kimlik bilgisi olarak kullanmayın.

Header Biçimi

Anahtarı Authorization header içinde gönderin:

Authorization: Bearer rvya_sk_...

Tam anahtar yalnızca oluşturulduğu anda bir kez gösterilir. Rivya tam gizli anahtarı değil, hash değerini ve görünür prefix değerini saklar.

Anahtar Oluşturma

1. Rivya'da oturum açın.
2. API Keys ayarlarını açın.
3. İhtiyacınız olan scope değerleriyle bir anahtar oluşturun.
4. Tam anahtarı hemen kopyalayın.
5. Sunucu tarafı secret manager içinde veya ortam değişkeninde saklayın.

Anahtarı istemci tarafı JavaScript'e, mobil uygulama paketlerine, herkese açık repolara, analytics olaylarına veya loglara koymayın.

Geçerli Scope Değerleri

İlk sürüm şu scope değerlerini belgeler:

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

Settings içinde oluşturulan yeni anahtarlar belgelenen scope değerlerini varsayılan olarak içerir. Daha eski anahtarların Files API, API Webhooks veya Chat API kullanmadan önce yeniden oluşturulması gerekebilir.

İptal ve Rotasyon

Bir anahtar açığa çıkarsa:

1. Eski anahtarı Settings içinden iptal edin.
2. Yeni bir anahtar oluşturun.
3. Sunucu tarafı gizli anahtarınızı güncelleyin.
4. Yeni anahtarın GET /api/v1/credits ile çalıştığını doğrulayın.
5. Eski anahtarı build sistemlerinden, loglardan ve dağıtım değişkenlerinden kaldırın.

İptal edilen anahtarlar api_key_revoked döndürür.

Kimlik Doğrulama Hataları

Yaygın kimlik doğrulama hataları:

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

Tam herkese açık hata tablosu için API Hataları ve Limitler sayfasına bakın.

İlgili Sayfalar

• API Hızlı Başlangıç
• API Kredileri
• API Hataları ve Limitler
• Rivya'da Kimlik Doğrulama ve Erişim