Xác thực API

Rivya API dùng API keys cho truy cập server-to-server.

API key không giống phiên đăng nhập trên trình duyệt. Không dùng cookies, trạng thái phiên Better Auth hoặc token trình duyệt cá nhân làm thông tin xác thực API công khai.

Định dạng header

Gửi key trong header Authorization:

Authorization: Bearer rvya_sk_...

Key đầy đủ chỉ được hiển thị một lần khi tạo. Rivya lưu hash và prefix có thể nhìn thấy, không lưu secret đầy đủ.

Tạo key

1. Đăng nhập Rivya.
2. Mở cài đặt API Keys.
3. Tạo key với các scope bạn cần.
4. Sao chép key đầy đủ ngay lập tức.
5. Lưu key trong trình quản lý secret phía server hoặc biến môi trường.

Không đặt key trong JavaScript phía client, gói ứng dụng di động, repo công khai, sự kiện analytics hoặc log.

Scope hiện tại

Phiên bản đầu tiên ghi nhận các scope này:

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

Key mới được tạo trong Settings sẽ mặc định bao gồm các scope đã ghi trong tài liệu. Key cũ hơn có thể cần được tạo lại trước khi dùng Files API, API Webhooks hoặc Chat API.

Thu hồi và xoay vòng

Nếu một key bị lộ:

1. Thu hồi key cũ trong Settings.
2. Tạo key mới.
3. Cập nhật secret phía server.
4. Xác nhận key mới hoạt động với GET /api/v1/credits.
5. Xóa key cũ khỏi hệ thống build, log và biến triển khai.

Key đã bị thu hồi sẽ trả về api_key_revoked.

Lỗi xác thực

Các lỗi xác thực thường gặp:

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

Xem Lỗi và giới hạn API để có bảng lỗi công khai đầy đủ.

Trang liên quan

• Bắt đầu nhanh với Rivya API
• API Credits
• Lỗi và giới hạn API
• Xác thực và quyền truy cập trong Rivya