ChinaLogisticHub
Começar

API · v1

Programadores

Integre a ChinaLogisticHub com o seu ERP, TMS ou ferramentas de BI através de uma API REST assinada e webhooks verificados por HMAC.

Swagger UI (não produção)Documento OpenAPI JSON
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

Autenticação

Gere uma chave de API no painel da sua empresa. Envie-a num destes cabeçalhos:

O segredo completo é mostrado apenas uma vez no momento da criação. Revogue imediatamente em caso de fuga.

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

02

Início Rápido

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

03

Especificação OpenAPI

Contrato legível por máquina adequado para geração 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

Subscreva eventos via POST /api/v1/developers/webhooks . Cada entrega inclui uma assinatura HMAC-SHA256 em X-CLH-Signature.

Política de novas tentativas

6 tentativas de entrega com backoff exponencial a começar em 30 segundos. Pedidos que nunca devolvem 2xx vão para o registo de dead-letter, visível através de GET /developers/webhooks/:id/deliveries

Cabeçalho de assinaturanode
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 suportados

  • 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

Limites de Taxa

Predefinição: 60 pedidos / minuto / chave de API. Planos Enterprise aumentam os limites.

ship faster

Pronto para integrar? Crie chaves no seu

painel de programador