API Key và xác thực
Tạo và quản lý API Key của AGTCloud, đồng thời cấu hình Header xác thực cần thiết cho API.
API Key xác thực danh tính của bạn khi gửi yêu cầu đến AGTCloud API. Hầu hết API sử dụng Bearer API Key; các giao thức tương thích như Anthropic Messages sử dụng Header xác thực riêng. Xem yêu cầu cụ thể trên trang Endpoint tương ứng.
| Cấu hình | Giá trị |
|---|---|
| Base URL | https://api.agtcloud.cn/v1 |
| Hầu hết API | Authorization: Bearer your-api-key |
| Anthropic Messages | x-api-key: your-api-key và anthropic-version: 2023-06-01 |
Tạo API Key
- Mở API Keys.
- Nhấp vào Tạo Khóa API.
- Sao chép và lưu API Key của bạn một cách an toàn.
Giữ API Key an toàn
Không hiển thị API Key đầy đủ trong ảnh chụp màn hình, lịch sử trò chuyện, phiếu hỗ trợ hoặc mã công khai. Nếu nghi ngờ khóa bị lộ, hãy vô hiệu hóa hoặc xóa khóa cũ và thêm token mới.
Sử dụng API Key
Xác thực Bearer
Sử dụng https://api.agtcloud.cn/v1 làm Base URL và thêm vào yêu cầu:
Authorization: Bearer your-api-keyBase URL được khuyến nghị đã bao gồm /v1. Không thêm /v1 lần nữa khi ghép địa chỉ yêu cầu, vì điều đó sẽ tạo đường dẫn sai.
Kiểm tra API Key
Yêu cầu danh sách mô hình khả dụng với API Key hiện tại để kiểm tra Base URL và cấu hình xác thực:
curl 'https://api.agtcloud.cn/v1/models' \
-H 'Authorization: Bearer your-api-key'Anthropic Messages
Khi gọi API tương thích Anthropic Messages, truyền API Key qua x-api-key và cung cấp anthropic-version bắt buộc:
x-api-key: your-api-key
anthropic-version: 2023-06-01Xem các yêu cầu đầy đủ tại Anthropic Messages.
Quản lý API Key
Trang API Keys cho phép bạn:
- Thêm token cho các môi trường hoặc ứng dụng khác nhau.
- Vô hiệu hóa token không còn sử dụng hoặc nghi ngờ đã bị lộ.
- Xóa token không còn cần thiết.
Cấu hình công cụ bên thứ ba
Khi cấu hình công cụ bên thứ ba sử dụng giao thức tương thích OpenAI, bạn thường cần điền:
| Mục cấu hình | Nội dung cần điền |
|---|---|
| API Host / Base URL | https://api.agtcloud.cn/v1 |
| API Key | API Key được tạo trong tài khoản hiện tại |
| Mô hình | ID mô hình khả dụng trên trang web và tài khoản hiện tại |
Bạn có thể lấy ID mô hình từ Danh mục mô hình. Xem cách cấu hình cụ thể tại Tích hợp bên thứ ba.
Quản lý an toàn
Dịch vụ production nên đọc API Key từ biến môi trường phía máy chủ hoặc dịch vụ quản lý bí mật:
export AGTCLOUD_API_KEY='your-api-key'- Không ghi API Key vào mã nguồn hoặc đưa vào hệ thống quản lý phiên bản.
- Không gửi API Key đến giao diện trình duyệt, gói cài đặt ứng dụng di động hoặc các ứng dụng khách không đáng tin cậy.
- Sử dụng API Key riêng cho môi trường phát triển, thử nghiệm và production.
- Nếu nghi ngờ API Key đã bị lộ, hãy vô hiệu hóa hoặc xóa khóa cũ ngay lập tức và thay bằng khóa mới.