API · v1

Desarrolladores

Integre ChinaLogisticHub con su ERP, TMS o herramientas de BI a través de una API REST firmada y webhooks verificados con HMAC.

basehttps://api.chinalogistichub.com/api/v1/api/v1

REST

OpenAPI-described JSON endpoints.

Webhooks

HMAC-SHA256 signed event delivery.

Rate-aware

60 rpm default, enterprise raises it.

01

Autenticación

Genere una clave de API desde el panel de su empresa. Envíela en cualquiera de estos encabezados:

El secreto completo se muestra solo una vez, al momento de su creación. Revóquelo de inmediato si se filtra.

request.http·
Authorization: Bearer clh_live_<prefix>_<secret>
# or
X-API-Key:     clh_live_<prefix>_<secret>

02

Inicio rápido

curl200 OK
curl -H "Authorization: Bearer $CLH_KEY" \
     https://api.chinalogistichub.com/api/v1/api/v1/public/ping

03

Especificación OpenAPI

Contrato legible por máquinas, adecuado para generación de código (openapi-generator, orval, etc.).

POST/api/v1/requests
GET/api/v1/requests/{id}/quotes
POST/api/v1/quotes/{id}/award
GET/api/v1/shipments/{id}
GET/api/v1/shipments/{id}/documents
POST/api/v1/developers/webhooks

04

Webhooks

Suscríbase a eventos a través de POST /api/v1/developers/webhooks . Cada entrega incluye una firma HMAC-SHA256 en X-CLH-Signature.

Política de reintentos

6 intentos de entrega con retroceso exponencial comenzando en 30 segundos. Las solicitudes que nunca devuelven 2xx terminan en el registro de cartas muertas, consultable vía GET /developers/webhooks/:id/deliveries

Encabezado de firmanode
X-CLH-Signature: t=1713398400,v1=<hex>

const base = `${t}.${rawBody}`;
const expected = crypto.createHmac('sha256', secret)
  .update(base).digest('hex');
// Compare with timingSafeEqual, reject if |now - t| > 300s

Eventos soportados

  • request.created
  • request.status_changed
  • shipment.created
  • shipment.status_changed
  • shipment.delivered
  • quote.received
  • quote.awarded
  • quote.selected_confirmed
  • invoice.paid
  • document.uploaded
  • document.expiring

05

Límites de tasa

Por defecto: 60 solicitudes / minuto / clave de API. Los planes Enterprise elevan los límites.

ship faster

¿Listo para integrar? Cree claves en su

panel de desarrollador