Khóa API
Trên trang này
Khóa API cho phép phần mềm của riêng bạn — hoặc bất kỳ hệ thống bên thứ ba nào hỗ trợ BYOK (Bring Your Own Key) — sử dụng các mô hình do Performance Hub cung cấp. Khóa được quản lý trong Settings (bánh răng) → Service Access & API Keys. Bạn cần là Organisation Administrator để quản lý khóa.
*"Cấp khóa API để phần mềm và hệ thống của bên thứ ba hỗ trợ BYOK (Mang theo khóa của riêng bạn) có thể kết nối với các mô hình do Performance Hub công bố."*i
Hình 1: Danh sách khóa API: nhãn, khóa đã che, trạng thái, chi tiêu và giới hạn, mô hình, lần sử dụng gần nhất và các thao tác trên hàng
Danh sách khóa
| Cột | Ý nghĩa |
|---|---|
| Label | Tên tùy chọn mà bạn đặt cho khóa. |
| Key | Khóa đã che (ví dụ phk_7Qm2…Xa9LkP) — khóa bí mật đầy đủ không bao giờ được hiển thị lại sau khi tạo. |
| Status | Active, Provisioning… (trong thời gian ngắn, khi khóa mới đang được thiết lập) hoặc Disabled (đã thu hồi; hàng bị làm mờ). |
| Spend / limits | Chi tiêu trọn đời và tiến độ so với các giới hạn chi tiêu được đặt cho khóa. |
| Models | all, hoặc số lượng mô hình mà khóa bị giới hạn. |
| Last used | Thời điểm khóa thực hiện yêu cầu gần nhất. |
| Actions | Edit, Rotate, Revoke (hoặc Re-activate), Delete. |
Nếu bạn sử dụng Workflows, một hàng Workflows hiển thị Managed service thay cho khóa đã che. Khi hoàn toàn không có khóa nào, danh sách hiển thị "No API keys yet."
Tạo khóa
Nhấp vào Create key. Ngăn Create API key sẽ mở ra:
Hình 2: Ngăn Create API key: nhãn, loại kết nối, giới hạn chi tiêu, giới hạn tốc độ, giới hạn mô hình và ghi đè guardrail
| Cài đặt | Hoạt động |
|---|---|
| Label (optional) | Tên cho khóa, thường là hệ thống sử dụng khóa (ví dụ Hotel Concierge App, Clinic Intake Assistant hoặc Booking Website). Rất nên đặt — nhãn là cách mức sử dụng được phân bổ trong Activity và Logs. |
| Connection type | API key — "Generic API keys remain in the API Keys list." External agent — "External agents appear under Connected Services and use this key to authenticate." Được đặt khi tạo khóa; không thể thay đổi sau đó. |
| Set spend limits for this key | "Set any combination of daily, monthly and lifetime caps for this key." — Daily limit ("Resets at the start of each day (facility timezone)."), Monthly limit ("Resets on the 1st of each month (facility timezone).") và Lifetime cap ("Total spend over the lifetime of this key. Never resets."). |
| Rate limits (optional) | "Cap requests and tokens per minute for this key. Leave blank for unlimited." — Requests / min và Tokens / min. |
| Restrict models for this key | "Only the selected models will be usable with this key." Chọn từ các mô hình đã bật của cơ sở. |
| Override facility guardrails for this key | "Select none to explicitly disable guardrails for this key." Khi bật, khóa này sử dụng lựa chọn guardrail riêng thay vì lựa chọn của cơ sở — kể cả "none". Xem Guardrails. |
Nhấp vào Create key.
Khóa bí mật hiển thị một lần
Khóa mới chỉ được hiển thị một lần, trong hộp thoại Copy your API key:
Hình 3: Khóa mới chỉ được hiển thị một lần: hãy sao chép khóa trước khi đóng hộp thoại
*"Đây là lần duy nhất khóa đầy đủ được hiển thị. Hãy lưu trữ nó ở nơi an toàn."*i
Sao chép khóa vào trình quản lý bí mật của bạn trước khi nhấp vào Done. Sau khi hộp thoại này đóng, chỉ dạng đã che được hiển thị. Nếu bạn làm mất khóa bí mật, hãy Rotate khóa để nhận khóa mới.
Chỉnh sửa khóa
Nhấp vào hàng của khóa (hoặc biểu tượng bút chì Edit) để mở ngăn Configure API key — với các cài đặt giống như khi tạo (nhãn, giới hạn chi tiêu, giới hạn tốc độ, giới hạn mô hình, ghi đè guardrail):
Hình 4: Ngăn Configure API key
Các thay đổi có hiệu lực ngay sau khi lưu. Khi khóa có giới hạn hằng ngày/hằng tháng, hàng của khóa hiển thị mức sử dụng so với các giới hạn đó (Today, This month, Lifetime) và huy hiệu Limit reached khi đạt một giới hạn.
Vòng đời khóa: xoay vòng, thu hồi, xóa
Mỗi thao tác đều có hộp thoại xác nhận nêu chính xác điều sẽ xảy ra:
| Thao tác | Tác dụng | Nội dung xác nhận |
|---|---|---|
| Rotate | Cấp khóa bí mật mới (hiển thị một lần) với cùng cài đặt; khóa bí mật cũ ngừng hoạt động ngay lập tức. | "A new key will be issued and the current key will stop working immediately." "You will need to reconfigure any services still using the old key. This cannot be undone." |
| Revoke | Vô hiệu hóa khóa ngay lập tức, có thể khôi phục. | "This key will be disabled immediately and any services using it will stop working. You can re-activate it again later." |
| Re-activate | Khôi phục khóa đã thu hồi (cùng khóa bí mật). | Không có — chạy ngay lập tức. |
| Delete | Xóa vĩnh viễn khóa. | "This permanently deletes the key and any services using it will stop working. This cannot be undone." |
Hình 5: Xác nhận Delete API key
Nên dùng thao tác nào: xoay vòng khi nghi ngờ rò rỉ (dịch vụ giữ nguyên cài đặt và lịch sử — chỉ cần cập nhật khóa bí mật); thu hồi để tạm dừng một hệ thống; chỉ xóa khi tích hợp đã ngừng hẳn.
Kết nối bằng khóa
Thẻ Connecting to the API bên dưới danh sách khóa hiển thị URL cơ sở và một yêu cầu mẫu để sao chép và dán cho môi trường của bạn. Xem Kết nối ứng dụng của bạn để biết hướng dẫn nhanh đầy đủ với các ví dụ SDK và xử lý lỗi.