Khóa API
Khóa API của nền tảng Ultralytics cho phép truy cập lập trình an toàn để huấn luyện, suy luận và tự động hóa từ xa. Tạo các khóa có phạm vi với các quyền cụ thể cho các trường hợp sử dụng khác nhau.
Tạo khóa API
Tạo khóa API mới:
- Vào Cài đặt > Khóa API
- Nhấp vào Tạo khóa
- Nhập tên cho khóa
- Chọn phạm vi quyền
- Nhấp vào Tạo
Tên khóa
Hãy đặt cho khóa của bạn một cái tên dễ hiểu:
training-server- Dành cho máy huấn luyện từ xaci-pipeline- Để tích hợp CI/CDmobile-app- Dành cho ứng dụng di động
Phạm vi quyền hạn
Chọn phạm vi để giới hạn quyền truy cập chính:
| Phạm vi | Quyền hạn |
|---|---|
| đào tạo | Bắt đầu huấn luyện, theo dõi số liệu. |
| mô hình | Tải lên, tải xuống, xóa mô hình |
| các bộ dữ liệu | Truy cập và chỉnh sửa tập dữ liệu |
| đọc | Chỉ được phép truy cập đọc vào tất cả các tài nguyên. |
| viết | Quyền ghi đầy đủ |
| quản trị viên | Quản lý tài khoản (sử dụng cẩn thận) |
Đặc quyền thấp nhất
Tạo khóa chỉ với các quyền cần thiết. Sử dụng các khóa riêng biệt cho các ứng dụng khác nhau.
Màn hình phím
Sau khi tạo, khóa sẽ được hiển thị một lần:
Sao chép khóa của bạn
Mã khóa đầy đủ chỉ được hiển thị một lần. Hãy sao chép ngay lập tức và lưu trữ an toàn. Bạn không thể khôi phục lại mã khóa này sau này.
Định dạng chính
Khóa API tuân theo định dạng sau:
ul_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0
- Tiền tố:
ul_xác định Ultralytics chìa khóa - Nội dung : 40 ký tự thập lục phân ngẫu nhiên
- Tổng cộng : 43 ký tự
Sử dụng khóa API
Biến môi trường
Đặt khóa của bạn làm biến môi trường:
export ULTRALYTICS_API_KEY="ul_your_key_here"
$env:ULTRALYTICS_API_KEY = "ul_your_key_here"
Trong mã
Sử dụng khóa trong của bạn Python kịch bản:
import os
# From environment (recommended)
api_key = os.environ.get("ULTRALYTICS_API_KEY")
# Or directly (not recommended for production)
api_key = "ul_your_key_here"
Tiêu đề HTTP
Bao gồm khóa trong các yêu cầu API:
curl -H "Authorization: Bearer ul_your_key_here" \
https://platform.ultralytics.com/api/...
Đào tạo từ xa
Kích hoạt tính năng truyền dữ liệu số liệu bằng khóa của bạn.
Yêu cầu phiên bản gói
Việc tích hợp nền tảng yêu cầu ultralytics bản >= 8.4.0 . Các phiên bản thấp hơn sẽ KHÔNG hoạt động với nền tảng.
pip install "ultralytics>=8.4.0"
export ULTRALYTICS_API_KEY="ul_your_key_here"
yolo train model=yolo11n.pt data=coco.yaml project=username/project name=exp1
Quản lý khóa
Xem các phím
Tất cả các khóa đều được liệt kê trong Cài đặt > Khóa API:
| Cột | Mô tả |
|---|---|
| Tên | Mã định danh chính |
| Phạm vi | Quyền được chỉ định |
| Tạo | Ngày tạo |
| Lần sử dụng cuối cùng | Lần sử dụng gần đây nhất |
Thu hồi khóa
Thu hồi khóa đã bị xâm phạm hoặc không còn cần thiết:
- Nhấp vào menu của phím
- Chọn Thu hồi
- Xác nhận thu hồi
Hiệu quả tức thì
Việc thu hồi có hiệu lực ngay lập tức. Mọi ứng dụng sử dụng khóa này sẽ ngừng hoạt động.
Tạo lại khóa
Nếu khóa bị xâm phạm:
- Tạo khóa mới với cùng phạm vi.
- Cập nhật ứng dụng của bạn
- Hủy bỏ khóa cũ
Các biện pháp bảo mật tốt nhất
LÀM
- Lưu trữ khóa trong các biến môi trường.
- Sử dụng các khóa riêng biệt cho các môi trường khác nhau.
- Thu hồi các khóa không sử dụng ngay lập tức.
- Sử dụng phạm vi tối thiểu cần thiết.
- Xoay chìa khóa định kỳ
Đừng
- Cam kết các khóa vào hệ thống kiểm soát phiên bản
- Chia sẻ khóa giữa các ứng dụng
- Sử dụng quyền quản trị viên một cách không cần thiết.
- Ghi nhật ký các khóa trong đầu ra ứng dụng
- Nhúng khóa vào mã phía máy khách
Xoay chìa khóa
Hãy xoay vòng khóa định kỳ để đảm bảo an ninh:
- Tạo khóa mới với cùng phạm vi.
- Cập nhật ứng dụng để sử dụng khóa mới
- Kiểm tra xem các ứng dụng có hoạt động chính xác hay không.
- Thu hồi khóa cũ
Lịch trình luân phiên
Hãy cân nhắc việc thay đổi khóa sau mỗi 90 ngày đối với các ứng dụng nhạy cảm.
Khắc phục sự cố
Lỗi khóa không hợp lệ
Error: Invalid API key
Giải pháp:
- Xác minh xem khóa đã được sao chép chính xác chưa.
- Kiểm tra xem khóa đã bị thu hồi chưa.
- Đảm bảo khóa có các phạm vi cần thiết.
- Xác nhận biến môi trường đã được thiết lập.
Quyền truy cập bị từ chối
Error: Permission denied for this operation
Giải pháp:
- Kiểm tra xem các phạm vi chính có bao gồm quyền cần thiết hay không.
- Hãy xác minh bạn là chủ sở hữu tài nguyên.
- Tạo khóa mới với phạm vi chính xác
Giới hạn tỷ lệ
Error: Rate limit exceeded
Giải pháp:
- Giảm tần suất yêu cầu
- Thực hiện lùi lũy thừa
- Liên hệ bộ phận hỗ trợ để tăng giới hạn.
Câu hỏi thường gặp
Tôi có thể tạo bao nhiêu khóa?
Không có giới hạn cứng nhắc nào về số lượng khóa API. Hãy tạo bao nhiêu khóa tùy thích cho các ứng dụng và môi trường khác nhau.
Mã khóa có hết hạn không?
Khóa không tự động hết hạn. Chúng vẫn có hiệu lực cho đến khi bị thu hồi. Hãy cân nhắc việc xoay vòng khóa để đảm bảo an toàn.
Tôi có thể xem khóa của mình sau khi tạo xong không?
Không, toàn bộ khóa chỉ được hiển thị một lần khi tạo. Nếu bị mất, hãy tạo khóa mới và hủy bỏ khóa cũ.
Các chìa khóa có dành riêng cho từng khu vực không?
Các khóa này có hiệu lực trên nhiều khu vực nhưng chỉ truy cập được dữ liệu trong khu vực tài khoản của bạn.
Tôi có thể chia sẻ khóa với các thành viên trong nhóm không?
Cách làm tốt hơn: Mỗi thành viên trong nhóm nên tự tạo khóa riêng. Điều này giúp:
- Theo dõi hoạt động cá nhân
- Thu hồi có chọn lọc
- Kiểm soát truy cập phù hợp