API · v1
Développeurs
Intégrez ChinaLogisticHub à votre ERP, TMS ou outils de BI via une API REST signée et des webhooks vérifiés par HMAC.
https://api.chinalogistichub.com/api/v1/api/v1REST
OpenAPI-described JSON endpoints.
Webhooks
HMAC-SHA256 signed event delivery.
Rate-aware
60 rpm default, enterprise raises it.
01
Authentification
Générez une clé API depuis le tableau de bord de votre entreprise. Envoyez-la dans l'un de ces en-têtes :
Le secret complet n'est affiché qu'une seule fois lors de la création. Révoquez immédiatement s'il fuit.
Authorization: Bearer clh_live_<prefix>_<secret> # or X-API-Key: clh_live_<prefix>_<secret>
02
Démarrage rapide
curl -H "Authorization: Bearer $CLH_KEY" \
https://api.chinalogistichub.com/api/v1/api/v1/public/ping03
Spécification OpenAPI
Contrat lisible par machine, adapté à la génération de code (openapi-generator, orval, etc.).
/api/v1/requestsCreate a freight request/api/v1/requests/{id}/quotesList quotes for a request/api/v1/quotes/{id}/awardAward a winning carrier quote/api/v1/shipments/{id}Get shipment + tracking events/api/v1/shipments/{id}/documentsList shipment documents/api/v1/developers/webhooksSubscribe to event webhooks04
Webhooks
Abonnez-vous aux événements via POST /api/v1/developers/webhooks . Chaque livraison comporte une signature HMAC-SHA256 dans X-CLH-Signature.
Politique de nouvelle tentative
6 tentatives de livraison avec backoff exponentiel démarrant à 30 secondes. Les requêtes qui ne renvoient jamais 2xx atterrissent dans le journal de lettres mortes, consultable via GET /developers/webhooks/:id/deliveries
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Événements pris en charge
- 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 débit
Par défaut : 60 requêtes / minute / clé API. Les plans Enterprise relèvent les limites.