Обзор API¶

API CARGO.RUN Загрузки работает по HTTP/HTTPS и использует JSON для запросов и ответов.

1. Базовый URL¶

Фактический базовый URL предоставляется при подключении интеграции.

В примерах используется:

<baseUrl>

Итоговый URL метода:

<baseUrl>/api/Orders/GetIntegrationList

В большинстве методов требуется заголовок:

Authorization: Bearer <access_token>

Типовые коды:

Код	Значение
`200`	Успешное выполнение
`400`	Ошибка валидации или бизнес-логики
`401`	Нет авторизации или токен недействителен
`500`	Внутренняя ошибка сервера

При ошибке 400 тело ответа может содержать подробности валидации.

Методы списков обычно поддерживают:

Ответ:

{
  "data": [],
  "totalCount": 0
}

Раздел	Назначение
Авторизация	Получение и обновление токена
Orders API	Создание и получение заказов
Order Lifecycle API	Запуск, отмена, возврат в черновик, удаление
Order Responses API	Отклики и выбор перевозчика
Отчеты API	Данные заказов для отчетности и BI
Counterparties API	Контрагенты, адреса, контактные лица, надежность и лимиты
Map API	Адреса, координаты и маршруты
Directories API	Справочники
Transporter API	Методы перевозчика