Link to this sectionAPI Keys#

Các API key của Ultralytics Platform cho phép truy cập theo lập trình an toàn cho việc huấn luyện từ xa, suy luận và tự động hóa. Tạo các key có đặt tên với mã hóa AES-256-GCM cho các trường hợp sử dụng khác nhau.

Link to this sectionTạo API Key#

Tạo một API key mới:

1. Đi tới Settings > API Keys
2. Nhấp vào Create Key
3. Nhập tên cho key (ví dụ: "Training Server")
4. Nhấp vào Create Key

Link to this sectionTên Key#

Đặt cho key của bạn một cái tên mang tính mô tả:

• training-server - Dành cho các máy huấn luyện từ xa
• ci-pipeline - Dành cho tích hợp CI/CD
• local-dev - Dành cho phát triển cục bộ

Link to this sectionHiển thị Key#

Sau khi tạo, key sẽ được hiển thị một lần duy nhất:

Link to this sectionĐịnh dạng Key#

Các API key tuân theo định dạng sau:

• Tiền tố: ul_ định danh các key củ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ự

Link to this sectionBảo mật Key#

• Các key được lưu trữ với mã hóa AES-256-GCM
• Xác thực sử dụng hàm băm SHA-256 để tra cứu chỉ mục nhanh chóng
• Giá trị key đầy đủ không bao giờ được lưu trữ ở dạng văn bản thuần

Link to this sectionSử dụng API Keys#

Link to this sectionBiến môi trường#

Thiết lập key của bạn dưới dạng biến môi trường:

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

Link to this sectionYOLO CLI#

Thiết lập key bằng YOLO CLI:

yolo settings api_key="YOUR_API_KEY"

Link to this sectionTrong mã nguồn#

Sử dụng key 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 = "YOUR_API_KEY"

Link to this sectionTiêu đề HTTP#

Bao gồm key trong các yêu cầu API:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://platform.ultralytics.com/api/...

Xem Tài liệu tham khảo REST API để biết tất cả các endpoint khả dụng.

Link to this sectionHuấn luyện từ xa (Remote Training)#

Bật tính năng truyền phát số liệu (metric streaming) bằng key của bạn.

pip install "ultralytics>=8.4.60"

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

Xem Huấn luyện trên Đám mây để biết hướng dẫn đầy đủ về huấn luyện từ xa.

Link to this sectionQuản lý Keys#

Link to this sectionXem các Key#

Tất cả các key được liệt kê trên tab Settings > API Keys:

Mỗi thẻ key hiển thị tên key, giá trị key đã giải mã đầy đủ (có thể sao chép), thời gian tạo tương đối và nút thu hồi.

Link to this sectionThu hồi Key#

Thu hồi key đã bị xâm phạm hoặc không còn cần thiết:

1. Tìm key trong phần API Keys
2. Nhấp vào nút Thu hồi (thùng rác)
3. Xác nhận thu hồi

Link to this sectionTạo lại Key#

Nếu một key bị xâm phạm:

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

Link to this sectionAPI Keys của Không gian làm việc (Workspace)#

Các API key được giới hạn trong không gian làm việc đang hoạt động:

• Không gian làm việc cá nhân: Các key xác thực dưới dạng tài khoản cá nhân của bạn
• Không gian làm việc nhóm: Các key xác thực trong bối cảnh nhóm

Khi chuyển đổi không gian làm việc trong thanh bên, phần API Keys sẽ hiển thị các key cho không gian làm việc đó. Cần có quyền Editor trở lên để quản lý các API key của không gian làm việc. Xem Teams để biết chi tiết về quyền.

Link to this sectionCác thực tiễn tốt nhất về bảo mật#

Link to this sectionNên#

• Lưu trữ key trong biến môi trường
• Sử dụng các key riêng biệt cho các môi trường khác nhau
• Thu hồi các key không sử dụng ngay lập tức
• Xoay vòng các key định kỳ
• Sử dụng các tên mang tính mô tả để xác định mục đích của key

Link to this sectionKhông nên#

• Commit các key vào hệ thống quản lý phiên bản
• Chia sẻ key giữa các ứng dụng
• Ghi log key trong đầu ra ứng dụng
• Nhúng key vào mã phía client

Link to this sectionXoay vòng Key#

Xoay vòng các key định kỳ vì mục đích bảo mật:

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

Link to this sectionKhắc phục sự cố#

Link to this sectionLỗi Key không hợp lệ#

Các giải pháp:

1. Xác minh key đã được sao chép chính xác (bao gồm cả tiền tố ul_)
2. Kiểm tra xem key đã bị thu hồi chưa
3. Xác nhận biến môi trường đã được thiết lập
4. Đảm bảo bạn đang sử dụng ultralytics>=8.4.60

Link to this sectionQuyền bị từ chối#

Các giải pháp:

1. Xác minh bạn là chủ sở hữu tài nguyên hoặc có quyền truy cập không gian làm việc phù hợp
2. Kiểm tra xem key có thuộc về đúng không gian làm việc hay không
3. Tạo key mới nếu cần

Link to this sectionGiới hạn tốc độ (Rate Limited)#

Các giải pháp:

1. Giảm tần suất yêu cầu — xem bảng giới hạn tốc độ để biết giới hạn cho từng endpoint
2. Triển khai cơ chế exponential backoff sử dụng tiêu đề Retry-After
3. Sử dụng endpoint chuyên dụng để có lưu lượng suy luận không giới hạn

Link to this sectionCâu hỏi thường gặp#

Link to this sectionTôi có thể tạo bao nhiêu key?#

Không có giới hạn cứng về số lượng API key. Hãy tạo bao nhiêu key tùy ý cho các ứng dụng và môi trường khác nhau.

Link to this sectionCác key có hết hạn không?#

Các key không tự động hết hạn. Chúng vẫn hợp lệ cho đến khi bị thu hồi. Hãy cân nhắc thực hiện xoay vòng để đảm bảo bảo mật.

Link to this sectionTôi có thể xem key của mình sau khi tạo không?#

Có, các giá trị key đầy đủ hiển thị trong danh sách key tại Settings > API Keys. Nền tảng sẽ giải mã và hiển thị các key của bạn để bạn có thể sao chép chúng bất cứ lúc nào.

Link to this sectionCác key có đặc thù theo khu vực không?#

Các key hoạt động trên nhiều khu vực nhưng chỉ truy cập dữ liệu trong khu vực tài khoản của bạn.

Link to this sectionTôi có thể chia sẻ các key với thành viên trong nhóm không?#

Cách làm tốt hơn: Hãy để mỗi thành viên trong nhóm tự tạo key riêng. Đối với không gian làm việc nhóm, mỗi thành viên có vai trò Editor trở lên đều có thể tạo các key giới hạn trong không gian làm việc đó.