Введение¶

API CARGO.RUN Загрузки предназначен для обмена данными между CARGO.RUN и внешними учетными системами грузоотправителей, экспедиторов и перевозчиков.

Документация разделена на три части:

общие правила работы с API;
сценарии интеграции;
технический справочник методов.

1. Основной сценарий API¶

Основной сценарий интеграции связан с заказами грузоотправителя или экспедитора.

Внешняя система может:

создавать заказы в CARGO.RUN;
получать список заказов и их изменения;
получать отклики перевозчиков;
принимать отклик выбранного перевозчика;
получать данные о перевозчике, ТС, водителе и исполнении заказа;
синхронизировать статусы и фактические времена по точкам маршрута.

Типовые внешние системы:

1С;
ERP;
TMS;
WMS;
корпоративные интеграционные сервисы.

2. Дополнительный сценарий перевозчика¶

API также поддерживает сценарий перевозчика.

Перевозчик может:

зарегистрировать организацию;
авторизоваться;
получать доступные заказы;
отправлять отклики;
управлять справочниками ТС, прицепов и водителей;
получать назначенные заявки;
передавать фактические времена по точкам маршрута.

Этот сценарий описан отдельно, чтобы не смешивать действия владельца заказа и действия перевозчика.

3. Архитектура интеграции¶

API работает как REST API:

обмен выполняется по HTTPS;
запросы и ответы передаются в JSON;
авторизация выполняется через JWT-токен;
для списков используется фильтрация и пагинация в query-параметрах;
большинство методов возвращают HTTP 200 OK при успехе и ошибку 400, 401 или 500 при проблеме.

4. Основные потоки данных¶

Поддерживаются два основных потока.

Учетная система → CARGO.RUN¶

Заказ создается во внешней системе и передается в CARGO.RUN через API. Затем CARGO.RUN используется для публикации заказа, получения откликов, выбора перевозчика и контроля исполнения.

CARGO.RUN → учетная система¶

Пользователь создает заказ в интерфейсе CARGO.RUN. Внешняя система периодически получает новые и измененные заказы, сохраняет их у себя и забирает результаты выполнения.

5. Что изучать дальше¶

Для начала интеграции рекомендуется:

изучить глоссарий;
настроить авторизацию;
выбрать основной сценарий интеграции;
проверить минимальные требования к созданию заказа;
перейти к Orders API.