การยืนยันตัวตน API

Rivya API ใช้คีย์ API สำหรับการเข้าถึงระหว่างเซิร์ฟเวอร์

คีย์ API ไม่เหมือนกับเซสชันการเข้าสู่ระบบในเบราว์เซอร์ อย่าใช้คุกกี้ สถานะเซสชันของ Better Auth หรือโทเคนเบราว์เซอร์ส่วนตัวเป็นข้อมูลรับรองสำหรับ Public API

รูปแบบส่วนหัว

ส่งคีย์ในส่วนหัว 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

คีย์ใหม่ที่สร้างในการตั้งค่าจะมีขอบเขตสิทธิ์ที่ระบุไว้ตามค่าเริ่มต้น คีย์รุ่นเก่าอาจต้องสร้างใหม่ก่อนใช้ Files 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