Chuyển đến nội dung

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:

  1. Vào 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

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ừ xa
  • ci-pipeline - Để tích hợp CI/CD
  • mobile-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 viQuyền hạn
đào tạoBắt đầu huấn luyện, theo dõi số liệu.
mô hìnhTải lên, tải xuống, xóa mô hình
các bộ dữ liệuTruy cập và chỉnh sửa tập dữ liệu
đọcChỉ được phép truy cập đọc vào tất cả các tài nguyên.
viếtQuyền ghi đầy đủ
quản trị viênQuả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ộtMô tả
TênMã định danh chính
Phạm viQuyền được chỉ định
TạoNgày tạo
Lần sử dụng cuối cùngLầ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:

  1. Nhấp vào menu của phím
  2. Chọn Thu hồi
  3. 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:

  1. Tạo khóa mới với cùng phạm vi.
  2. Cập nhật ứng dụng của bạn
  3. 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:

  1. Tạo khóa mới với cùng phạm vi.
  2. Cập nhật ứng dụng để sử dụng khóa mới
  3. Kiểm tra xem các ứng dụng có hoạt động chính xác hay không.
  4. 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:

  1. Xác minh xem khóa đã được sao chép chính xác chưa.
  2. Kiểm tra xem khóa đã bị thu hồi chưa.
  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 truy cập bị từ chối

Error: Permission denied for this operation

Giải pháp:

  1. Kiểm tra xem các phạm vi chính có bao gồm quyền cần thiết hay không.
  2. Hãy xác minh bạn là chủ sở hữu tài nguyên.
  3. 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:

  1. Giảm tần suất yêu cầu
  2. Thực hiện 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 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


📅 Được tạo 0 ngày trước ✏️ Được cập nhật 0 ngày trước
glenn-jocher

Bình luận