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 để đào tạo từ xa, suy luận và tự động hóa. 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:

1. Truy cập Cài đặt > Khóa API
2. Nhấp vào Tạo Khóa
3. Nhập tên cho khóa
4. Chọn phạm vi quyền
5. Nhấp vào Tạo

Tên Khóa

Đặt tên mô tả cho khóa của bạn:

• training-server - Dành cho máy đào tạo từ xa
• ci-pipeline - Dành cho tích hợp CI/CD
• mobile-app - Dành cho ứng dụng di động

Phạm vi Quyền

Chọn phạm vi để giới hạn quyền của khóa:

Hiển thị Khóa

Sau khi tạo, khóa được hiển thị một lần:

Định dạng Khóa

Khóa API có định dạng như sau:

ul_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0

• Tiền tố: ul_ xác định các khóa Ultralytics
• Phần thân: 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ác tập lệnh python của 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/...

Huấn luyện từ xa

Bật tính năng truyền phát số liệu bằng khóa của bạn.

pip install "ultralytics>=8.4.0"

export ULTRALYTICS_API_KEY="ul_your_key_here"
yolo train model=yolo26n.pt data=coco.yaml project=username/project name=exp1

Quản lý Khóa

Xem Khóa

Tất cả các khóa được liệt kê trong Cài đặt > Khóa API:

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:

1. Nhấp vào menu của khóa
2. Chọn Thu hồi
3. Xác nhận thu hồi

Tạo lại Khóa

Nếu một khóa bị lộ:

1. Tạo khóa mới với cùng phạm vi
2. Cập nhật các ứng dụng của bạn
3. Thu hồi khóa cũ

Các Thực hành Tốt nhất về Bảo mật

Nên làm

• Lưu trữ khóa trong 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 kịp thời các khóa không sử dụng
• Sử dụng phạm vi tối thiểu cần thiết
• Xoay vòng khóa định kỳ

Không nên làm

• Đưa 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 phạm vi quản trị không cần thiết
• Ghi khóa trong đầu ra ứng dụng
• Nhúng khóa vào mã phía máy khách

Xoay vòng Khóa

Xoay vòng khóa định kỳ để đảm bảo bảo mật:

1. Tạo khóa mới với cùng phạm vi
2. Cập nhật các ứng dụng để sử dụng khóa mới
3. Xác minh các ứng dụng hoạt động chính xác
4. Thu hồi khóa cũ

Khắc phục sự cố

Lỗi Khóa Không Hợp lệ

Error: Invalid API key

Giải pháp:

1. Xác minh khóa được sao chép chính xác
2. Kiểm tra khóa chưa bị thu hồi
3. Đảm bảo khóa có các phạm vi cần thiết
4. Xác nhận biến môi trường đã được thiết lập

Quyền bị Từ chối

Error: Permission denied for this operation

Giải pháp:

1. Kiểm tra phạm vi của khóa bao gồm quyền cần thiết
2. Xác minh bạn là chủ sở hữu tài nguyên
3. Tạo khóa mới với các phạm vi chính xác

Giới hạn Tốc độ

Error: Rate limit exceeded

Giải pháp:

1. Giảm tần suất yêu cầu
2. Triển khai cơ chế lùi lũy thừa
3. 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 về số lượng khóa API. Bạn có thể tạo bao nhiêu khóa tùy theo nhu cầu cho các ứng dụng và môi trường khác nhau.

Khóa có hết hạn không?

Các 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 triển khai xoay vòng khóa để đảm bảo an ninh.

Tôi có thể xem khóa của mình sau khi tạo không?

Không, khóa đầy đủ chỉ được hiển thị một lần duy nhất khi tạo. Nếu bị mất, hãy tạo khóa mới và thu hồi khóa cũ.

Khóa có dành riêng cho từng khu vực không?

Các khóa hoạt động trên nhiều khu vực nhưng chỉ truy cập dữ liệu trong khu vực của 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?

Thực hành tốt hơn: Mỗi thành viên trong nhóm nên tạo khóa riêng của họ. Điều này cho phép:

• Theo dõi hoạt động cá nhân
• Thu hồi chọn lọc
• Kiểm soát truy cập phù hợp

📅 Được tạo 20 ngày trước ✏️ Cập nhật 19 ngày trước

Bình luận