API-Dokumentation

REST API der LogiHub-Plattform zur Integration von Aufträgen, Sendungsverfolgung und Automatisierung logistischer Prozesse. Für Speditionen und Partner.

Über das API

Das LogiHub API ermöglicht es Speditionen und Partnern, ihre Systeme mit der Plattform zu integrieren: Aufträge abrufen und aktualisieren, Lieferstatus übermitteln und Trackingdaten für Sendungen erhalten. Alle Anfragen erfolgen über HTTPS im JSON-Format.

Der API-Zugang wird Speditionen nach der Registrierung auf der Plattform bereitgestellt. Der API-Schlüssel wird im Unternehmens-Dashboard im Bereich „API-Schlüssel“ erstellt.

Basis-URL und Authentifizierung

Alle API-Anfragen werden an die Basis-URL gesendet. Für den Zugriff übermitteln Sie den API-Schlüssel als Parameter oder im Header.

Basis-URL

https://logihub.kz/api/v1/

Authentifizierung

Übermitteln Sie den API-Schlüssel im Parameter api_key oder im Header X-API-Key. Der Schlüssel wird im Unternehmens-Dashboard vergeben.

Wichtige API-Bereiche

Verfügbare Ressourcen für die Arbeit mit Aufträgen und Tracking.

Bereich	Beschreibung
`orders.php`	Abruf der Auftragsliste eines Unternehmens, Filterung nach Status und Datum. Erstellen und Aktualisieren von Aufträgen im Integrationskontext.
`tracking.php`	Abruf des Status und der Tracking-Ereignisse einer Sendung anhand der Auftrags-ID.
`chats.php`	Получение списка чатов и создание нового чата (по заказу, с компанией или в поддержку).
`companies.php`	Stammdaten zu Speditionen (falls öffentlicher Zugriff aktiviert ist).
`ai-recommendations.php`	Рекомендации по направлениям и аналитические подсказки (если включено).

Die vollständige Liste der Methoden und Parameter ist nach dem Login im Unternehmens-Dashboard im Bereich „API-Schlüssel“ verfügbar.

Методы и параметры

Ниже приведены основные методы API v1. Все ответы — JSON.

GET https://logihub.kz/api/v1/orders.php Список заказов компании

Параметры

name	type	required	description
`status`	string	no	Фильтр по статусу заказа
`limit`	int	no	Количество записей (1…200), по умолчанию 50
`offset`	int	no	Смещение (>= 0), по умолчанию 0

Пример

curl -s 'https://logihub.kz/api/v1/orders.php?status=confirmed&limit=10' \
  -H 'X-API-Key: YOUR_API_KEY'

Ответ

{
  "orders": [ ... ],
  "total": 123,
  "limit": 10,
  "offset": 0
}

POST https://logihub.kz/api/v1/orders.php Создание заказа

Тело запроса (JSON)

field	type	required	description
`user_id`	int	yes	ID клиента (пользователя)
`from_address`	string	yes	Адрес отправления
`to_address`	string	yes	Адрес доставки
`from_city`	string	no	Город отправления
`to_city`	string	no	Город доставки
`cargo_type`	string	no	Тип груза
`cargo_description`	string	no	Описание груза
`weight`	number	no	Вес груза
`price`	number	no	Стоимость
`delivery_date`	string	no	Плановая дата доставки (строка)

Пример

curl -s 'https://logihub.kz/api/v1/orders.php' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  --data-raw '{
    "user_id": 123,
    "from_address": "Алматы, ...",
    "to_address": "Астана, ...",
    "weight": 1200
  }'

Ответ

{
  "success": true,
  "order_id": 987
}

GET https://logihub.kz/api/v1/tracking.php События отслеживания по заказу

Параметры

name	type	required	description
`order_id`	int	yes	ID заказа

Пример

curl -s 'https://logihub.kz/api/v1/tracking.php?order_id=987' \
  -H 'X-API-Key: YOUR_API_KEY'

Ответ

{
  "events": [ ... ]
}

POST https://logihub.kz/api/v1/tracking.php Добавить событие отслеживания

Тело запроса (JSON)

field	type	required	description
`order_id`	int	yes	ID заказа
`event_type`	string	yes	Тип события (например: pickup, transit, delivery)
`location`	string	no	Локация
`title`	string	no	Заголовок события
`description`	string	no	Описание

Пример

curl -s 'https://logihub.kz/api/v1/tracking.php' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY' \
  --data-raw '{
    "order_id": 987,
    "event_type": "transit",
    "location": "Караганда",
    "title": "В пути"
  }'

Ответ

{
  "success": true,
  "event_id": 555
}

GET https://logihub.kz/api/v1/chats.php Список чатов

Метод поддерживает авторизацию через браузерную сессию (если вы вошли на сайте), а также через API-ключ компании.

curl -s 'https://logihub.kz/api/v1/chats.php' \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST https://logihub.kz/api/v1/chats.php Создать чат

Тело запроса (JSON)

field	type	required	description
`chat_type`	string	yes	Тип: order \| company \| support
`message`	string	no	Первое сообщение (если нужно)
`order_number`	string	depends	Обязателен при chat_type=order
`company_name`	string	depends	Обязателен при chat_type=company
`subject`	string	depends	Обязателен при chat_type=support
`description`	string	no	Описание обращения (support)
`category`	string	no	Категория (support)
`priority`	string	no	Приоритет (support): low/medium/high/urgent

Пример

curl -s 'https://logihub.kz/api/v1/chats.php' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY' \
  --data-raw '{
    "chat_type": "support",
    "subject": "Проблема с интеграцией",
    "description": "Опишите проблему",
    "priority": "medium"
  }'

Ошибки

code	meaning
`400`	Неверные параметры запроса
`401`	Нет доступа (не передан / неверный API-ключ)
`404`	Ресурс не найден
`429`	Лимит запросов превышен
`500`	Внутренняя ошибка сервера

Beispielanfrage

Abruf der Auftragsliste (GET) mit Übergabe des API-Schlüssels als Parameter.

GET https://logihub.kz/api/v1/orders.php?api_key=YOUR_API_KEY&status=confirmed&limit=10

Ersetzen Sie YOUR_API_KEY durch Ihren Schlüssel aus dem Unternehmens-Dashboard.

Erste Schritte

Das API steht Speditionen zur Verfügung. Registrieren Sie sich auf der Plattform, verifizieren Sie Ihr Unternehmen und erstellen Sie einen API-Schlüssel im Dashboard.

Unternehmen registrieren Anmelden

Fragen zum API

Bei technischen Fragen zur Integration wenden Sie sich an den Support.

support@logihub.kz