API құжаттамасы

LogiHub платформасының REST API — тапсырыстарды біріктіру, жүктерді қадағалау және логистикалық процестерді автоматтандыру үшін. Тасымалдаушылар мен серіктестерге арналған.

API туралы

LogiHub API тасымалдаушылар мен серіктестерге өз жүйелерін платформаға біріктіруге мүмкіндік береді: тапсырыстарды алу және жаңарту, жеткізу мәртебелерін беру, жүктерді қадағалау деректерін алу. Барлық сұраулар HTTPS протоколы арқылы JSON форматында орындалады.

API-ге қолжетімділік платформада тіркелген тасымалдаушы компанияларға беріледі. API кілті компанияның жеке кабинетінде «API кілттері» бөлімінде жасалады.

Негізгі URL және аутентификация

Барлық API сұраулары негізгі URL мекенжайына жіберіледі. Қол жеткізу үшін API кілтін сұрау параметрі немесе тақырып арқылы жіберіңіз.

Негізгі URL

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

Аутентификация

API кілтін api_key параметрінде немесе X-API-Key тақырыбында жіберіңіз. Кілт компанияның жеке кабинетінде беріледі.

API-дің негізгі бөлімдері

Тапсырыстармен және трекингпен жұмыс істеуге арналған қолжетімді ресурстар.

Бөлім Сипаттама
orders.php Компания тапсырыстарының тізімін алу, мәртебе және күн бойынша сүзгiлеу. Интеграция кезінде тапсырыстарды жасау және жаңарту.
tracking.php Тапсырыс идентификаторы бойынша жүктi қадағалау мәртебесі мен оқиғаларын алу.
companies.php Тасымалдаушы компаниялар туралы анықтамалық ақпарат (публикалық қолжетімділік қосылған болса).

Әдістер мен параметрлердің толық тізімі компанияның жеке кабинетінде «API кілттері» бөлімінде, жүйеге кіргеннен кейін қолжетімді.

Сұрау мысалы

API кілтін параметр ретінде бере отырып, тапсырыстар тізімін (GET) алу.

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

YOUR_API_KEY мәнін компанияның жеке кабинетінде құрылған өз кілтіңізге ауыстырыңыз.

Бастау жолы

API тасымалдаушы компанияларға қолжетімді. Платформада тіркеліңіз, компанияңызды растаңыз және жеке кабинетте API кілтін жасаңыз.

API бойынша сұрақтар

Интеграция бойынша техникалық сұрақтар үшін қолдау қызметіне жүгініңіз.