Обзор
Получите API-ключ и первый результат отслеживания
Получайте историю перемещений контейнеров по номеру контейнера, коносамента или букинга через API Cargotime.
Получите API-ключ
Создайте ключ в личном кабинете и передавайте его в query-параметре api_key в URL запроса. Для знакомства с API доступен бесплатный тестовый период, который можно оформить в личном кабинете. Для дальнейшей работы оформите платный тариф.
Отправьте запрос на отслеживание
Укажите SCAC-код перевозчика или company=AUTO для автоматического поиска перевозчика. Оба варианта доступны для контейнеров, коносаментов и букингов, с явным типом или без него.
Чтобы автоматически выбрать тип номера, не передавайте type в GET /v2/tracking или track_number.type у элемента POST /v2/tracking/batch. company остаётся обязательным. Явные container, bl и bk сохраняют выбранный способ поиска; null, пустая строка и AUTO недопустимы в поле типа. Автопоиск возвращает один выбранный результат, а не список вариантов.
GET https://tracking.cargotime.ru/v2/tracking?api_key=YOUR_TOKEN&company=AUTO&value=MSDU8368827
Accept: application/jsonОбработайте результат
Проверьте HTTP-статус, затем поля success и status в ответе. При status: "OK" данные отслеживания находятся в data. Статус INFO_NOT_FOUND означает, что запрос обработан, но данных по указанному номеру нет. Остальные статусы и рекомендации приведены в разделе «Ошибки».
Запрос по одному номеру возвращает результат сразу в ответе. Для нескольких номеров создайте задачу через POST /v2/tracking/batch, а затем получите её результаты через GET /v2/tracking/batch. Подробнее — в примере пакетного отслеживания.
Продолжайте работу
Используйте примеры запросов, изучите аутентификацию и ограничения или подключите вебхуки, чтобы получать уведомления об изменениях в перевозках. Все операции и поля описаны в справочнике API. Спецификацию можно скачать в формате OpenAPI.
Переходите с другого сервиса? Выберите гайд по миграции, чтобы сопоставить запросы, ответы и вебхуки.
Обновлено