ChinaLogisticHub
Начать

API · v1

Разработчикам

Интегрируйте ChinaLogisticHub с вашими ERP, TMS или BI через подписанный REST API и вебхуки, верифицированные 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

Вебхуки

Подпишитесь на события через 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

Готовы интегрироваться? Создайте ключи в вашей

панели разработчика