API کی توثیق

Rivya API ایک سرور سے دوسرے سرور تک رسائی کے لیے API کیز استعمال کرتی ہے۔

API کلید براؤزر کے لاگ اِن سیشن جیسی نہیں ہوتی۔ کوکیز، Better Auth سیشن کی حالت یا ذاتی براؤزر ٹوکن استعمال نہ کریں۔

ہیڈر کی ساخت

کلید کو Authorization سرنامے میں بھیجیں:

Authorization: Bearer rvya_sk_...

مکمل کلید صرف بناتے وقت ایک بار دکھائی جاتی ہے۔ Rivya مکمل راز کے بجائے ہیش اور دکھائی دینے والا سابقہ محفوظ کرتا ہے۔

کلید بنائیں

1. Rivya میں لاگ اِن کریں۔

2. ترتیبات میں API کلیدیں کھولیں۔

3. اپنی ضرورت کی اجازتوں کے ساتھ کلید بنائیں۔

4. پوری کلید فوراً نقل کر لیں۔

5. اسے سرور کے راز محفوظ کرنے والے نظام یا ماحولیاتی متغیر میں رکھیں۔

کلید کو صارف کے براؤزر میں چلنے والے JavaScript، موبائل ایپ کے مجموعے، عوامی کوڈ ذخیرے، تجزیاتی واقعات یا ریکارڈ میں شامل نہ کریں۔

موجودہ دائرۂ اختیار

پہلا نسخہ اجازت کے یہ دائرے درج کرتا ہے:

• models:read

• generations:create

• generations:read

• files:create

• files:read

• credits:read

• webhooks:manage

• chat:create

• chat:read

ترتیبات میں بنائی گئی نئی کلیدیں درج شدہ اجازتیں بطورِ طے شدہ شامل کرتی ہیں۔ پرانی کلیدوں کو فائلز API، API Webhooks یا Chat API استعمال کرنے سے پہلے دوبارہ بنانا پڑ سکتا ہے۔

رسائی منسوخ کریں اور کلید تبدیل کریں

اگر کلید ظاہر ہو جائے:

1. ترتیبات میں پرانی کلید منسوخ کریں۔

2. نئی کلید بنائیں۔

3. سرور پر محفوظ راز تبدیل کریں۔

4. تصدیق کریں کہ نئی کلید GET /api/v1/credits کے ساتھ کام کرتی ہے۔

5. پرانی کلید کو تعمیراتی نظام، ریکارڈ اور تنصیب کے متغیرات سے ہٹا دیں۔

منسوخ کلیدیں api_key_revoked واپس کرتی ہیں۔

توثیق کی خرابیاں

توثیق کی عام خرابیاں:

• api_key_missing

• api_key_invalid

• api_key_revoked

• api_key_expired

• api_scope_denied

• public_api_disabled

عوامی خرابیوں کی مکمل جدول کے لیے API کی خرابیاں اور حدود دیکھیں۔

متعلقہ صفحات

• API کا فوری آغاز

• API کریڈٹس

• API کی خرابیاں اور حدود

• Rivya میں توثیق اور رسائی