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

Rivya API ใช้ API key สำหรับการเข้าถึงแบบ server-to-server

API key ไม่เหมือนกับ session การล็อกอินในเบราว์เซอร์ อย่าใช้ cookies, สถานะ session ของ Better Auth หรือ token เบราว์เซอร์ส่วนตัวเป็นข้อมูลรับรองสำหรับ public API

รูปแบบ Header

ส่ง key ใน header Authorization:

Authorization: Bearer rvya_sk_...

key เต็มจะแสดงเพียงครั้งเดียวตอนสร้าง Rivya เก็บ hash และ prefix ที่มองเห็นได้ ไม่ได้เก็บ secret เต็ม

สร้าง Key

1. ล็อกอินเข้า Rivya

2. เปิด การตั้งค่า API Keys

3. สร้าง key พร้อม scopes ที่คุณต้องใช้

4. คัดลอก key เต็มทันที

5. เก็บไว้ใน secret manager ฝั่งเซิร์ฟเวอร์หรือตัวแปรสภาพแวดล้อม

อย่าใส่ key ไว้ใน JavaScript ฝั่ง client, bundle แอปมือถือ, repo สาธารณะ, analytics events หรือ logs

Scopes ปัจจุบัน

เวอร์ชันแรกระบุ scopes เหล่านี้:

• models:read

• generations:create

• generations:read

• files:create

• files:read

• credits:read

• webhooks:manage

• chat:create

• chat:read

key ใหม่ที่สร้างใน Settings จะมี scopes ที่ระบุไว้ตามค่าเริ่มต้น key รุ่นเก่าอาจต้องสร้างใหม่ก่อนใช้ Files API, API Webhooks หรือ Chat API

เพิกถอนและหมุนเวียน

ถ้า key ถูกเปิดเผย:

1. เพิกถอน key เก่าจาก Settings

2. สร้าง key ใหม่

3. อัปเดต secret ฝั่งเซิร์ฟเวอร์ของคุณ

4. ยืนยันว่า key ใหม่ทำงานได้ด้วย GET /api/v1/credits

5. ลบ key เก่าออกจากระบบ build, logs และตัวแปร deployment

key ที่ถูกเพิกถอนจะคืนค่า 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