İçeriğe atla

Genel bakış

Temel URL, kurallar ve tüm endpoint'ler.

Text
https://runner.cargoduo.com/v1

HTTPS üzerinden JSON. Uzunluklar cm, ağırlıklar kg, tutarlar kredi cinsindendir.

Endpoint'ler

Yükleme

EndpointSayfaYetki
POST /v1/packYükleme işi oluşturpack:write
POST /v1/estimateMaliyet tahmini alpack:write

İşler

EndpointSayfaYetki
GET /v1/jobsİşleri listelejobs:read
GET /v1/jobs/{id}İşi getirjobs:read
GET /v1/jobs/{id}/resultİş sonucunu getirjobs:read
DELETE /v1/jobs/{id}İşi iptal etpack:write

Projeler

EndpointSayfaYetki
GET /v1/projectsProjeleri listeleresources:read
POST /v1/projectsProje oluşturresources:write
GET /v1/projects/{id}Projeyi getirresources:read
PATCH /v1/projects/{id}Projeyi güncelleresources:write
DELETE /v1/projects/{id}Projeyi silresources:write
POST /v1/projects/{id}/packProjeyi hesaplapack:write ve resources:write

Araçlar

EndpointSayfaYetki
GET /v1/vehiclesAraçları listeleresources:read
GET /v1/vehicles/{id}Aracı getirresources:read
POST /v1/vehiclesAraç oluşturresources:write
PATCH /v1/vehicles/{id}Aracı güncelleresources:write
DELETE /v1/vehicles/{id}Aracı silresources:write

Şablonlar

EndpointSayfaYetki
GET /v1/templatesŞablonları listeleresources:read
GET /v1/templates/{id}Şablonu getirresources:read
POST /v1/templatesŞablon oluşturresources:write
PATCH /v1/templates/{id}Şablonu güncelleresources:write
DELETE /v1/templates/{id}Şablonu silresources:write

Hesap

EndpointSayfaYetki
GET /v1/limitsLimitleri getiraccount:read
GET /v1/balanceBakiyeyi getiraccount:read
GET /v1/usageKullanımı getiraccount:read

Header'lar

HeaderYönAnlamı
AuthorizationİstekBearer cd_live_…
Content-TypeİstekPOST isteklerinde application/json
Idempotency-KeyİstekPOST /v1/pack ve POST /v1/projects/{id}/pack için güvenli tekrar deneme
X-Request-IdYanıtİstek ID'si (req_…), her yanıtta
X-RateLimit-Limit / -Remaining / -ResetYanıtEn sıkı rate limit penceresi
X-Credits-RemainingYanıtİstekten sonra kalan kullanılabilir kredi
Retry-AfterYanıt429 yanıtında beklenecek saniye
Idempotent-ReplayedYanıtAnahtar önceki bir işi tekrar döndürdüğünde true

Makine tarafından okunabilir

İlgili