Tài liệu cho nhà phát triểnTham chiếu API
Tổng quan
URL gốc, quy ước và mọi endpoint.
https://runner.cargoduo.com/v1JSON qua HTTPS. Chiều dài tính bằng cm, trọng lượng bằng kg, tiền bằng credit.
Endpoint
Xếp hàng
| Endpoint | Trang | Phạm vi quyền |
|---|---|---|
POST /v1/pack | Tạo tác vụ xếp hàng | pack:write |
POST /v1/estimate | Ước tính chi phí tác vụ xếp hàng | pack:write |
Tác vụ
| Endpoint | Trang | Phạm vi quyền |
|---|---|---|
GET /v1/jobs | Liệt kê tác vụ | jobs:read |
GET /v1/jobs/{id} | Xem tác vụ | jobs:read |
GET /v1/jobs/{id}/result | Xem kết quả tác vụ | jobs:read |
DELETE /v1/jobs/{id} | Hủy tác vụ | pack:write |
Dự án
| Endpoint | Trang | Phạm vi quyền |
|---|---|---|
GET /v1/projects | Liệt kê dự án | resources:read |
POST /v1/projects | Tạo dự án | resources:write |
GET /v1/projects/{id} | Xem dự án | resources:read |
PATCH /v1/projects/{id} | Cập nhật dự án | resources:write |
DELETE /v1/projects/{id} | Xóa dự án | resources:write |
POST /v1/projects/{id}/pack | Xếp hàng cho dự án | pack:write và resources:write |
Xe
| Endpoint | Trang | Phạm vi quyền |
|---|---|---|
GET /v1/vehicles | Liệt kê xe | resources:read |
GET /v1/vehicles/{id} | Xem xe | resources:read |
POST /v1/vehicles | Tạo xe | resources:write |
PATCH /v1/vehicles/{id} | Cập nhật xe | resources:write |
DELETE /v1/vehicles/{id} | Xóa xe | resources:write |
Mẫu hàng
| Endpoint | Trang | Phạm vi quyền |
|---|---|---|
GET /v1/templates | Liệt kê mẫu hàng | resources:read |
GET /v1/templates/{id} | Xem mẫu hàng | resources:read |
POST /v1/templates | Tạo mẫu hàng | resources:write |
PATCH /v1/templates/{id} | Cập nhật mẫu hàng | resources:write |
DELETE /v1/templates/{id} | Xóa mẫu hàng | resources:write |
Tài khoản
| Endpoint | Trang | Phạm vi quyền |
|---|---|---|
GET /v1/limits | Xem giới hạn | account:read |
GET /v1/balance | Xem số dư | account:read |
GET /v1/usage | Xem mức sử dụng | account:read |
Header
| Header | Chiều | Ý nghĩa |
|---|---|---|
Authorization | Yêu cầu | Bearer cd_live_… |
Content-Type | Yêu cầu | application/json với POST |
Idempotency-Key | Yêu cầu | Thử lại an toàn cho POST /v1/pack và POST /v1/projects/{id}/pack |
X-Request-Id | Phản hồi | ID yêu cầu (req_…), có trong mọi phản hồi |
X-RateLimit-Limit / -Remaining / -Reset | Phản hồi | Khung giới hạn tần suất chặt nhất |
X-Credits-Remaining | Phản hồi | Credit khả dụng sau yêu cầu |
Retry-After | Phản hồi | Số giây cần chờ, khi gặp 429 |
Idempotent-Replayed | Phản hồi | true khi khóa trả lại một tác vụ trước đó |
Dành cho máy đọc
openapi.jsonOpenAPI 3.1, mọi endpoint và schema.llms-full.txthướng dẫn tích hợp cho agent lập trình.