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 đặt tên với mã hóa AES-256-GCM 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 > Hồ sơ
2. Cuộn xuống phần Khóa API .
3. Nhấp vào Tạo Khóa
4. Nhập tên cho khóa (ví dụ: "Máy chủ huấn luyện")
5. Nhấp vào Tạo Khóa

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
• local-dev - Vì sự phát triển địa phương

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_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4

• 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ự

Bảo mật chính

• Các khóa được lưu trữ bằng 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ị đầy đủ của khóa không bao giờ được lưu trữ dưới dạng văn bản thuần.

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"

YOLO CLI

Đặt khóa bằng cách sử dụng YOLO CLI :

yolo settings 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/...

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

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.14"

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

Xem Cloud Training để có hướng dẫn đào tạo từ xa đầy đủ.

Quản lý Khóa

Xem Khóa

Tất cả các chìa khóa đều được liệt kê trong Settings > Profile trong mục Khóa API:

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

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. Tìm khóa trong phần Khóa API.
2. Nhấp vào nút Thu hồi (thùng rác).
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 một khóa mới có cùng tên.
2. Cập nhật các ứng dụng của bạn
3. Thu hồi khóa cũ

Khóa API không gian làm việc

Khóa API chỉ có hiệu lực trong không gian làm việc hiện đang hoạt động:

• Không gian làm việc cá nhân : Khóa xác thực là tài khoản cá nhân của bạn.
• Không gian làm việc nhóm : Khóa xác thực trong ngữ cảnh nhóm

Khi chuyển đổi giữa các không gian làm việc trong thanh bên, mục Khóa API sẽ hiển thị các khóa cho không gian làm việc đó. Cần có vai trò Biên tập viên trở lên để quản lý khóa API của không gian làm việc. Xem Nhóm để biết chi tiết về vai trò.

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
• Xoay vòng khóa định kỳ
• Sử dụng tên gọi mô tả để xác định các mục đích chính.

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
• 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 tên
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 (bao gồm cả...) ul_ tiền tố)
2. Kiểm tra khóa chưa bị thu hồi
3. Xác nhận biến môi trường đã được thiết lập
4. Hãy đảm bảo bạn đang sử dụng ultralytics>=8.4.14

Quyền bị Từ chối

Error: Permission denied for this operation

Giải pháp:

1. Hãy 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 khóa đó có thuộc về không gian làm việc chính xác hay không.
3. Tạo khóa mới nếu cần

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 — xem bảng giới hạn tỷ lệ để biết giới hạn cho mỗi điểm cuối.
2. Thực hiện thuật toán lùi lũy thừa bằng cách sử dụng... Retry-After tiêu đề
3. Sử dụng điểm cuối chuyên dụng để có thông lượng suy luận khô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?

Đúng vậy, toàn bộ giá trị khóa đều hiển thị trong danh sách khóa trên Settings > ProfileNền tảng này sẽ 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.

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?

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 với không gian làm việc nhóm, mỗi thành viên có vai trò Biên tập viên trở lên có thể tạo khóa có phạm vi áp dụng cho không gian làm việc đó.

📅 Được tạo 1 tháng trước ✍️ Cập nhật 5 ngày trước

Bình luận