Aivigo Hướng dẫn sử dụng

Xác thực & API key

Loại khoá, môi trường Sandbox/Production, phạm vi quyền và cách bảo vệ khoá.

Các loại khoá

KhoáDạngDùng ở đâuBí mật?
API key Sandboxak_test_…Server của bạn, giai đoạn thử nghiệmCó
API key Productionak_live_…Server của bạn, sau khi được duyệt Go-LiveCó
Khoá Voiceboxvb_…Trang web / app (thẻ script, WebView)Không — khoá công khai
Identity secretchuỗi ngẫu nhiênServer của bạn, để ký danh tính người dùngCó

Gửi API key

Mọi lời gọi Core API dùng header Authorization:

POST /api/v1/agent/process HTTP/1.1
Host: api.aivigo.tech
Authorization: Bearer ak_live_xxxxxxxxxxxxxxxx
Content-Type: application/json

Thiếu hoặc sai khoá ⇒ 401. Khoá đã thu hồi ⇒ 401 ngay lập tức.

Phạm vi quyền (scopes)

Chọn khi tạo khoá trên Cổng đối tác → API Keys:

ScopeCho phép
agent:processGọi /agent/process, đọc lịch sử phiên, lượng dùng của người dùng cuối
knowledge:readĐọc kho tri thức
admin:readĐọc cấu hình (App, agent…)

Cấp ít quyền nhất đủ dùng. Phần lớn tích hợp chỉ cần agent:process.

Khoá gắn App

Khi tạo khoá, bạn có thể chọn một Ứng dụng (App):

  • Gắn App — mọi lượt gọi tự thuộc App đó, không cần gửi trường app. Khuyến nghị.
  • Tất cả App — phải gửi "app": "<app_id>" trong từng request.

Sandbox và Production

SandboxProduction
Tiền tố khoáak_test_ak_live_
Điều kiệnCó ngay sau khi xác minh emailĐược Aivigo duyệt hồ sơ Go-Live
Hệ thống nghiệp vụMô phỏngHệ thống thật theo thoả thuận
Giới hạn60 lượt/phút, 2.000 lượt/ngàyTheo gói và cấu hình tenant

Bảo vệ khoá

  • Lưu khoá trong secret manager / biến môi trường của server; không commit vào git, không nhúng vào app di động hay JavaScript phía trình duyệt.
  • Mỗi môi trường / hệ thống một khoá riêng để thu hồi độc lập.
  • Nghi lộ khoá ⇒ Thu hồi khoá trên Cổng đối tác rồi tạo khoá mới.
  • Theo dõi cột Dùng gần nhất để phát hiện khoá không còn dùng và thu hồi.
Sửa trang này trên GitLab

Trong trang này