ChinaLogisticHub
ابدأ الآن

API · v1

المطورون

ادمج ChinaLogisticHub مع نظام ERP أو TMS أو أدوات BI عبر REST API موقَّعة و Webhooks مُتحقَّق منها بـ HMAC.

Swagger UI (غير إنتاجي)وثيقة 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

المصادقة

أنشئ مفتاح API من لوحة شركتك. أرسله في أي من هذين الهيدرين:

يُعرض السر الكامل مرة واحدة فقط عند الإنشاء. قم بإبطاله فورًا في حال تسربه.

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

02

بداية سريعة

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

03

مواصفات OpenAPI

عقد قابل للقراءة آليًا ومناسب لتوليد الكود (openapi-generator، orval، وغيرها).

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

اشترك في الأحداث عبر POST /api/v1/developers/webhooks . يحمل كل تسليم توقيع HMAC-SHA256 في X-CLH-Signature.

سياسة إعادة المحاولة

6 محاولات تسليم بتراجع أُسّي يبدأ من 30 ثانية. الطلبات التي لا تُرجع 2xx تنتهي في سجل الرسائل الميتة، يمكن عرضه عبر GET /developers/webhooks/:id/deliveries

هيدر التوقيعnode
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

حدود المعدل

الافتراضي: 60 طلبًا / دقيقة / مفتاح API. ترفع باقات المؤسسات الحدود.

ship faster

هل أنت جاهز للتكامل؟ أنشئ المفاتيح من

لوحة تحكم المطور