Tài liệu

API key

API key xác thực các tích hợp machine-to-machine đã được phê duyệt. Public Deployment Configure Embed tích hợp sẵn không dùng organization API key trong trình duyệt; nó đổi publish/embed identity lấy guest session bị giới hạn. Nếu chỉ dùng chat hoặc widget tích hợp sẵn, không tạo key cho mục đích đó.

1

Mở API Keys

Truy cập Console → Tổ chức của bạn → API Keys ở thanh bên trái.

Màn hình API Keys liệt kê các key kèm public key, scope, trạng thái, lần dùng cuối và ngày tạo
Mỗi key hiển thị scope và đã từng được dùng hay chưa.
2

Tạo key

Nhấn Create API Key (góc trên bên phải). Hộp thoại mở ra — nhập Tên (Name) tùy chọn (ví dụ: "Môi trường Production") để nhận biết sau này, sau đó nhấn Create.

Hộp thoại Create API Key với tên đã nhập
Tên chỉ là nhãn cho bạn; nó không ảnh hưởng tới quyền của key.
3

Lưu ngay key và secret

Màn hình "API Key created" chỉ hiển thị duy nhất một lần. Màn hình này hiển thị cả API Key (dạng: sota_ek_…) và API Secret. Hãy sao chép cả hai ngay bây giờ và lưu trữ an toàn — bạn không thể lấy lại secret sau khi đóng màn hình này.

Hộp thoại hiện một lần sau khi tạo, với API key, secret đã che và cảnh báo secret sẽ không hiện lại
Secret chỉ hiện một lần. Hãy copy trước khi đóng hộp thoại.
4

Xác nhận và đóng

Sau khi lưu, nhấn I have saved the Secret để đóng hộp thoại.

5

Sử dụng key trong lời gọi API

API key được dùng để nhúng SotaAgents vào các sản phẩm bên ngoài hoặc tích hợp với các hệ thống nội bộ. Công dụng chính là ký handshake cấp ticket — xem Nhúng SotaAgents vào hệ thống nội bộ. Với widget công khai cho khách ẩn danh, hãy dùng Workspace → Configure Embed.

6

Vô hiệu hóa key

Để ngừng sử dụng một key mà không xóa nó, nhấp vào nút Actions trên dòng tương ứng và chọn Disable. Xác nhận trong hộp thoại. Key dừng hoạt động ngay lập tức và vẫn hiển thị ở trạng thái bị vô hiệu hóa trong danh sách.

Bảo mật API key

Tuyệt đối không đưa API key vào mã nguồn (source control) hoặc chia sẻ trong tin nhắn. Hãy bảo vệ key như mật khẩu. Nếu key bị lộ, hãy vô hiệu hóa ngay và tạo key mới.

Mục lục

Esc

Tìm theo tiêu đề và nội dung trong mọi chương.