Dokumentacja dla deweloperówDokumentacja API
Przegląd
Bazowy URL, konwencje i wszystkie endpointy.
https://runner.cargoduo.com/v1JSON przez HTTPS. Długości w cm, wagi w kg, kwoty w kredytach.
Endpointy
Załadunek
| Endpoint | Strona | Zakres |
|---|---|---|
POST /v1/pack | Utwórz zadanie załadunku | pack:write |
POST /v1/estimate | Wyceń zadanie załadunku | pack:write |
Zadania
| Endpoint | Strona | Zakres |
|---|---|---|
GET /v1/jobs | Lista zadań | jobs:read |
GET /v1/jobs/{id} | Pobierz zadanie | jobs:read |
GET /v1/jobs/{id}/result | Pobierz wynik zadania | jobs:read |
DELETE /v1/jobs/{id} | Anuluj zadanie | pack:write |
Projekty
| Endpoint | Strona | Zakres |
|---|---|---|
GET /v1/projects | Lista projektów | resources:read |
POST /v1/projects | Utwórz projekt | resources:write |
GET /v1/projects/{id} | Pobierz projekt | resources:read |
PATCH /v1/projects/{id} | Zaktualizuj projekt | resources:write |
DELETE /v1/projects/{id} | Usuń projekt | resources:write |
POST /v1/projects/{id}/pack | Zaplanuj załadunek projektu | pack:write i resources:write |
Pojazdy
| Endpoint | Strona | Zakres |
|---|---|---|
GET /v1/vehicles | Lista pojazdów | resources:read |
GET /v1/vehicles/{id} | Pobierz pojazd | resources:read |
POST /v1/vehicles | Utwórz pojazd | resources:write |
PATCH /v1/vehicles/{id} | Zaktualizuj pojazd | resources:write |
DELETE /v1/vehicles/{id} | Usuń pojazd | resources:write |
Szablony
| Endpoint | Strona | Zakres |
|---|---|---|
GET /v1/templates | Lista szablonów | resources:read |
GET /v1/templates/{id} | Pobierz szablon | resources:read |
POST /v1/templates | Utwórz szablon | resources:write |
PATCH /v1/templates/{id} | Zaktualizuj szablon | resources:write |
DELETE /v1/templates/{id} | Usuń szablon | resources:write |
Konto
| Endpoint | Strona | Zakres |
|---|---|---|
GET /v1/limits | Pobierz limity | account:read |
GET /v1/balance | Pobierz saldo | account:read |
GET /v1/usage | Pobierz dane o użyciu | account:read |
Nagłówki
| Nagłówek | Kierunek | Znaczenie |
|---|---|---|
Authorization | Zapytanie | Bearer cd_live_… |
Content-Type | Zapytanie | application/json przy POST |
Idempotency-Key | Zapytanie | Bezpieczne ponawianie POST /v1/pack i POST /v1/projects/{id}/pack |
X-Request-Id | Odpowiedź | ID zapytania (req_…), w każdej odpowiedzi |
X-RateLimit-Limit / -Remaining / -Reset | Odpowiedź | Najbardziej restrykcyjne okno limitu zapytań |
X-Credits-Remaining | Odpowiedź | Dostępne kredyty po zapytaniu |
Retry-After | Odpowiedź | Ile sekund odczekać (przy 429) |
Idempotent-Replayed | Odpowiedź | true, gdy klucz zwrócił wcześniejsze zadanie |
Do odczytu maszynowego
openapi.jsonOpenAPI 3.1, wszystkie endpointy i schematy.llms-full.txtprzewodnik integracji dla agentów kodujących.