API Ставок в похожих грузах

API предоставляет средние значения ставок участников ATI.SU для похожих грузов.

Учитываются параметры груза: направление перевозки, тип груза и кузова, объём, вес, тип упаковки, количество мест и класс опасности, а также тип оплаты: с НДС, без НДС и наличными.

Как получить доступ к API

Чтобы получить доступ к API – подключите лицензию «API Средних ставок» на странице оплаты.

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

Методы

Методы с тегом Есть демо можно проверить на корректность интеграции с данными API: передайте в параметрах запроса demo=true

Подробности во вкладке «Модель и примеры», отправить запрос можно во вкладке «Консоль».

Получение ставок в похожих грузах

Ставки в похожих грузах - API Есть демо

post /webapi/bazaar/v1/price_prediction_api

Модель и примеры
Консоль

Параметры

Параметр	Тип	Расположение	Описание
`demo`	—	`query`	Демо-режим для отладки интеграции: при `true` метод возвращает фиксированный тестовый ответ без обращения к модели предсказания. Пример: `true`

Запрос

Модель

{...}

Запрос: входные параметры для API предсказания цены.

from_city*: integer

>=1

Значение поля id в структуре city из словаря ATI.SU

to_city*: integer

>=1

Значение поля id в структуре city из словаря ATI.SU

cargo_type:

Идентификатор наименования груза. Значение поля dictionary_item_id
из словаря грузов ATI.SU

ANY-OF

integer

>=0

null

car_type*: integer

>=1

Тип кузова. Значение поля mask в структуре attributes_dictionary из словаря кузовов ATI.SU

volume: number

>=0

Объем груза в кубических метрах. Обязателен, если не передан weight

weight: number

>=0

Вес груза в тоннах. Обязателен, если не передан volume

distance:

Расстояние маршрута в километрах

ANY-OF

number

null

adr:

Параметр, определяющий степень опасности груза.
Допустимое значение: Null, либо от 0 до 9.

ANY-OF

integer

>=0 and <= 9

null

dogruz*: enum

[ftl, dont-care]

Загрузка: ftl — отдельной машиной, dont-care — отдельной машиной или догрузом

path_type: enum

[one_way, roundtrip]

Тип маршрута: односторонний или кругорейс

pallet_count:

Количество упаковок

ANY-OF

integer

null

pack_type_id:

ID типа упаковки. Значение поля dictionary_item_id
из словаря типов упаковок ATI.SU

ANY-OF

integer

null

}

Пример запроса

CURL
1C

curl 'https://api.ati.su/webapi/bazaar/v1/price_prediction_api' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"car_type":1,"distance":700,"dogruz":"ftl","from_city":1,"to_city":3611,"volume":0,"weight":15}'

Процедура Выполнить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", "/webapi/bazaar/v1/price_prediction_api", "{""car_type"":1,""distance"":700,""dogruz"":""ftl"",""from_city"":1,""to_city"":3611,""volume"":0,""weight"":15}");

Ответ

200 Successful Response

Модель

{...}

Предсказанные цены перевозки для разных вариантов оплаты.

price_with_tax:

Цена с НДС 22%, руб

ANY-OF

1:{...}

Предсказанная цена перевозки для одного варианта оплаты.

price*: integer

Цена перевозки в рублях.

}

null

price_without_tax:

Цена без НДС, руб

ANY-OF

1:{...}

Предсказанная цена перевозки для одного варианта оплаты.

price*: integer

Цена перевозки в рублях.

}

null

price_with_cash:

Цена наличными, руб

ANY-OF

1:{...}

Предсказанная цена перевозки для одного варианта оплаты.

price*: integer

Цена перевозки в рублях.

}

null

is_approximated:

В случае, если параметр true, то у нас недостаточно данных
по направлению. Учтены дополнительные данные с похожих направлений.

ANY-OF

boolean

null

}

Пример

{...}

"price_with_tax":{...},

"price":41694

"price_without_tax":{...},

"price":41694

"price_with_cash":{...},

"price":41694

"is_approximated":false

}

403 Нет прав на доступ к методу

Модель

{...}

Ответ с описанием ошибки.

error*: string

Текстовый код ошибки

reason*: string

Человекочитаемое описание ошибки

details:

Дополнительные детали ошибки

ANY-OF

1:{}

null

error_list:

Список ошибок, если их несколько (например, ошибки валидации)

ANY-OF

0:[{...}]

Отдельная ошибка в списке ошибок.

error*: string

Текстовый код ошибки

reason*: string

Человекочитаемое описание ошибки

}]

null

}

Пример

{...}

"error":"validation_errors",

"reason":"Произошли ошибки валидации",

"details":{},

"error_list":[...]

{...}

"error":"Тип поданного параметра отличается от ожидаемого - Значение должно быть >= 1!",

"reason":"location: ('body', 'from_city'); type: greater_than_equal"

}

]

}

422 Ошибка валидации параметров или город не найден

Модель

{...}

Ответ с описанием ошибки.

error*: string

Текстовый код ошибки

reason*: string

Человекочитаемое описание ошибки

details:

Дополнительные детали ошибки

ANY-OF

1:{}

null

error_list:

Список ошибок, если их несколько (например, ошибки валидации)

ANY-OF

0:[{...}]

Отдельная ошибка в списке ошибок.

error*: string

Текстовый код ошибки

reason*: string

Человекочитаемое описание ошибки

}]

null

}

Пример

{...}

"error":"validation_errors",

"reason":"Произошли ошибки валидации",

"details":{},

"error_list":[...]

{...}

"error":"Тип поданного параметра отличается от ожидаемого - Значение должно быть >= 1!",

"reason":"location: ('body', 'from_city'); type: greater_than_equal"

}

]

}