API · v1
Әзірлеушілер
Қол қойылған REST API және HMAC-расталған Webhook арқылы ChinaLogisticHub-ты ERP, TMS немесе BI құралдарыңызға біріктіріңіз.
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
Аутентификация
Компания басқару тақтасынан API кілт жасап, оны мына тақырыптардың бірінде жіберіңіз:
Толық құпия тек жасау кезінде көрсетіледі. Ағып кетсе, дереу жойыңыз.
Authorization: Bearer clh_live_<prefix>_<secret> # or X-API-Key: clh_live_<prefix>_<secret>
02
Жылдам бастау
curl -H "Authorization: Bearer $CLH_KEY" \
https://api.chinalogistichub.com/api/v1/api/v1/public/ping03
OpenAPI спецификациясы
Код генерациясы үшін машинамен оқылатын келісім (openapi-generator, orval, т.б.).
/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
Оқиғаларға жазылу: POST /api/v1/developers/webhooks . Әр жеткізілім HMAC-SHA256 қол қойылымын мына тақырыпта тасиды: X-CLH-Signature.
Қайталау саясаты
30 секундтан басталатын экспоненциалды кідіріспен 6 рет жеткізу әрекеті. Мына күйді қайтармаған сұраулар 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Қолдау көрсетілетін оқиғалар
- 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
Жылдамдық шектеулері
Әдепкі: API кілті үшін минутына 60 сұрау. Enterprise тарифінде шектеулер жоғарырақ.