Xác thực

Khóa API, phạm vi quyền và danh sách IP được phép.

Gửi khóa API dưới dạng bearer token trong mọi yêu cầu tới /v1.

Bash

curl https://runner.cargoduo.com/v1/balance \
  -H "Authorization: Bearer $CARGODUO_API_KEY"

Khóa API

Khóa	Chi tiết
Định dạng	`cd_live_` + 40 ký tự
Người tạo	Chủ sở hữu tổ chức, trong console dành cho nhà phát triển
Hiển thị	Một lần, khi tạo. Chúng tôi chỉ lưu giá trị băm
Mỗi tổ chức	Tối đa 20 khóa đang hoạt động
Tùy chọn	Ngày hết hạn, danh sách IP được phép (địa chỉ IP hoặc dải CIDR)
Đổi khóa	Khóa bí mật mới, giữ nguyên cài đặt. Khóa cũ ngừng hoạt động ngay

Chỉ giữ khóa trên máy chủ. Không bao giờ đưa khóa vào mã chạy trên trình duyệt hay ứng dụng di động.

Phạm vi quyền	Endpoint
`pack:write`	`POST /v1/pack`, `POST /v1/estimate`, `DELETE /v1/jobs/{id}`, `POST /v1/projects/{id}/pack`
`jobs:read`	`GET /v1/jobs`, `GET /v1/jobs/{id}`, `GET /v1/jobs/{id}/result`
`account:read`	`GET /v1/limits`, `GET /v1/balance`, `GET /v1/usage`
`resources:read`	`GET /v1/projects`, `GET /v1/projects/{id}`, `GET /v1/vehicles`, `GET /v1/vehicles/{id}`, `GET /v1/templates`, `GET /v1/templates/{id}`
`resources:write`	`POST /v1/projects`, `PATCH /v1/projects/{id}`, `DELETE /v1/projects/{id}`, `POST /v1/projects/{id}/pack`, `POST /v1/vehicles`, `PATCH /v1/vehicles/{id}`, `DELETE /v1/vehicles/{id}`, `POST /v1/templates`, `PATCH /v1/templates/{id}`, `DELETE /v1/templates/{id}`

Khóa mới có mọi phạm vi quyền. POST /v1/projects/{id}/pack cần cả pack:write lẫn resources:write.

Trạng thái	Mã	Ý nghĩa
401	`unauthorized`	Thiếu khóa API, khóa sai định dạng hoặc không xác định.
401	`key_revoked`	Khóa đã bị thu hồi.
401	`key_expired`	Khóa đã quá ngày hết hạn.
403	`ip_not_allowed`	IP gọi đến không nằm trong danh sách IP được phép của khóa.
403	`subscription_inactive`	Tổ chức không có gói đăng ký đang hoạt động nào bao gồm API.
403	`account_inactive`	Tổ chức bị tạm ngưng, hoặc không có chủ sở hữu nào có tài khoản đang hoạt động.
403	`scope_missing`	Khóa thiếu phạm vi quyền mà endpoint này yêu cầu.
429	`rate_limited`	Quá nhiều yêu cầu trong phút, giờ hoặc ngày hiện tại (theo khóa hoặc theo tổ chức), hoặc có hơn 60 lần xác thực thất bại mỗi phút từ địa chỉ IP của bạn.