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

API Keys

Tạo, sao chép, thu hồi khoá Sandbox và Production.

API key cho phép server của bạn gọi Core API. Màn API Keys có hai tab:

TabTiền tốKhi nào dùng được
Sandboxak_test_Ngay sau khi xác minh email
Productionak_live_Sau khi được duyệt Go-Live (trước đó tab hiển thị Môi trường Production đang bị khoá)

Tạo khoá

Chọn tab Sandbox hoặc Production, bấm Tạo khoá.

Điền:

  • Tên gợi nhớ — vd. Web Ecommerce Tích Hợp, giúp nhận ra khoá về sau.
  • Ứng dụng (App) — chọn App để khoá chỉ dùng cho App đó, hoặc Tất cả App (khi đó phải gửi app trong từng request).
  • Phạm vi quyền hạn (Scopes) — thường chỉ cần agent:process.

Bấm tạo. Hộp API Key của bạn hiện khoá đầy đủ — sao chép và lưu ngay. Sau khi đóng, khoá không hiển thị lại.

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

Danh sách khoá

Bảng hiển thị Tên khoá, Tiền tố nhận diện (vài ký tự đầu để nhận ra khoá), Quyền hạn, Tạo lúc, Dùng gần nhất.

Thu hồi khoá

Bấm Thu hồi khoá ở dòng tương ứng → xác nhận. Mọi lời gọi dùng khoá đó bị từ chối ngay lập tức — hãy cập nhật hệ thống sang khoá mới trước khi thu hồi.

Giữ an toàn cho khoá

  • Chỉ dùng khoá ở server; không đặt trong JavaScript trình duyệt hay app di động — dùng Voicebox cho phía người dùng.
  • Mỗi hệ thống một khoá; thu hồi khoá không còn dùng (xem cột Dùng gần nhất).
  • Nghi lộ khoá ⇒ thu hồi ngay và tạo khoá mới.

Hướng dẫn kỹ thuật: Xác thực & API key.

Sửa trang này trên GitLab

Trong trang này