API Поиска активных перевозчиков

Описание

Поможет найти наиболее активных и заинтересованных Перевозчиков по заданному направлению.

Подходит вам, если:

Хотите найти надежных партнеров для долгосрочного сотрудничества;
Находитесь в поиске перевозчиков для нового или непопулярного направления;
Не хотите размещать грузы в общем доступе и самостоятельно ищете перевозчиков, которые стабильно работают по нужному направлению.

Воспользовавшись поиском Вы увидите, как часто участники ищут грузы в заданном направлении. А также сколько объявлений о свободных ТС, потенциально интересных вам, они добавляли на сайт за указанный вами период.

Подробнее об информации, возвращаемой API, смотрите в описании методов.

Доступ к API

Подключить API можно как и любую другую лицензию на странице оплаты.

Если у вас остались вопросы — напишите в техническую поддержку на api@ati.su.

Методы

Для проверки корректности интеграции с данным API в запросах, описанных ниже, можно указать необязательный параметр, позволяющий получить демо-данные:

demo - Флаг демо-режима (Boolean)

При указании этого параметра сервером будет возвращен тестовый набор данных с тем же контрактом ответа, что и в полноценном API.

Метод поиска по направлению

Получение списка самых активных перевозчиков для заданного направления.

Получение активных перевозчиков по заданным параметрам

post

/v1.0/dstats/active_firms/search

demo

boolean

Использовать демо-режим

Развернуть все Свернуть все

body

object

Параметры запроса

{...}

begin_date*: date-time

Дата, от которой ведется поиск активных фирм в формате ISO-8601

from*:{...}

Локация: откуда

id*: int32

Id локации
Значение из словаря

type*: enum

[0, 1, 2]

Тип локации

0 - страна
1 - регион
2 - город

}

to*:{...}

Локация: куда

id*: int32

Id локации
Значение из словаря

type*: enum

[0, 1, 2]

Тип локации

0 - страна
1 - регион
2 - город

}

truck_type: int64

Маска типа кузова
Значение из словаря кузовов АТИ

truck_volume:{...}

Диапазон объёма кузова в метрах кубических

from: int32

Значение от

to: int32

Значение до

}

truck_weight:{...}

Диапазон грузоподъёмности в тоннах

from: int32

Значение от

to: int32

Значение до

}

volume: int32

Объём в метрах кубических

weight: int32

Вес в тоннах

}

CURL

Копировать

Пример ответа

Ответ

200 Активные перевозчики

Развернуть все Свернуть все

Пример

Модель

{...}

"is_demo":false,

"ok":false,

"result":[...]

{...}

"id":"string",

"inn":"string",

"search_count":0,

"sum_count":0,

"trucks_count":0

}

]

}

{...}

is_demo*: boolean

Это демо-данные?

ok*: boolean

Успешно?

result*:[{...}]

Список активных фирм

id: string

ID фирмы

inn: string

ИНН фирмы, если указан

search_count*: int32

Сколько за период представители этой фирмы искали грузы по выбранному направлению

sum_count*: int32

Сумма search_count и trucks_count

trucks_count*: int32

Сколько за период представители этой фирмы размещали машин по выбранному направлению на вкладке "Транспорт"

}]

}

400 Ошибка в запросе

Развернуть все Свернуть все

Пример

Модель

{...}

"details":"?",

"error_code":"string",

"error_list":[...],

{}

"reason":"string"

}

{...}

details*: {missing-type-info}

Детали ошибки

error_code*: string

Код ошибки

error_list*:[{}]

Список вложенных ошибок

reason*: string

Причина ошибки

}

403 У вас нет доступа к данному API

Развернуть все Свернуть все

Пример

Модель

{...}

"details":"?",

"error_code":"string",

"error_list":[...],

{}

"reason":"string"

}

{...}

details*: {missing-type-info}

Детали ошибки

error_code*: string

Код ошибки

error_list*:[{}]

Список вложенных ошибок

reason*: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение активных перевозчиков по заданным параметрам (только по городам)

Данная версия метода устарела и её поддержка будет прекращена.
Пожалуйста, пользуйтесь актуальной версией API.

post

/v1.0/dstats/active_firms

demo

boolean

Использовать демо-режим

Развернуть все Свернуть все

body

object

Параметры запроса

{...}

begin_date*: date-time

Дата, от которой ведется поиск активных фирм в формате ISO-8601

city_from*: int32

ID города откуда
Значение из словаря

city_to*: int32

ID города куда
Значение из словаря

truck_type: int64

Маска типа кузова
Значение из словаря кузовов АТИ

truck_volume:{...}

Диапазон объёма кузова в метрах кубических

from: int32

Значение от

to: int32

Значение до

}

truck_weight:{...}

Диапазон грузоподъёмности в тоннах

from: int32

Значение от

to: int32

Значение до

}

volume: int32

Объём в метрах кубических

weight: int32

Вес в тоннах

}

CURL

Копировать

Пример ответа

Ответ

200 Активные перевозчики

Развернуть все Свернуть все

Пример

Модель

{...}

"is_demo":false,

"ok":false,

"result":[...]

{...}

"id":"string",

"inn":"string",

"search_count":0,

"sum_count":0,

"trucks_count":0

}

]

}

{...}

is_demo*: boolean

Это демо-данные?

ok*: boolean

Успешно?

result*:[{...}]

Список активных фирм

id: string

ID фирмы

inn: string

ИНН фирмы, если указан

search_count*: int32

Сколько за период представители этой фирмы искали грузы по выбранному направлению

sum_count*: int32

Сумма search_count и trucks_count

trucks_count*: int32

Сколько за период представители этой фирмы размещали машин по выбранному направлению на вкладке "Транспорт"

}]

}

400 Ошибка в запросе

Развернуть все Свернуть все

Пример

Модель

{...}

"details":"?",

"error_code":"string",

"error_list":[...],

{}

"reason":"string"

}

{...}

details*: {missing-type-info}

Детали ошибки

error_code*: string

Код ошибки

error_list*:[{}]

Список вложенных ошибок

reason*: string

Причина ошибки

}

403 У вас нет доступа к данному API

Развернуть все Свернуть все

Пример

Модель

{...}

"details":"?",

"error_code":"string",

"error_list":[...],

{}

"reason":"string"

}

{...}

details*: {missing-type-info}

Детали ошибки

error_code*: string

Код ошибки

error_list*:[{}]

Список вложенных ошибок

reason*: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Метод поиска по направлению с количеством актуальных машин

Получение списка самых активных перевозчиков и количество их актуальных машин для заданного направления.

Получение активных перевозчиков по заданным параметрам

post

/v2/dstats/active_firms/search

demo

boolean

Использовать демо-режим

Развернуть все Свернуть все

body

Параметры запроса

{...}

begin_date*: date-time

Дата, от которой ведется поиск активных фирм в формате ISO-8601

from*:{...}

Локация: откуда

id*: int32

Id локации
Значение из словаря

type*: enum

[0, 1, 2]

Тип локации

0 - страна
1 - регион
2 - город

}

to*:{...}

Локация: куда

id*: int32

Id локации
Значение из словаря

type*: enum

[0, 1, 2]

Тип локации

0 - страна
1 - регион
2 - город

}

truck_type: int64

Маска типа кузова
Значение из словаря кузовов АТИ

truck_volume:{...}

Диапазон объёма кузова в метрах кубических

from: int32

Значение от

to: int32

Значение до

}

truck_weight:{...}

Диапазон грузоподъёмности в тоннах

from: int32

Значение от

to: int32

Значение до

}

volume: int32

Объём в метрах кубических

weight: int32

Вес в тоннах

trucks_date_from: date-time

Дата, от которой ведется поиск актуальных машин в формате ISO-8601. Если отсутствует в запросе, то используется значение begin_date

trucks_date_to: date-time

Дата, до которой ведется поиск актуальных машин в формате ISO-8601. Должна быть больше даты начала поиска машин. Если отсутствует в запросе, то результат поиска не ограничивается сверху

}

CURL

Копировать

Пример ответа

Ответ

200 Активные перевозчики

Развернуть все Свернуть все

Пример

Модель

{...}

"is_demo":false,

"ok":false,

"result":[...]

{...}

"actual_trucks_count":0,

"id":"string",

"inn":"string",

"search_count":0,

"sum_count":0,

"trucks_count":0

}

]

}

{...}

is_demo*: boolean

Это демо-данные?

ok*: boolean

Успешно?

result*:[{...}]

Список активных фирм

actual_trucks_count*: int32

Сколько в данный момент у пользователя есть машин по этому направлению

id: string

ID фирмы

inn: string

ИНН фирмы, если указан

search_count*: int32

Сколько за период представители этой фирмы искали грузы по выбранному направлению

sum_count*: int32

Сумма search_count и trucks_count

trucks_count*: int32

Сколько за период представители этой фирмы размещали машин по выбранному направлению на вкладке "Транспорт"

}]

}

400 Ошибка в запросе

Развернуть все Свернуть все

Пример

Модель

{...}

"details":"?",

"error_code":"string",

"error_list":[...],

{}

"reason":"string"

}

{...}

details*: {missing-type-info}

Детали ошибки

error_code*: string

Код ошибки

error_list*:[{}]

Список вложенных ошибок

reason*: string

Причина ошибки

}

403 У вас нет доступа к данному API

Развернуть все Свернуть все

Пример

Модель

{...}

"details":"?",

"error_code":"string",

"error_list":[...],

{}

"reason":"string"

}

{...}

details*: {missing-type-info}

Детали ошибки

error_code*: string

Код ошибки

error_list*:[{}]

Список вложенных ошибок

reason*: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение активных перевозчиков по заданным параметрам (только по городам)

post

/v2/dstats/active_firms

demo

boolean

Использовать демо-режим

Развернуть все Свернуть все

body

Параметры запроса

{...}

begin_date*: date-time

Дата, от которой ведется поиск активных фирм в формате ISO-8601

city_from*: int32

ID города откуда
Значение из словаря

city_to*: int32

ID города куда
Значение из словаря

truck_type: int64

Маска типа кузова
Значение из словаря кузовов АТИ

truck_volume:{...}

Диапазон объёма кузова в метрах кубических

from: int32

Значение от

to: int32

Значение до

}

truck_weight:{...}

Диапазон грузоподъёмности в тоннах

from: int32

Значение от

to: int32

Значение до

}

volume: int32

Объём в метрах кубических

weight: int32

Вес в тоннах

trucks_date_from: date-time

trucks_date_to: date-time

}

CURL

Копировать

Пример ответа

Ответ

200 Активные перевозчики

Развернуть все Свернуть все

Пример

Модель

{...}

"is_demo":false,

"ok":false,

"result":[...]

{...}

"actual_trucks_count":0,

"id":"string",

"inn":"string",

"search_count":0,

"sum_count":0,

"trucks_count":0

}

]

}

{...}

is_demo*: boolean

Это демо-данные?

ok*: boolean

Успешно?

result*:[{...}]

Список активных фирм

actual_trucks_count*: int32

Сколько в данный момент у пользователя есть машин по этому направлению

id: string

ID фирмы

inn: string

ИНН фирмы, если указан

search_count*: int32

Сколько за период представители этой фирмы искали грузы по выбранному направлению

sum_count*: int32

Сумма search_count и trucks_count

trucks_count*: int32

Сколько за период представители этой фирмы размещали машин по выбранному направлению на вкладке "Транспорт"

}]

}

400 Ошибка в запросе

Развернуть все Свернуть все

Пример

Модель

{...}

"details":"?",

"error_code":"string",

"error_list":[...],

{}

"reason":"string"

}

{...}

details*: {missing-type-info}

Детали ошибки

error_code*: string

Код ошибки

error_list*:[{}]

Список вложенных ошибок

reason*: string

Причина ошибки

}

403 У вас нет доступа к данному API

Развернуть все Свернуть все

Пример

Модель

{...}

"details":"?",

"error_code":"string",

"error_list":[...],

{}

"reason":"string"

}

{...}

details*: {missing-type-info}

Детали ошибки

error_code*: string

Код ошибки

error_list*:[{}]

Список вложенных ошибок

reason*: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...