Xác thực
Reigniter API sử dụng API khóa. Mỗi khóa thuộc về một tài khoản và hoạt động như tài khoản đó: nó sử dụng các khoản tín dụng của tài khoản đó và chỉ xem các công việc của tài khoản đó.
Tạo khóa
Phần tiêu đề “Tạo khóa”API chìa khóa là một phần của kế hoạch Agency.
- Đăng nhập vào Reigniter.
- Mở khóa Tài khoản > API (
/app/account/api-keys). - Dưới mục Tạo khóa mới, nhập một nhãn bạn sẽ nhận ra sau này, chẳng hạn như
CI pipelinehoặcCMS sync. - Chọn Tạo.
- Sao chép chìa khóa ngay lập tức.
Một khóa trông như sau: emp_ theo sau là 64 ký tự thập lục phân.
Gửi chìa khóa
Phần tiêu đề “Gửi chìa khóa”Đặt khóa trong tiêu đề Authorization làm token Bearer trên mỗi yêu cầu:
curl https://reigniter.ai/v1/me \ -H "Authorization: Bearer $REIGNITER_API_KEY"Một khóa hợp lệ sẽ trả về 200 với tài khoản của bạn:
{ "user_id": "3f1c2a9e-8b7d-4c1e-9f0a-2d6b5e4c3a21", "email": "dev@example.com", "name": "Sam", "credits_remaining": 42}Khi một khóa bị từ chối
Phần tiêu đề “Khi một khóa bị từ chối”| Tình trạng | code |
Ý nghĩa |
|---|---|---|
401 |
NO_API_KEY |
Không có tiêu đề Authorization, hoặc token không bắt đầu bằng emp_. |
401 |
INVALID_API_KEY |
Chìa khóa chưa được biết hoặc đã bị thu hồi. |
402 |
PLAN_UPGRADE_REQUIRED |
Khóa hợp lệ, nhưng tài khoản không nằm trong gói Agency. |
403 |
ACCOUNT_SUSPENDED |
Tài khoản sở hữu khóa sẽ bị tạm ngưng. |
Nếu một tài khoản rời khỏi gói Agency, khóa của nó sẽ ngừng hoạt động cho đến khi nó trở lại Agency.
Giữ bí mật chìa khóa
Phần tiêu đề “Giữ bí mật chìa khóa”- Lưu khóa trong một trình quản lý bí mật hoặc biến môi trường. Không bao giờ cam kết chúng với kiểm soát nguồn.
- Chỉ gọi API từ máy chủ của bạn. Không bao giờ gửi khóa trong trang web hoặc ứng dụng di động. Yêu cầu trình duyệt đến API không được phép theo chính sách CORS của nó.
- Mỗi hệ thống dùng một chìa khóa, với nhãn rõ ràng. Sau đó bạn có thể thu hồi một khóa mà không làm hỏng các khóa còn lại.
- Màn hình phím API hiển thị khi nào mỗi phím được sử dụng lần cuối. Một khóa bạn không nhận ra, hoặc khóa được sử dụng khi không nên dùng, nên bị thu hồi.
Thu hồi một khóa
Phần tiêu đề “Thu hồi một khóa”- Mở khóa tài khoản > API.
- Dưới mục Khóa Hoạt động, tìm khóa theo nhãn của nó.
- Chọn biểu tượng Thu hồi khóa (thùng).
Khóa bị thu hồi sẽ bị từ chối ngay lập tức bằng 401 INVALID_API_KEY. Việc thu hồi không thể hoàn tác. Các bản render đã bắt đầu với khóa vẫn tiếp tục chạy.