Bỏ qua để đến nội dung

Xác thực và khóa API

Tạo một khóa API sk_ trong trung tâm API . Khóa đầy đủ chỉ được hiển thị một lần, khi nó được tạo hoặc đổi phiên.

Sử dụng một khóa riêng cho mỗi ứng dụng, môi trường và tác vụ tự động, để mỗi khóa có thể được quản lý riêng về ngân sách, đồng thời có thể bị vô hiệu hóa, thay đổi khóa và kiểm toán độc lập.

Đề xuất:

X-API-Key: sk_your_key

Biểu thức chuẩn Bearer cũng hoạt động:

Authorization: Bearer sk_your_key

Trong một yêu cầu, chỉ gửi một trong hai tùy chọn.

Terminal window
curl https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY"

Một khóa hoạt động cho tài khoản đã tạo ra nó: nó có thể gọi các dịch vụ mà tài khoản đó có thể sử dụng và chỉ có thể truy cập vào các tài nguyên của tài khoản đó. Một khóa không thể thay đổi email đăng nhập, mật khẩu, số điện thoại hoặc hồ sơ cá nhân, đồng thời không thể tạo, xoay vòng hoặc thu hồi các khóa API.

Giới hạn tùy chọn:

  • allowed_engines: chỉ các cài đặt dịch được liệt kê; mảng rỗng không thêm giới hạn cấp khóa nào.
  • expires_at: thời gian hết hạn.
  • quota_limit: ngân sách thời gian sử dụng của khóa tính bằng millicredit; 0 không thiết lập ngân sách cấp khóa, và số tín dụng của tài khoản được thanh toán như bình thường.

Tạo khóa, thay đổi giới hạn của chúng, xoay hoặc thu hồi chúng trong trung tâm API . Khi một khóa bị thu hồi, vô hiệu hóa hoặc hết hạn, hoặc tài khoản của nó bị vô hiệu hóa, các yêu cầu mới sẽ ngay lập tức thất bại.

Quá trình xoay khóa sẽ tạo một khóa bí mật mới và đồng thời vô hiệu hóa khóa cũ; khóa mới vẫn giữ nguyên các giới hạn ban đầu và ngân sách đã sử dụng. Khóa đã hết hạn không thể được xoay; hãy tạo khóa mới. Để chuyển đổi suôn sẻ, hãy tạo và triển khai khóa mới, xác nhận các yêu cầu đều thành công, sau đó thu hồi khóa cũ.

  • Chỉ lưu trữ khóa trên máy chủ hoặc trong môi trường runtime được kiểm soát.
  • Sử dụng biến môi trường hoặc trình quản lý bí mật; không bao giờ lưu trữ khóa trong mã nguồn, nhật ký, gói trình duyệt hoặc kho công khai.
  • Không bao giờ gửi khóa đến các địa chỉ tải lên hoặc tải xuống được trả về bởi API.
  • Ghi lại ID khóa, ID yêu cầu và ID thao tác; không bao giờ ghi toàn bộ khóa.
  • Nếu một khóa bị rò rỉ, hãy thay đổi ngay lập tức và kiểm tra các tác vụ cũng như mức phí liên quan.