Saltar al contenido

Resumen

URL base, convenciones y todos los endpoints.

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

JSON sobre HTTPS. Longitudes en cm, pesos en kg, importes en créditos.

Endpoints

Carga

EndpointPáginaPermiso
POST /v1/packCrear un trabajo de cargapack:write
POST /v1/estimateEstimar un trabajo de cargapack:write

Trabajos

EndpointPáginaPermiso
GET /v1/jobsListar trabajosjobs:read
GET /v1/jobs/{id}Consultar un trabajojobs:read
GET /v1/jobs/{id}/resultConsultar el resultado de un trabajojobs:read
DELETE /v1/jobs/{id}Cancelar un trabajopack:write

Proyectos

EndpointPáginaPermiso
GET /v1/projectsListar proyectosresources:read
POST /v1/projectsCrear un proyectoresources:write
GET /v1/projects/{id}Consultar un proyectoresources:read
PATCH /v1/projects/{id}Actualizar un proyectoresources:write
DELETE /v1/projects/{id}Eliminar un proyectoresources:write
POST /v1/projects/{id}/packCalcular la carga de un proyectopack:write y resources:write

Vehículos

EndpointPáginaPermiso
GET /v1/vehiclesListar vehículosresources:read
GET /v1/vehicles/{id}Consultar un vehículoresources:read
POST /v1/vehiclesCrear un vehículoresources:write
PATCH /v1/vehicles/{id}Actualizar un vehículoresources:write
DELETE /v1/vehicles/{id}Eliminar un vehículoresources:write

Plantillas

EndpointPáginaPermiso
GET /v1/templatesListar plantillasresources:read
GET /v1/templates/{id}Consultar una plantillaresources:read
POST /v1/templatesCrear una plantillaresources:write
PATCH /v1/templates/{id}Actualizar una plantillaresources:write
DELETE /v1/templates/{id}Eliminar una plantillaresources:write

Cuenta

EndpointPáginaPermiso
GET /v1/limitsConsultar los límitesaccount:read
GET /v1/balanceConsultar el saldoaccount:read
GET /v1/usageConsultar el usoaccount:read

Cabeceras

CabeceraSentidoSignificado
AuthorizationSolicitudBearer cd_live_…
Content-TypeSolicitudapplication/json en POST
Idempotency-KeySolicitudReintentos seguros de POST /v1/pack y POST /v1/projects/{id}/pack
X-Request-IdRespuestaID de la solicitud (req_…), en todas las respuestas
X-RateLimit-Limit / -Remaining / -ResetRespuestaLa ventana de frecuencia más restrictiva
X-Credits-RemainingRespuestaCréditos disponibles tras la solicitud
Retry-AfterRespuestaSegundos que hay que esperar, en 429
Idempotent-ReplayedRespuestatrue cuando una clave devolvió un trabajo anterior

Formatos legibles por máquina

Ver también