API Средних ставок

API позволяет получить цены и количество грузов из сервиса «Средние ставки».

API предоставляет средние ставки:

• по направлениям внутри России и за рубеж;
• для полностью загруженного транспорта со следующим тоннажем: 1,5 т, 3 т, 5 т, 10 т, 20 т;
• за интересующий вас период;
• для следующих типов кузовов: рефрижератор, тент, трал, контейнер, открытый и закрытый кузов.

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

Ограничения при работе с API

Время ответа API зависит от объёма данных, который вы запрашиваете.

Например: чтобы получить данные за 1 день потребуется 150 мс, за полгода по дням — 400 мс, за год по месяцам — 15 сек. и так далее.

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

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

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

Методы

Доступные направления для средних ставок

Версия 2 1.0

Возвращает список всех доступных направлений и доступные типы кузова для направления

get /priceline/license/v2/all_directions

Модель и примеры

Запрос

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

CURL

curl 'https://api.ati.su/priceline/license/v2/all_directions' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура Выполнить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Запрос("GET", "https://api.ati.su", "/priceline/license/v2/all_directions");

Ответ

200 Successful Response

Модель

{...}

AllDirections*:[{...}]

Все направления для средних ставок

FromCityId: integer

ID города загрузки

FromCity: string

Название города загрузки

ToCityId: integer

ID города разгрузки

ToCity: string

Название города разгрузки

FromRegionId: integer

ID города загрузки

FromRegion: string

Название города загрузки

ToRegionId: integer

ID города разгрузки

ToRegion: string

Название города разгрузки

DirectionInfo*:{...}

Структура информации о направлении - доступные сочетания тоннажа и типов кузова

CartypeTonnage*:{}

Словарь доступных сочетаний тип кузова - тоннаж

TonnageCartype*:{}

Словарь сочетаний тоннаж - тип кузова

}

RoundTripsInfo:{...}

Структура информации о кругорейсе - доступные сочетания тоннажа и типов кузова

CartypeTonnage*:{}

Словарь доступных сочетаний тип кузова - тоннаж

TonnageCartype*:{}

Словарь сочетаний тоннаж - тип кузова

}

}]

}

Пример

{...}

"AllDirections":[...]

{...}

"FromCityId":0,

"FromCity":"string",

"ToCityId":0,

"ToCity":"string",

"FromRegionId":0,

"FromRegion":"string",

"ToRegionId":0,

"ToRegion":"string",

"DirectionInfo":{...},

"CartypeTonnage":{},

"TonnageCartype":{}

},

"RoundTripsInfo":{...}

"CartypeTonnage":{},

"TonnageCartype":{}

}

}

]

}

Консоль

Отправить

Параметры

demo

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

get /priceline/license/v1/all_directions

Модель и примеры

Запрос

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

CURL

curl 'https://api.ati.su/priceline/license/v1/all_directions' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'

1C

Процедура Выполнить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Запрос("GET", "https://api.ati.su", "/priceline/license/v1/all_directions");

Ответ

200 Successful Response

Модель

{...}

AllDirections*:[{...}]

Все направления для средних ставок

FromCityId: integer

ID города загрузки

FromCity: string

Название города загрузки

ToCityId: integer

ID города разгрузки

ToCity: string

Название города разгрузки

FromRegionId: integer

ID города загрузки

FromRegion: string

Название города загрузки

ToRegionId: integer

ID города разгрузки

ToRegion: string

Название города разгрузки

CarTypes*: [string]

Список типов кузова, доступных для этого направления

RoundTrips: [string]

title: {missing-type-info}

description: {missing-type-info}

}]

}

Пример

{...}

"AllDirections":[...]

{...}

"FromCityId":0,

"FromCity":"string",

"ToCityId":0,

"ToCity":"string",

"FromRegionId":0,

"FromRegion":"string",

"ToRegionId":0,

"ToRegion":"string",

"CarTypes":[...],

"string"

],

"RoundTrips":[...],

"string"

],

"title":"?",

"description":"?"

}

]

}

Консоль

Отправить

Параметры

demo

Запрос средних ставок

Метод получения средних цен

post /priceline/license/v1/average_prices

Модель и примеры

Запрос

Модель

{...}

From*:{...}

Город или регион откуда

CityId: integer

ID города. Значение из словаря городов АТИ

RegionId: integer

ID региона. Значение из словаря регионов АТИ

}

To*:{...}

Город или регион откуда

CityId: integer

ID города. Значение из словаря городов АТИ

RegionId: integer

ID региона. Значение из словаря регионов АТИ

}

CarType: string

Тип кузова.

• ref - рефрижераторы.
• close - закрытые. Значение по умолчанию.
• open - открытые.
• tent - тентованный.
• tral - трал.
• docker - контейнер.

DateFrom: date

Начало периода. Формат ISO-8601. Если интересует только одна дата, то передавать ее здесь. По умолчанию - последний день, за который есть данные.

DateTo: date

Конец периода. Формат ISO-8601. Если интересует только одна дата, то данное поле не заполнять.

Frequency: string

Дискретность выдачи данных.

• day - для каждого дня будут выданы данные. Значение по умолчанию. Опция day доступна только в том случае, если общий временной период составляет меньше 6 месяцев.
• week - будут выданы усредненные данные по неделе.
• month- будут выданы усредненные данные по месяцу.

WithNds: boolean

Учитывать ли НДС в цене.

• false - не учитывать. Значение по умолчанию.
• true - учитывать.

RoundTrip: boolean

Параметр позволяет получить цену кругорейса, то есть ставку для маршрута «туда и обратно».

• false - для прямого рейса. Значение по умолчанию.
• true - для кругового рейса (если доступен).

Tonnage: integer

Тоннаж. Одно из:

• 1.5
• 3
• 5
• 10
• 20 - значение по умолчанию.

}

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

CURL

curl 'https://api.ati.su/priceline/license/v1/average_prices' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '{"CarType":"close","DateFrom":"2022-03-01","DateTo":"2022-03-02","Frequency":"day","From":{"CityId":1},"RoundTrip":false,"To":{"CityId":3611},"Tonnage":5,"WithNds":false}'

1C

Процедура Выполнить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", "/priceline/license/v1/average_prices", "{""CarType"":""close"",""DateFrom"":""2022-03-01"",""DateTo"":""2022-03-02"",""Frequency"":""day"",""From"":{""CityId"":1},""RoundTrip"":false,""To"":{""CityId"":3611},""Tonnage"":5,""WithNds"":false}");

Ответ

200 Successful Response

Модель

{...}

Data*:[{...}]

Данные по запрошенному интервалу

DateFrom*: date

Начало периода. Формат ISO-8601.

DateTo: date

Конец периода. Формат ISO-8601.

Prices:{...}

Данные по ставкам в руб/км

UpperPrice*: number

Верхняя граница ставок в руб или в руб/км

BottomPrice*: number

Нижняя граница ставок в руб или в руб/км

AveragePrice*: number

Средняя ставка в руб или в руб/км

}

PricesInRub:{...}

Данные по ставкам в руб

UpperPrice*: number

Верхняя граница ставок в руб или в руб/км

BottomPrice*: number

Нижняя граница ставок в руб или в руб/км

AveragePrice*: number

Средняя ставка в руб или в руб/км

}

LoadsCount: integer

Количество грузов

}]

Distance: integer

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

WithNDS*: boolean

Являются ли данные ставки ставками с учётом НДС

}

Пример

{...}

"Data":[...],

{...}

"DateFrom":"2022-03-01",

"DateTo":"2022-03-02",

"Prices":{...},

"UpperPrice":30,

"BottomPrice":10,

"AveragePrice":20

},

"PricesInRub":{...},

"UpperPrice":30,

"BottomPrice":10,

"AveragePrice":20

},

"LoadsCount":121

}

],

"Distance":750,

"WithNDS":false

}

404 Not Found

Модель

{...}

error*: string

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

reason*: string

Тип ошибки если имеется

details*:{}

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

}

Пример

{...}

"error":"string",

"reason":"string",

"details":{}

}

422 Unprocessable Entity

Модель

{...}

error*: string

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

reason*: string

Тип ошибки если имеется

details*:{}

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

}

Пример

{...}

"error":"string",

"reason":"string",

"details":{}

}

Консоль

Отправить

Параметры

demo

{ "CarType": "close", "DateFrom": "2022-03-01", "DateTo": "2022-03-02", "Frequency": "day", "From": { "CityId": 1 }, "RoundTrip": false, "To": { "CityId": 3611 }, "Tonnage": 5, "WithNds": false }