Saltar al contenido

Autenticación

Claves de API, permisos y listas de IP permitidas.

Envía una clave de API como token Bearer en cada solicitud a /v1.

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

Claves de API

ClaveDetalle
Formatocd_live_ + 40 caracteres
Quién la creaEl propietario de la organización, en la consola de desarrolladores
VisibilidadSe muestra una sola vez, al crearla. Solo se guarda un hash
Por organizaciónHasta 20 claves activas
OpcionalFecha de caducidad y lista de IP permitidas (IP o rangos CIDR)
RotaciónNuevo secreto con la misma configuración. El anterior deja de funcionar al instante

Guarda las claves en tu servidor. Nunca incluyas una en un navegador ni en una app móvil.

Permisos

PermisoEndpoints
pack:writePOST /v1/pack, POST /v1/estimate, DELETE /v1/jobs/{id}, POST /v1/projects/{id}/pack
jobs:readGET /v1/jobs, GET /v1/jobs/{id}, GET /v1/jobs/{id}/result
account:readGET /v1/limits, GET /v1/balance, GET /v1/usage
resources:readGET /v1/projects, GET /v1/projects/{id}, GET /v1/vehicles, GET /v1/vehicles/{id}, GET /v1/templates, GET /v1/templates/{id}
resources:writePOST /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}

Las claves nuevas tienen todos los permisos (scopes). POST /v1/projects/{id}/pack necesita tanto pack:write como resources:write.

Errores

EstadoCódigoSignificado
401unauthorizedClave de API ausente, mal formada o desconocida.
401key_revokedLa clave se ha revocado.
401key_expiredLa clave ha superado su fecha de caducidad.
403ip_not_allowedLa IP de origen no está en la lista de IP permitidas de la clave.
403subscription_inactiveLa organización no tiene ninguna suscripción activa que incluya la API.
403account_inactiveLa organización está suspendida o no tiene ningún propietario con la cuenta activa.
403scope_missingA la clave le falta un permiso que requiere este endpoint.
429rate_limitedDemasiadas solicitudes en el minuto, la hora o el día en curso (por clave o por organización), o más de 60 autenticaciones fallidas por minuto desde tu dirección IP.

Ver también