Link to this sectionAPI Keys#

API keys của Ultralytics Platform cho phép truy cập lập trình bảo mật để thực hiện huấn luyện từ xa, suy luận (inference) 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 mô tả:

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

Link to this sectionHiển thị Key#

Sau khi tạo, key chỉ được hiển thị một lần:

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

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

• Prefix (Tiền tố): ul_ để xác định các key của Ultralytics
• Body (Nội dung): 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 tiền tố nhanh và so sánh hàm băm
• Giá trị key đầy đủ không bao giờ được lưu trữ dưới dạng văn bản thuần (plaintext)

Link to this sectionSử dụng API Keys#

Link to this sectionBiến môi trường (Environment Variable)#

Đặt key của bạn làm một biến môi trường:

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

Link to this sectionYOLO CLI#

Đặt key bằng YOLO CLI:

yolo settings api_key="YOUR_API_KEY"

Link to this sectionTrong mã nguồn (In Code)#

Sử dụng key trong các script 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 sectionHTTP Headers#

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 REST API Reference để 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 Cloud Training để 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ê trong 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 một key nếu nó bị lộ 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 Revoke (biểu tượng 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ị lộ:

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 sectionWorkspace API Keys#

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

• Personal workspace: Các key xác thực với tư cách tài khoản cá nhân của bạn
• Team workspace: Các key xác thực trong bối cảnh nhóm

Khi chuyển đổi workspace trong thanh bên, phần API Keys sẽ hiển thị các key cho workspace đó. Cần vai trò Editor trở lên để quản lý workspace API keys. Xem Teams để biết chi tiết về vai trò.

Link to this sectionCác phương pháp bảo mật tốt nhất#

Link to this sectionNên#

• Lưu trữ key trong các 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 ngay các key không sử dụng
• Định kỳ xoay vòng key
• Sử dụng tên mô tả để xác định mục đích của key

Link to this sectionKhông nên#

• Commit các key lên hệ thống quản lý phiên bản (version control)
• Chia sẻ key giữa các ứng dụng
• Ghi log (log) các key vào đầu ra của ứng dụng
• Nhúng key vào mã nguồn phía máy khách (client-side)

Link to this sectionXoay vòng Key#

Định kỳ xoay vòng key để đảm bảo 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 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 đặt
4. Đảm bảo bạn đang sử dụng ultralytics>=8.4.60

Link to this sectionQuyền bị từ chối (Permission Denied)#

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 workspace phù hợp
2. Kiểm tra xem key có thuộc về đúng workspace 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 mỗi endpoint
2. Triển khai cơ chế exponential backoff sử dụng header Retry-After
3. Sử dụng dedicated endpoint để 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 cho API keys. Hãy tạo bao nhiêu key tùy nhu cầu 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 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 thực hiện xoay vòng khóa để đảm bảo tính bảo mật.

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

Có, giá trị khóa đầy đủ được hiển thị trong danh sách khóa tại Settings > API Keys. Nền tảng giải mã và hiển thị các khóa 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 khóa có bị giới hạn theo 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 tài khoản của bạn.

Link to this sectionTô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: Yêu cầu mỗi thành viên trong nhóm tự tạo khóa 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 khóa giới hạn trong không gian làm việc đó.