Bắt đầu
Tạo API key
API key xác thực cho các lệnh gọi các dịch vụ của Roam Moon Cloud.
Các bước
- Mở mục API key trong bảng điều khiển.
- Bấm Tạo API key, đặt tên gợi nhớ theo nơi sử dụng, ví dụ "backend sản xuất".
- Sao chép key ngay và lưu vào kho bí mật của bạn.
Key chỉ hiện đúng một lần
Chúng tôi chỉ lưu bản băm của key, không lưu chính key đó. Nếu làm mất, không ai, kể cả chúng tôi, xem lại được. Hãy tạo key mới và thu hồi key cũ.
Dùng key
Gửi key trong header X-API-Key ở mọi request:
cURL
curl https://core.roammoon.com/v1/ai/license-plates/recognize \
-H "X-API-Key: rm_live_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-F "file=@plate.jpg"Chuỗi x ở trên là chỗ thay cho key của bạn. Một key dài 64 ký tự, gồm tiền tố rm_live_, phần định danh công khai 12 ký tự, một dấu gạch dưới, rồi phần bí mật 43 ký tự.
Chỉ header X-API-Key được chấp nhận. Header Authorization dành riêng cho phiên đăng nhập của người dùng và sẽ bị từ chối:
cURL
# Rejected, because Authorization is reserved for user sessions
curl ... -H "Authorization: Bearer rm_live_..." # 401 API_KEY_REQUIREDSố key theo gói
Mỗi gói giới hạn số key đang hoạt động:
| Gói | Số API key |
|---|---|
| Hobby | 3 |
| Pro | 20 |
| Scale | 100 |
| Enterprise | Tùy chỉnh |
Key đã hết hạn hoặc bị vô hiệu hóa không chiếm chỗ, nên bạn có thể xoay key mà không cần nâng gói.
Lưu ý bảo mật
- Không nhúng key vào ứng dụng di động hay mã chạy trên trình duyệt, vì ai cũng đọc được.
- Mỗi môi trường một key riêng, để thu hồi một nơi không làm chết những nơi khác.
- Nghi ngờ lộ key thì vô hiệu hóa ngay; mọi request dùng key đó sẽ bị chặn lập tức.