Тема
InLog Platform
InLog Platform — B2B-платформа управления логистикой и доставкой: посылки и грузы, компании-участники, пункты выдачи, постоматы и вебхуки. Интеграционный API платформы позволяет системе вашей компании получать данные о посылках и грузах, создавать посылки, работать с постоматами через платформу и получать события на свой URL.
Получить API-ключКомпании-участники
Каждая организация на платформе — компания одного из типов:
| Тип | Кто это |
|---|---|
LOGIST | Логистическая компания |
WAREHOUSE | Складская компания |
COURIER | Курьерская компания |
TRANSPORT | Транспортная компания |
BROKER | Брокер |
PARTNERS | Компания-партнёр |
Дополнительно у компании может быть подтип: PVZ_PROVIDER (оператор пунктов выдачи), POSTOMAT_PROVIDER (оператор постоматов), MARKETPLACE (маркетплейс). Набор доступных данных определяется тем, к какой компании относится ваш API-ключ.
Окружения
| Окружение | Хост |
|---|---|
| Продакшн | https://api.inlog.ai |
| Тестовое | https://api.test.inlog.ai |
В отличие от Postomat, пути API платформы указываются полностью от хоста, например GET https://api.inlog.ai/api/v1/public/cargo-types.
Как подключиться
- Получите доступ. Администратор вашей компании входит в платформу и создаёт API-ключ — см. Авторизация.
- Вызывайте интеграционные API (
/api/v1/integrations/*) с заголовкомx-api-token— см. раздел «Интеграционные API» в меню. - Подпишитесь на события. Администратор компании настраивает вебхуки — см. Вебхуки.
Разделы
| Раздел | Что внутри |
|---|---|
| Быстрый старт | Первые запросы с curl и JavaScript |
| Авторизация | Вход администратора, API-ключи компании |
| Клиенты | Данные клиентов компании |
| Курьерские компании | Данные компании по ID |
| Постоматы через платформу | Постоматы и заявки в постоматы через платформу |
| Логистика и маркетплейс | Логистические компании, поставщики, списки посылок и грузов с фильтрами, API маркетплейса |
| Публичные справочники | Типы грузов без авторизации |
| Прочие эндпоинты | Сводная таблица остальных интеграционных эндпоинтов |
| Жизненный цикл посылки | Статусы посылки и постоматные события |
| Вебхуки | Управление вебхуками и формат событий |
| Ошибки | Формат ошибок и каталог кодов |
| API Reference | Полные таблицы параметров |
Swagger UI
Интерактивное описание API платформы разбито на несколько групп. Путь указывается от хоста, например https://api.test.inlog.ai/platform/docs:
| Путь | Что описано |
|---|---|
/platform/docs | Авторизация, публичные эндпоинты, интеграции клиентов, курьерских компаний и постоматов |
/integration/logistic/docs | Интеграционные эндпоинты логистических компаний |
/integration/market/docs | API маркетплейса (market-company) |
/integration/warehouse/docs | Интеграционные эндпоинты складских компаний |
/integration/sorting/docs | Интеграционные эндпоинты сортировочных компаний |
/integration/partners/docs | Интеграционные эндпоинты компаний-партнёров |
В Swagger UI перечислено больше эндпоинтов, чем нужно для интеграции. Опирайтесь на этот портал: здесь описаны только эндпоинты для партнёров.