API Поиска активных перевозчиков
Описание
Поможет найти наиболее активных и заинтересованных Перевозчиков по заданному направлению.
Подходит вам, если:
- Хотите найти надежных партнеров для долгосрочного сотрудничества;
- Находитесь в поиске перевозчиков для нового или непопулярного направления;
- Не хотите размещать грузы в общем доступе и самостоятельно ищете перевозчиков, которые стабильно работают по нужному направлению.
Воспользовавшись поиском Вы увидите, как часто участники ищут грузы в заданном направлении. А также сколько объявлений о свободных ТС, потенциально интересных вам, они добавляли на сайт за указанный вами период.
Подробнее об информации, возвращаемой API, смотрите в описании метода.
Доступ к API
Подключить API можно как и любую другую лицензию на странице оплаты.
Если у вас остались вопросы — напишите в техническую поддержку на api@ati.su.
Методы
Методы с тегом Есть демо можно проверить на корректность интеграции с данными API:
передайте в параметрах запроса demo=true
Подробности во вкладке «Модель и примеры», отправить запрос можно во вкладке «Консоль».
Метод поиска по направлению с количеством актуальных машин
Получение списка самых активных перевозчиков и количество их актуальных машин для заданного направления.
Находит активных перевозчиков по направлению и возвращает количество их актуальных машин. Поиск выполняется между двумя локациями: странами, регионами или городами.
Укажите период активности, локации from и to; при необходимости добавьте параметры ТС.
Требуются авторизация Bearer и доступ к API поиска активных перевозчиков.
При demo=true после проверки параметров возвращаются демонстрационные данные без проверки платного доступа. Есть демо
Метод можно проверить на тестовых данных: передайте в параметрах
запроса demo=true
post /v2/dstats/active_firms/search
| Параметр | Тип | Расположение | Описание |
|---|---|---|---|
demo | boolean | query | Вернуть демонстрационные данные. По умолчанию false. Пример: false |
Параметры поиска активных перевозчиков с количеством актуальных машин.
Начало периода активности в формате ISO-8601. Обязательно; дата не должна быть позже текущей.
Конец периода активности в формате ISO-8601. Если не задан, используется текущее время UTC.
Локация отправления. Для поиска по направлению обязательна.
Положительный ID локации из географического справочника. Подставьте ID страны, региона или города в соответствии с полем type.
Тип локации
0- страна1- регион2- город
012
Коэффициенты ранжирования результатов. Если не заданы, используются настройки сервиса.
Коэффициент бонуса актуальных ТС на сайте.
Коэффициент бонуса размещённых ТС.
Коэффициенты по профилям фирм. Ключ — строковое представление ID из
справочника профилей (GET /v1.0/firms/dictionaries/account/firmtypes).
Ключ "0" задаёт коэффициент для неуказанных профилей. Если его нет, используются настройки сервиса.
Коэффициент бонуса реального перевозчика.
Локация назначения. Для поиска по направлению обязательна.
Положительный ID локации из географического справочника. Подставьте ID страны, региона или города в соответствии с полем type.
Тип локации
0- страна1- регион2- город
012
Битовая маска типов кузова. Получите словарь кузовов через GET /gw/marshak/v1/cartypes?attributeFieldFormat=2 и используйте числовое значение атрибута mask, а не ID элемента. Для нескольких типов объедините маски побитовым OR; тип выбран, если (truck_type & mask) == mask. Например, для масок 1 и 4 результат 1 | 4 = 5. Если поле не задано, фильтра по типу кузова нет.
Диапазон объёма ТС в кубических метрах. Используется вместо volume.
Нижняя граница, больше нуля и не больше верхней границы. Если не задана, нижнего ограничения нет.
Верхняя граница, больше нуля. Если не задана, верхнего ограничения нет.
Диапазон грузоподъёмности ТС в тоннах. Используется вместо weight.
Нижняя граница, больше нуля и не больше верхней границы. Если не задана, нижнего ограничения нет.
Верхняя граница, больше нуля. Если не задана, верхнего ограничения нет.
Начало периода поиска актуальных машин в формате ISO-8601. Если поле не задано, используется begin_date.
Конец периода поиска актуальных машин в формате ISO-8601. Дата должна быть не раньше trucks_date_from (или begin_date, если trucks_date_from не задано). Если поле не задано, верхняя граница периода не ограничена.
Объём в кубических метрах, больше нуля. Не задавайте одновременно с границами truck_volume.
Вес в тоннах, больше нуля. Не задавайте одновременно с границами truck_weight.
curl 'https://api.ati.su/v2/dstats/active_firms/search' \ -X 'POST' \ -H 'Authorization: Bearer {authorizationToken}' \ -H 'Content-Type: application/json' \ --data-raw '{"begin_date":"2024-01-15T00:00:00Z","end_date":"2024-01-31T23:59:59Z","from":{"id":1,"type":2},"rating_coefficients":{"actual_trucks":0.6,"analytics_trucks":2,"profile":{"0":0.45,"1":1},"real_trucker":0.6},"to":{"id":2,"type":2},"truck_type":1,"trucks_date_from":"2024-01-15T00:00:00Z","trucks_date_to":"2024-01-31T23:59:59Z","volume":82,"weight":20}'Процедура ВыполнитьHTTPЗапрос(МетодЗапроса, АдресХоста, АдресРесурса, ТекстЗапроса) Экспорт ЗаголовкиHTTP = Новый Соответствие(); ЗаголовкиHTTP.Вставить("Accept", "application/json"); ЗаголовкиHTTP.Вставить("Content-Type", "application/json"); ЗаголовкиHTTP.Вставить("Authorization", "Bearer {authorizationToken}"); HTTPЗапрос = Новый HTTPЗапрос(АдресРесурса, ЗаголовкиHTTP); HTTPЗапрос.УстановитьТелоИзСтроки(ТекстЗапроса, КодировкаТекста.UTF8, ИспользованиеByteOrderMark.НеИспользовать); ЗащищенноеСоединениеSSL = Новый ЗащищенноеСоединениеOpenSSL(Новый СертификатКлиентаWindows, Новый СертификатыУдостоверяющихЦентровWindows);
Соединение = Новый HTTPСоединение(АдресХоста,,,,,, ЗащищенноеСоединениеSSL);
Попытка Ответ = Соединение.ВызватьHTTPМетод(МетодЗапроса, HTTPЗапрос); Сообщить("Код ответа: " + Ответ.КодСостояния); Сообщить("Ответ: " + Ответ.ПолучитьТелоКакСтроку("UTF-8")); Исключение Сообщить("Ошибка выполнения запроса!" + Символы.ПС + ОписаниеОшибки()); КонецПопытки;КонецПроцедуры
ВыполнитьHTTPЗапрос("POST", "https://api.ati.su", "/v2/dstats/active_firms/search", "{""begin_date"":""2024-01-15T00:00:00Z"",""end_date"":""2024-01-31T23:59:59Z"",""from"":{""id"":1,""type"":2},""rating_coefficients"":{""actual_trucks"":0.6,""analytics_trucks"":2,""profile"":{""0"":0.45,""1"":1},""real_trucker"":0.6},""to"":{""id"":2,""type"":2},""truck_type"":1,""trucks_date_from"":""2024-01-15T00:00:00Z"",""trucks_date_to"":""2024-01-31T23:59:59Z"",""volume"":82,""weight"":20}"); 200 Активные перевозчики
Результат поиска активных перевозчиков.
Признак демо-данных; true при запросе с demo=true.
Признак успешного выполнения запроса.
Найденные активные фирмы. Пустой массив, если подходящих фирм нет.
Количество актуальных машин фирмы по направлению с учётом trucks_date_from и trucks_date_to.
Код фирмы в ATI.SU. Может быть null, если отсутствует в исходных данных.
ИНН фирмы. Может быть null, если не указан.
Количество поисков грузов представителями фирмы по направлению за указанный период.
Сумма search_count и trucks_count.
Количество объявлений фирмы на вкладке «Транспорт» по направлению за указанный период.
400 Ошибка в запросе
Описание ошибки выполнения запроса.
Дополнительные сведения, зависящие от ошибки. Пустой объект, если сведений нет.
Код ошибки.
Вложенные ошибки. Пустой массив, если вложенных ошибок нет.
Причина ошибки.
403 У вас нет доступа к данному API
Описание ошибки выполнения запроса.
Дополнительные сведения, зависящие от ошибки. Пустой объект, если сведений нет.
Код ошибки.
Вложенные ошибки. Пустой массив, если вложенных ошибок нет.
Причина ошибки.