https://wiki.alta.ru/api.php?action=feedcontributions&feedformat=atom&user=BoluchevskikhAlta-Soft Wikipedia - Вклад участника [ru]2026-10-01T02:56:00ZВклад участникаMediaWiki 1.32.0https://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1404API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2026-09-29T06:45:05Z<p>Boluchevskikh: /* Структура блока &lt;Calc&gt; (Тарифные составляющие) */</p>
<hr />
<div>__TOC__<br />
<br />
= Описание протокола обмена данными (API) «ЖД Тариф» от Альта-Софт =<br />
<br />
Сервис предназначен для расчета провозной платы (тарифа) при железнодорожных перевозках грузов по территории России, стран СНГ, Балтии и сопредельных государств, а также для получения нормативно-справочной информации (станции, номенклатура грузов ЕТСНГ/ГНГ, классификатор подвижного состава, государства).<br />
<br />
== Общие положения ==<br />
<br />
* '''Базовый URL:''' <code>https://www.alta.ru/rail_tracking/rail_trf/</code><br />
* '''Протокол:''' HTTP / HTTPS.<br />
* '''Методы запросов:''' <code>GET</code>, <code>POST</code>.<br />
* '''Формат передачи данных:''' XML (кодировка <code>UTF-8</code>).<br />
* '''Аутентификация:''' Обязательный GET/POST-параметр <code>api_key</code>.<br />
<br />
{| class="wikitable" style="width: 100%;"<br />
! Параметр !! Тип !! Обязательный !! Описание<br />
|-<br />
| <code>api_key</code> || string || '''Да''' || Уникальный лицензионный ключ доступа. Выдается после оплаты, имеет ограниченный срок действия (6 месяцев или 1 год) и лимит доступных обращений.<br />
|-<br />
| <code>type</code> || string || '''Да''' || Тип выполняемой операции (<code>fre</code>, <code>frg</code>, <code>fst</code>, <code>tst</code>, <code>states</code>, <code>van_tree</code>, <code>calc</code>, <code>key_info</code>).<br />
|-<br />
| <code>encoding</code> || string || Нет || Кодировка ответа (рекомендуется передавать <code>utf-8</code>).<br />
|}<br />
<br />
----<br />
<br />
== 1. Справочник грузов (ЕТСНГ и ГНГ) ==<br />
<br />
Служит для поиска кодов грузов по ЕТСНГ (Единая тарифно-статистическая номенклатура грузов) и ГНГ (Гармонизированная номенклатура грузов), а также для автоматического сопоставления классификаторов.<br />
<br />
=== Параметры запроса ===<br />
{| class="wikitable" style="width: 100%;"<br />
! Параметр !! Тип !! По умолчанию !! Описание<br />
|-<br />
| <code>type</code> || string || — || Режим выборки:<br />
* <code>fre</code> — поиск по классификатору ЕТСНГ;<br />
* <code>frg</code> — поиск по классификатору ГНГ.<br />
|-<br />
| <code>index</code> || string || ''(пусто)'' || Поисковый запрос: код груза (или первые цифры кода) либо наименование (или фрагмент наименования). Если не задан — возвращается весь справочник.<br />
|-<br />
| <code>corr</code> || string || <code>yes</code> || <code>yes</code> — искать соответствие между ЕТСНГ и ГНГ; <code>no</code> — не выполнять кросс-поиск.<br />
|}<br />
<br />
=== Примеры запросов ===<br />
* Поиск в ЕТСНГ по началу кода с кросс-поиском по ГНГ:<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=fre&index=011&encoding=utf-8&api_key=[ВАШ_API_KEY]</code><br />
* Поиск в ГНГ по наименованию без сопоставления:<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=frg&index=пшен&corr=no&encoding=utf-8&api_key=[ВАШ_API_KEY]</code><br />
<br />
=== Описание полей ответа (XML) ===<br />
Корневой элемент: <code>&lt;fraights&gt;</code> (содержит атрибут <code>last_update</code> — дата актуализации справочника). Внутри расположен список элементов <code>&lt;fraight&gt;</code>.<br />
<br />
{| class="wikitable" style="width: 100%;"<br />
! Атрибут !! Тип !! Присутствует в !! Описание<br />
|-<br />
| <code>index</code> || string || ЕТСНГ / ГНГ || 6-значный код ЕТСНГ или 8-значный код ГНГ.<br />
|-<br />
| <code>name</code> || string || ЕТСНГ / ГНГ || Наименование груза.<br />
|-<br />
| <code>level</code> || integer || ЕТСНГ / ГНГ || Уровень вложенности в иерархическом справочнике (1, 2, 3...).<br />
|-<br />
| <code>parent</code> || string || ЕТСНГ / ГНГ || Код вышестоящего родительского узла/группы.<br />
|-<br />
| <code>isgroup</code> || boolean || ЕТСНГ / ГНГ || <code>true</code> — узел является группой грузов; <code>false</code> — конкретный груз (конечная позиция).<br />
|-<br />
| <code>danger</code> || boolean || ЕТСНГ || <code>true</code> — груз относится к категории опасных.<br />
|-<br />
| <code>guard</code> || boolean || ЕТСНГ || <code>true</code> — груз подлежит обязательной охране (ВОХР/сопровождение).<br />
|-<br />
| <code>frclass</code> || integer || ЕТСНГ || Тарифный класс груза (1, 2 или 3 класс).<br />
|-<br />
| <code>mwn</code> || string || ЕТСНГ || Минимальная весовая норма (МВН): число в тоннах либо <code>ГП</code> (грузоподъемность вагона).<br />
|-<br />
| <code>gng</code> || string || ЕТСНГ || Соответствующий 8-значный код по номенклатуре ГНГ (при <code>corr=yes</code>).<br />
|-<br />
| <code>frnameg</code> || string || ЕТСНГ || Наименование соответствующего груза по ГНГ.<br />
|-<br />
| <code>toetsng</code> || string || ГНГ || Соответствующий код ЕТСНГ (при <code>corr=yes</code>).<br />
|}<br />
<br />
=== Пример XML-ответа ===<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<fraights last_update="17.01.2026"><br />
<fraight index="011005" name="ПШЕНИЦА" level="3" parent="010002" isgroup="false" danger="false" guard="false" frclass="2" mwn="ГП" gng="10019000" frnameg="" /><br />
</fraights><br />
</syntaxhighlight><br />
<br />
----<br />
<br />
== 2. Справочник станций ==<br />
<br />
Служит для поиска железнодорожных станций по названию или коду ЕСР (Единая сетевая разметка), проверки выполняемых коммерческих операций (параграфов ТР №4) и определения принадлежности железной дороге и государству.<br />
<br />
=== Параметры запроса ===<br />
{| class="wikitable" style="width: 100%;"<br />
! Параметр !! Тип !! По умолчанию !! Описание<br />
|-<br />
| <code>type</code> || string || — || <code>fst</code> (станция отправления) или <code>tst</code> (станция назначения). Формат выдачи идентичен.<br />
|-<br />
| <code>index</code> || string || ''(пусто)'' || Поисковый запрос: код станции или наименование (регистронезависимо).<br />
|-<br />
| <code>exactly</code> || integer || <code>0</code> || <code>1</code> — строгое совпадение по наименованию; <code>0</code> — поиск по подстроке (вхождению символов).<br />
|-<br />
| <code>full_code</code> || integer || <code>0</code> || <code>1</code> — возвращать 6-значный код ЕСР (с контрольным знаком); <code>0</code> — стандартный 5-значный тарифный код.<br />
|}<br />
<br />
=== Примеры запросов ===<br />
* Поиск по коду станции:<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=tst&index=104&encoding=utf-8&api_key=[ВАШ_API_KEY]</code><br />
* Поиск по названию станции:<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=fst&index=моск&encoding=utf-8&api_key=[ВАШ_API_KEY]</code><br />
<br />
=== Описание полей ответа (XML) ===<br />
Корневой элемент: <code>&lt;stations&gt;</code> (атрибут <code>count</code> — число найденных записей). Дочерние элементы: <code>&lt;station&gt;</code>.<br />
<br />
{| class="wikitable" style="width: 100%;"<br />
! Атрибут !! Тип !! Описание<br />
|-<br />
| <code>index</code> || string || 5- или 6-значный код станции по ЕСР.<br />
|-<br />
| <code>name</code> || string || Наименование станции.<br />
|-<br />
| <code>paragrafs</code> || string || Номера параграфов Тарифного руководства №4 (коммерческие операции, выполняемые на станции).<br />
|-<br />
| <code>stateindex</code> || integer || Цифровой код государства расположения станции.<br />
|-<br />
| <code>statename</code> || string || Наименование государства.<br />
|-<br />
| <code>roadindex</code> || integer || Код железной дороги.<br />
|-<br />
| <code>roadname</code> || string || Наименование железной дороги (например, Приволжская, Октябрьская).<br />
|-<br />
| <code>tip</code> || integer || Числовой код типа станции.<br />
|-<br />
| <code>tipstr</code> || string || Текстовая расшифровка типа станции (например, «Внутренняя станция», «Пограничная экспортная»).<br />
|-<br />
| <code>toroad</code> || string || Код сопредельной дороги (для стыковых/пограничных станций).<br />
|-<br />
| <code>tostateindex</code> || string || Код сопредельного государства (для погранпереходов).<br />
|-<br />
| <code>tostatename</code> || string || Наименование сопредельного государства.<br />
|}<br />
<br />
=== Пример XML-ответа ===<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<stations count="1"><br />
<station index="62670" name="Питерка" paragrafs="1,3" stateindex="20" statename="Россия" roadindex="61" roadname="Приволжская" tip="10" tipstr="Внутренняя станция" toroad="00" tostatename="" tostateindex="" /><br />
</stations><br />
</syntaxhighlight><br />
<br />
----<br />
<br />
== 3. Справочник государств ==<br />
<br />
Возвращает перечень стран и их идентификаторов, используемых в тарифной системе.<br />
<br />
=== Запрос ===<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=states&api_key=[ВАШ_API_KEY]</code><br />
<br />
=== Описание полей ответа (XML) ===<br />
Корневой элемент: <code>&lt;states&gt;</code>, содержит элементы <code>&lt;state&gt;</code>:<br />
* <code>index</code> (integer) — уникальный код государства в ж/д классификаторе (например, 20 — Россия, 27 — Казахстан, 21 — Беларусь);<br />
* <code>name</code> (string) — наименование государства.<br />
<br />
=== Пример XML-ответа ===<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<states><br />
<state index="20" name="Россия" /><br />
<state index="21" name="Белоруссия" /><br />
<state index="27" name="Казахстан" /><br />
</states><br />
</syntaxhighlight><br />
<br />
----<br />
<br />
== 4. Дерево подвижного состава и перевозочных средств ==<br />
<br />
Возвращает иерархический классификатор вагонов и контейнеров. Конечный атрибут <code>index</code> элемента 3-го уровня используется в расчетах тарифа (параметр <code>van</code>).<br />
<br />
=== Параметры запроса ===<br />
{| class="wikitable" style="width: 100%;"<br />
! Параметр !! Тип !! По умолчанию !! Описание<br />
|-<br />
| <code>type</code> || string || — || Значение <code>van_tree</code>.<br />
|-<br />
| <code>kind</code> || string || <code>xml</code> || Формат вывода: <code>xml</code> (структурированное дерево XML) или <code>html</code> / <code>ul</code> (вложенные списки HTML для отображения на web-страницах).<br />
|}<br />
<br />
=== Пример запроса ===<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&kind=xml&encoding=utf-8&api_key=[ВАШ_API_KEY]</code><br />
<br />
=== Описание полей ответа (XML) ===<br />
Дерево состоит из вложенных элементов <code>&lt;van&gt;</code>:<br />
* <code>level</code> (integer) — уровень иерархии:<br />
** <code>1</code> — вид отправки (Повагонная, Контейнерная);<br />
** <code>2</code> — тип/категория ПС (В универсальных вагонах, В цистернах, Крупнотоннажные контейнеры и т.д.);<br />
** <code>3</code> — конкретный тип подвижного состава (листовой узел).<br />
* <code>name</code> (string) — наименование категории или типа ПС.<br />
* <code>index</code> (integer) — '''код типа ПС'''. Присутствует только на 3-м уровне. Именно это значение передается в параметр <code>van</code> при расчете тарифа (например: <code>200</code> — крытый, <code>400</code> — платформа, <code>600</code> — полувагон, <code>2220</code> — контейнер 20 футов).<br />
<br />
=== Пример XML-ответа ===<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<van_tree><br />
<van level="1" name="Повагонная"><br />
<van level="2" name="В универсальных вагонах"><br />
<van level="3" index="200" name="Крытый" /><br />
<van level="3" index="400" name="Платформа" /><br />
<van level="3" index="600" name="Полувагон" /><br />
</van><br />
</van><br />
<van level="1" name="Контейнерная"><br />
<van level="2" name="Универсальный контейнер"><br />
<van level="3" index="2220" name="Контейнер крупнотоннажный г/п 20 т (20 ft.)" /><br />
<van level="3" index="2430" name="Контейнер крупнотоннажный г/п 30 т (40 ft.)" /><br />
</van><br />
</van><br />
</van_tree><br />
</syntaxhighlight><br />
<br />
----<br />
<br />
== 5. Расчет нитки маршрута и расстояний между станциями ==<br />
<br />
Позволяет построить географический и тарифный маршрут следования с разбивкой по транзитным дорогам, опорным станциям и расчетным плечам без выполнения финансового расчета тарифа.<br />
<br />
=== Параметры запроса ===<br />
{| class="wikitable" style="width: 100%;"<br />
! Параметр !! Тип !! Обязательный !! Описание<br />
|-<br />
| <code>type</code> || string || '''Да''' || Значение <code>calc</code>.<br />
|-<br />
| <code>fst</code> || string || '''Да''' || 5-значный код ЕСР станции отправления.<br />
|-<br />
| <code>tst</code> || string || '''Да''' || 5-значный код ЕСР станции назначения.<br />
|-<br />
| <code>route_only</code> || integer || '''Да''' || Значение <code>1</code> (только маршрут).<br />
|-<br />
| <code>api_key</code> || string || '''Да''' || Лицензионный ключ.<br />
|}<br />
<br />
=== Пример запроса ===<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=calc&fst=69000&tst=19100&route_only=1&api_key=[ВАШ_API_KEY]</code><br />
<br />
Ответ содержит секцию <code>&lt;route&gt;</code>, идентичную блоку маршрута в полном расчете тарифа (см. раздел 6).<br />
<br />
----<br />
<br />
== 6. Расчет ЖД Тарифа ==<br />
<br />
Основной метод системы. Производит комплексный расчет провозных плат, сборов, платы за охрану, нормативных сроков доставки и построение нитки маршрута с детализацией по странам следования.<br />
<br />
=== Входные параметры ===<br />
{| class="wikitable" style="width: 100%;"<br />
! Параметр !! Тип !! По умолч. !! Описание<br />
|-<br />
| <code>type</code> || string || — || Обязательно: <code>calc</code>.<br />
|-<br />
| <code>fst</code> || string || — || Код ЕСР станции отправления (5 знаков).<br />
|-<br />
| <code>tst</code> || string || — || Код ЕСР станции назначения (5 знаков).<br />
|-<br />
| <code>fre</code> || string || — || Код груза по номенклатуре ЕТСНГ (5–6 знаков).<br />
|-<br />
| <code>frg</code> || string || — || Код груза по номенклатуре ГНГ (8 знаков). Если не задан, подбирается автоматически.<br />
|-<br />
| <code>fstate</code> || integer || — || Код государства станции отправления (из справочника <code>states</code>).<br />
|-<br />
| <code>tstate</code> || integer || — || Код государства станции назначения (из справочника <code>states</code>).<br />
|-<br />
| <code>van</code> || integer || — || Идентификатор типа вагона/контейнера из дерева <code>van_tree</code>.<br />
|-<br />
| <code>w</code> || integer/float || — || Масса груза в вагоне (в '''килограммах'''). Общая для всех вагонов отправки.<br />
|-<br />
| <code>gp</code> || integer/float || — || Грузоподъемность вагона (в '''тоннах''').<br />
|-<br />
| <code>owner</code> || integer || <code>0</code> || Принадлежность парка: <code>0</code> — вагон перевозчика (общий парк); <code>1</code> — собственный или арендованный парк.<br />
|-<br />
| <code>empt</code> || integer || <code>0</code> || <code>0</code> — груженый рейс; <code>1</code> — порожний рейс. Для грузов группы ЕТСНГ 421*** установка <code>empt=1</code> обязательна.<br />
|-<br />
| <code>num_vagons</code> || integer || <code>1</code> || Число вагонов в отправке.<br />
|-<br />
| <code>w1...wN</code> || integer || — || Индивидуальный вес груза в кг для вагона № N (например, <code>w2=65000</code>).<br />
|-<br />
| <code>gp1...gpN</code> || integer/float || — || Индивидуальная грузоподъемность вагона № N в тоннах (например, <code>gp3=70</code>).<br />
|-<br />
| <code>return</code> || integer || <code>0</code> || <code>1</code> — рассчитать плату за возврат вагона; <code>0</code> — не рассчитывать.<br />
|-<br />
| <code>return_st</code> || string || <code>fst</code> || Код ЕСР станции возврата вагона (если отличается от станции отправления).<br />
|-<br />
| <code>modular</code> || integer || <code>0</code> || Признак сборной отправки: <code>1</code> — сборная повагонная отправка нескольких грузов.<br />
|-<br />
| <code>fre1...freN</code> || string || — || Коды ЕТСНГ отдельных грузов при сборной отправке (<code>modular=1</code>).<br />
|-<br />
| <code>frg1...frgN</code> || string || — || Коды ГНГ отдельных грузов при сборной отправке.<br />
|-<br />
| <code>route</code> || integer || <code>1</code> || <code>1</code> — включить детальную нитку маршрута в XML; <code>0</code> — скрыть.<br />
|-<br />
| <code>calc_date</code> || string || Текущая || Дата применения тарифов в формате <code>ДД.ММ.ГГГГ</code> (например, <code>23.09.2026</code>).<br />
|-<br />
| <code>currency</code> || string || По странам || Мнемокод валюты итога (<code>RUB</code>, <code>USD</code>, <code>EUR</code>, <code>KZT</code>, <code>CHF</code>). По умолчанию расчет по участкам ведется в нац. валютах транзитных дорог, итог пересчитывается в рубли по курсу ЦБ РФ.<br />
|-<br />
| <code>dock_stations</code> || string || — || Коды стыковых станций через запятую для принудительной маршрутизации (например, <code>66380,54850</code>).<br />
|-<br />
| <code>crimea_bridge</code> || integer || <code>0</code> || Для Крымской ж/д: <code>1</code> — через Крымский мост; <code>0</code> — через паромную переправу Кавказ–Крым.<br />
|-<br />
| <code>for_loading</code> || integer || <code>0</code> || Для порожнего рейса по КТЖ (Казахстан): <code>1</code> — под погрузку; <code>0</code> — из-под выгрузки.<br />
|-<br />
| <code>fre_empty</code> || string || <code>fre</code> || Код ЕТСНГ груза, под погрузку которого следует вагон при порожнем рейсе по КТЖ.<br />
|-<br />
| <code>is_speed</code> || integer || <code>1</code> || <code>1</code> — перевозка большой скоростью; <code>0</code> — без учета надбавки.<br />
|-<br />
| <code>is_cont_train</code> || integer || <code>1</code> || <code>1</code> — в составе регулярного контейнерного поезда; <code>0</code> — повагонная/одиночная отправка.<br />
|}<br />
<br />
=== Примеры запросов ===<br />
<br />
* '''Расчет повагонной отправки (1 вагон):'''<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=calc&fst=01100&tst=66000&fre=01100&frg=10019000&fstate=20&tstate=27&van=200&w=60000&gp=66&owner=0&return=0&empt=0&api_key=[ВАШ_API_KEY]</code><br />
<br />
* '''Многовагонная отправка с индивидуальными параметрами:'''<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=calc&fst=01100&tst=22022&fre=01100&frg=10019000&fstate=20&tstate=20&van=200&w=60000&gp=66&num_vagons=3&w2=65000&gp3=70&owner=1&api_key=[ВАШ_API_KEY]</code><br />
<br />
* '''Сборная повагонная отправка (<code>modular=1</code>):'''<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=calc&fst=19350&tst=97040&fstate=20&tstate=20&van=200&gp=65&modular=1&num_vagons=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&api_key=[ВАШ_API_KEY]</code><br />
<br />
=== Описание структуры XML-ответа ===<br />
<br />
Ответ сервиса включает в себя:<br />
# <code>&lt;status&gt;</code> — общий статус обработки (<code>ok</code> или <code>error</code>).<br />
# <code>&lt;route&gt;</code> — нитка маршрута по странам и участкам.<br />
# <code>&lt;Calc&gt;</code> — блок финансовых результатов по странам и консолидированный итог.<br />
# <code>&lt;stat&gt;</code>, <code>&lt;client_thread&gt;</code>, <code>&lt;requests_available&gt;</code> — сервисная информация и остаток лимита.<br />
<br />
==== Структура блока <code>&lt;route&gt;</code> (Маршрут следования) ====<br />
* <code>&lt;route&gt;</code>:<br />
** <code>total_rst</code> (integer) — общее расстояние маршрута (км);<br />
** <code>from_state</code>, <code>to_state</code> (string) — страны отправления и назначения.<br />
* <code>&lt;st_part&gt;</code> — участок маршрута по территории отдельной страны:<br />
** <code>index</code> (integer) — код страны;<br />
** <code>name</code> (string) — наименование страны;<br />
** <code>rst</code> (integer) — протяженность участка по территории этой страны в км.<br />
* <code>&lt;stage&gt;</code> — расчетное плечо маршрута между ключевыми/стыковыми станциями:<br />
** <code>st1_ecp</code>, <code>st1_name</code> — ЕСР-код и наименование начальной станции плеча;<br />
** <code>st2_ecp</code>, <code>st2_name</code> — ЕСР-код и наименование конечной станции плеча;<br />
** <code>rst</code> (integer) — тарифное расстояние плеча в км.<br />
<br />
==== Структура блока <code>&lt;Calc&gt;</code> (Тарифные составляющие) ====<br />
<br />
Внутри <code>&lt;Calc&gt;</code> для каждого транзитного государства формируется узел <code>&lt;state&gt;</code>.<br />
<br />
'''Атрибуты элемента <code>&lt;state&gt;</code>:'''<br />
{| class="wikitable" style="width: 100%;"<br />
! Атрибут !! Тип !! Описание<br />
|-<br />
| <code>index</code> || integer || Цифровой код государства.<br />
|-<br />
| <code>name</code> || string || Наименование государства.<br />
|-<br />
| <code>rst</code> || integer || Тарифное расстояние по данному государству (км).<br />
|-<br />
| <code>return</code> || boolean || <code>true</code> — плата за порожний возврат; <code>false</code> — груженый рейс.<br />
|-<br />
| <code>id</code> || integer || Порядковый номер вагона в отправке.<br />
|-<br />
| <code>w</code> || integer || Расчетная масса груза в вагоне (кг).<br />
|-<br />
| <code>gp</code> || float || Грузоподъемность вагона (т).<br />
|-<br />
| <code>spec_tax</code> || boolean || Признак применения спецставки/исключительного тарифа.<br />
|}<br />
<br />
'''Дочерние элементы <code>&lt;state&gt;</code> (денежные составляющие):'''<br />
Все узлы содержат атрибуты <code>currency</code> (валюта) и <code>value</code> (сумма с двумя знаками после запятой).<br />
{| class="wikitable" style="width: 100%;"<br />
! Тег !! Описание<br />
|-<br />
| <code>&lt;summa&gt;</code> || Основная тарифная ставка за перевозку (инфраструктурная и локомотивная составляющие).<br />
|-<br />
| <code>&lt;summa_add_free&gt;</code> || Базовая ставка без учета дополнительных сборов.<br />
|-<br />
| <code>&lt;add_taxes&gt;</code> || Сумма дополнительных сборов и плат.<br />
|-<br />
| <code>&lt;guard&gt;</code> || Плата за военизированную охрану груза (ВОХР).<br />
|-<br />
| <code>&lt;nalog&gt;</code> || Сумма налога (НДС). При международных перевозках часто 0.00 (ставка 0%).<br />
|-<br />
| <code>&lt;total_tax_free&gt;</code> || Итоговая сумма по участку без НДС.<br />
|-<br />
| <code>&lt;total&gt;</code> || '''Итоговая провозная плата по стране''' с учетом всех сборов и налогов.<br />
|-<br />
| <code>&lt;tonna_tax_free&gt;</code> || Стоимость перевозки 1 тонны груза по данному участку без НДС.<br />
|-<br />
| <code>&lt;tonna&gt;</code> || Итоговая стоимость перевозки 1 тонны груза по стране с НДС.<br />
|-<br />
| <code>&lt;tonna_add_free&gt;</code> || Стоимость за 1 тонну без дополнительных сборов.<br />
|}<br />
<br />
'''Сводные итоговые элементы блока <code>&lt;Calc&gt;</code>:'''<br />
{| class="wikitable" style="width: 100%;"<br />
! Тег !! Атрибуты !! Описание<br />
|-<br />
| <code>&lt;total_all&gt;</code> || <code>currency</code>, <code>value</code> || '''Полная стоимость перевозки по всему маршруту''' (по всем странам). По умолчанию конвертирована в рубли (RUB).<br />
|-<br />
| <code>&lt;total_all_nalog&gt;</code> || <code>currency</code>, <code>value</code> || Суммарный налог (НДС) по всей перевозке.<br />
|-<br />
| <code>&lt;tonna_all&gt;</code> || <code>currency</code>, <code>value</code> || Суммарная стоимость перевозки 1 тонны по всему маршруту следования.<br />
|-<br />
| <code>&lt;guard_all&gt;</code> || <code>currency</code>, <code>value</code> || Общая плата за вооруженную охрану по всем дорогам.<br />
|-<br />
| <code>&lt;guide_c_all&gt;</code> || <code>currency</code>, <code>value</code> || Плата за проезд проводников отправителя (инфраструктурная составляющая)<br />
|-<br />
| <code>&lt;guide_v_all&gt;</code> || <code>currency</code>, <code>value</code> || Плата за проезд проводников отправителя в вагоне.<br />
|-<br />
| <code>&lt;delivery_time&gt;</code> || <code>unit</code>, <code>value</code> || '''Нормативный срок доставки'''. Значение <code>value</code> — количество, <code>unit</code> — единица измерения (например, <code>сутки</code>).<br />
|}<br />
<br />
==== Сервисные элементы ответа ====<br />
* <code>&lt;request&gt;</code> — копия входящей строки запроса в блоке CDATA.<br />
* <code>&lt;client_thread&gt;</code> — идентификатор внутреннего потока сервера обработки.<br />
* <code>&lt;stat&gt;</code>:<br />
** <code>&lt;calc_start&gt;</code>, <code>&lt;calc_finish&gt;</code> — временные метки начала и завершения расчета на сервере.<br />
* <code>&lt;requests_available binded="..."&gt;</code> — количество оставшихся оплаченных запросов по ключу.<br />
<br />
=== Пример XML-ответа при расчете тарифа ===<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<xml><br />
<status>ok</status><br />
<route total_rst="3093" from_state="20 Россия" to_state="27 Казахстан"><br />
<st_part index="20" name="Россия" rst="2804"><br />
<stage st1_ecp="01100" st1_name="Кяппесельга" st2_ecp="30260" st2_name="Кошта" rst="741" /><br />
<stage st1_ecp="30260" st1_name="Кошта" st2_ecp="26290" st2_name="Новки II" rst="577" /><br />
<stage st1_ecp="26290" st1_name="Новки II" st2_ecp="24700" st2_name="Красный Узел" rst="492" /><br />
<stage st1_ecp="24700" st1_name="Красный Узел" st2_ecp="65730" st2_name="Кинель" rst="540" /><br />
<stage st1_ecp="65730" st1_name="Кинель" st2_ecp="81300" st2_name="Канисай (эксп.)" rst="454" /><br />
</st_part><br />
<st_part index="27" name="Казахстан" rst="289"><br />
<stage st1_ecp="66650" st1_name="Илецк I (эксп.)" st2_ecp="66000" st2_name="Кандыагаш" rst="289" /><br />
</st_part><br />
</route><br />
<Calc><br />
<state index="20" name="Россия" rst="2804" return="false" id="1" w="60000" gp="66" spec_tax="false"><br />
<summa currency="RUB" value="254403.00" /><br />
<summa_add_free currency="RUB" value="0.00" /><br />
<add_taxes currency="RUB" value="0.00" /><br />
<guard currency="RUB" value="0.00" /><br />
<total_tax_free currency="RUB" value="254403.00" /><br />
<tonna_tax_free currency="RUB" value="4240.05" /><br />
<nalog currency="RUB" value="0.00" /><br />
<total currency="RUB" value="254403.00" /><br />
<tonna currency="RUB" value="4240.05" /><br />
<tonna_add_free currency="RUB" value="4240.05" /><br />
</state><br />
<state index="27" name="Казахстан" rst="289" return="false" id="1" w="60000" gp="66" spec_tax="false"><br />
<summa currency="KZT" value="176003.00" /><br />
<summa_add_free currency="KZT" value="176003.00" /><br />
<add_taxes currency="KZT" value="0.00" /><br />
<guard currency="KZT" value="0.00" /><br />
<total_tax_free currency="KZT" value="176003.00" /><br />
<tonna_tax_free currency="KZT" value="2933.38" /><br />
<nalog currency="KZT" value="0.00" /><br />
<total currency="KZT" value="176003.00" /><br />
<tonna currency="KZT" value="2933.38" /><br />
<tonna_add_free currency="KZT" value="2933.38" /><br />
</state><br />
<total_all currency="RUB" value="288023.00" /><br />
<total_all_nalog currency="RUB" value="0.00" /><br />
<tonna_all currency="RUB" value="4800.38" /><br />
<guard_all currency="" value="0.00" /><br />
<guide_c_all currency="" value="0.00" /><br />
<guide_v_all currency="" value="0.00" /><br />
<delivery_time unit="сутки" value="18" /><br />
</Calc><br />
<request><![CDATA[type=calc&fst=01100&tst=66000&fre=01100&frg=10019000&fstate=20&tstate=27&van=200&w=60000&gp=66&owner=0&return=0&empt=0&api_key=alta_rail&page=calc.xml]]></request><br />
<client_thread>84</client_thread><br />
<stat><br />
<calc_start>29.09.2026 10:15:13</calc_start><br />
<calc_finish>29.09.2026 10:15:15</calc_finish><br />
</stat><br />
<requests_available binded="0">9999999</requests_available><br />
</xml><br />
</syntaxhighlight><br />
<br />
=== XSD-схема валидации ответа расчета тарифа (calc.xsd) ===<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"><br />
<xs:complexType name="MoneyItemType"><br />
<xs:attribute name="currency" type="xs:string" use="optional" /><br />
<xs:attribute name="value" type="xs:decimal" use="required" /><br />
</xs:complexType><br />
<br />
<xs:element name="xml"><br />
<xs:complexType><br />
<xs:sequence><br />
<xs:element name="status" type="xs:string" /><br />
<xs:element minOccurs="0" name="error" type="xs:string" /><br />
<xs:element minOccurs="0" name="route"><br />
<xs:complexType><br />
<xs:sequence><br />
<xs:element maxOccurs="unbounded" name="st_part"><br />
<xs:complexType><br />
<xs:sequence><br />
<xs:element maxOccurs="unbounded" name="stage"><br />
<xs:complexType><br />
<xs:attribute name="st1_ecp" type="xs:string" use="required" /><br />
<xs:attribute name="st1_name" type="xs:string" use="required" /><br />
<xs:attribute name="st2_ecp" type="xs:string" use="required" /><br />
<xs:attribute name="st2_name" type="xs:string" use="required" /><br />
<xs:attribute name="rst" type="xs:integer" use="required" /><br />
</xs:complexType><br />
</xs:element><br />
</xs:sequence><br />
<xs:attribute name="index" type="xs:integer" use="required" /><br />
<xs:attribute name="name" type="xs:string" use="required" /><br />
<xs:attribute name="rst" type="xs:integer" use="required" /><br />
</xs:complexType><br />
</xs:element><br />
</xs:sequence><br />
<xs:attribute name="total_rst" type="xs:integer" use="required" /><br />
<xs:attribute name="from_state" type="xs:string" use="required" /><br />
<xs:attribute name="to_state" type="xs:string" use="required" /><br />
</xs:complexType><br />
</xs:element><br />
<xs:element minOccurs="0" name="Calc"><br />
<xs:complexType><br />
<xs:sequence><br />
<xs:element maxOccurs="unbounded" name="state"><br />
<xs:complexType><br />
<xs:sequence><br />
<xs:element name="summa" type="MoneyItemType" /><br />
<xs:element name="summa_add_free" type="MoneyItemType" /><br />
<xs:element name="add_taxes" type="MoneyItemType" /><br />
<xs:element name="guard" type="MoneyItemType" /><br />
<xs:element name="total_tax_free" type="MoneyItemType" /><br />
<xs:element name="tonna_tax_free" type="MoneyItemType" /><br />
<xs:element name="nalog" type="MoneyItemType" /><br />
<xs:element name="total" type="MoneyItemType" /><br />
<xs:element name="tonna" type="MoneyItemType" /><br />
<xs:element name="tonna_add_free" type="MoneyItemType" /><br />
</xs:sequence><br />
<xs:attribute name="index" type="xs:integer" use="required" /><br />
<xs:attribute name="name" type="xs:string" use="required" /><br />
<xs:attribute name="rst" type="xs:integer" use="required" /><br />
<xs:attribute name="return" type="xs:boolean" use="required" /><br />
<xs:attribute name="id" type="xs:integer" use="required" /><br />
<xs:attribute name="w" type="xs:decimal" use="required" /><br />
<xs:attribute name="gp" type="xs:decimal" use="required" /><br />
<xs:attribute name="spec_tax" type="xs:boolean" use="required" /><br />
</xs:complexType><br />
</xs:element><br />
<xs:element name="total_all" type="MoneyItemType" /><br />
<xs:element name="total_all_nalog" type="MoneyItemType" /><br />
<xs:element name="tonna_all" type="MoneyItemType" /><br />
<xs:element name="guard_all" type="MoneyItemType" /><br />
<xs:element name="guide_c_all" type="MoneyItemType" /><br />
<xs:element name="guide_v_all" type="MoneyItemType" /><br />
<xs:element name="delivery_time"><br />
<xs:complexType><br />
<xs:attribute name="unit" type="xs:string" use="required" /><br />
<xs:attribute name="value" type="xs:integer" use="required" /><br />
</xs:complexType><br />
</xs:element><br />
</xs:sequence><br />
</xs:complexType><br />
</xs:element><br />
<xs:element minOccurs="0" name="request" type="xs:string" /><br />
<xs:element minOccurs="0" name="client_thread" type="xs:string" /><br />
<xs:element minOccurs="0" name="stat"><br />
<xs:complexType><br />
<xs:sequence><br />
<xs:element name="calc_start" type="xs:string" /><br />
<xs:element name="calc_finish" type="xs:string" /><br />
</xs:sequence><br />
</xs:complexType><br />
</xs:element><br />
<xs:element minOccurs="0" name="requests_available"><br />
<xs:complexType><br />
<xs:simpleContent><br />
<xs:extension base="xs:integer"><br />
<xs:attribute name="binded" type="xs:integer" use="optional" /><br />
</xs:extension><br />
</xs:simpleContent><br />
</xs:complexType><br />
</xs:element><br />
</xs:sequence><br />
</xs:complexType><br />
</xs:element><br />
</xs:schema><br />
</syntaxhighlight><br />
<br />
----<br />
<br />
== 7. Получение информации о ключе (лимит и срок действия) ==<br />
<br />
=== Запрос ===<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[ВАШ_API_KEY]</code><br />
<br />
=== Пример XML-ответа ===<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<xml><br />
<status>ok</status><br />
<key_info requests_available="10000000" start_date="2026-01-01 00:00" expire_date="2026-12-31 23:59" /><br />
<requests_available binded="0">10000000</requests_available><br />
</xml><br />
</syntaxhighlight><br />
<br />
=== Описание полей элемента <code>&lt;key_info&gt;</code> ===<br />
* <code>requests_available</code> (integer) — остаток предоплаченных запросов по лицензии.<br />
* <code>start_date</code> (datetime) — дата и время активации ключа.<br />
* <code>expire_date</code> (datetime) — дата и время истечения срока действия ключа.<br />
<br />
----<br />
<br />
== 8. Обработка ошибок ==<br />
<br />
В случае возникновения ошибок (невалидный API-ключ, неверный код станции, невозможность построения маршрута и т.д.) сервер возвращает ответ со статусом <code>error</code>:<br />
<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<xml><br />
<status>error</status><br />
<error>Неверный ключ доступа или срок действия ключа истек</error><br />
</xml><br />
</syntaxhighlight><br />
<br />
{| class="wikitable" style="width: 100%;"<br />
! Типовая ошибка !! Причина возникновения !! Решение<br />
|-<br />
| <code>Неверный ключ доступа...</code> || Параметр <code>api_key</code> отсутствует, недействителен либо истек срок подписки. || Проверить актуальность ключа через <code>type=key_info</code> или обратиться к менеджеру Альта-Софт.<br />
|-<br />
| <code>Станция не найдена</code> || Передан несуществующий 5-значный код станции в <code>fst</code> или <code>tst</code>. || Выполнить поиск по справочнику через <code>type=fst</code> / <code>type=tst</code>.<br />
|-<br />
| <code>Не найден маршрут</code> || Отсутствует прямое или транзитное ж/д сообщение между станциями. || Проверить допустимость коммерческих операций на станциях либо задать промежуточные стыки (<code>dock_stations</code>).<br />
|}<br />
<br />
----<br />
<br />
== Интерактивное тестирование и демонстрация ==<br />
<br />
* Форма интерактивного тестирования всех методов API:<br />
: [http://www.alta.ru/rail_tracking/rail_trf/example.php http://www.alta.ru/rail_tracking/rail_trf/example.php]<br />
* Полнофункциональный веб-интерфейс калькулятора ЖД тарифа:<br />
: [http://www.alta.ru/rail_tracking/rail_trf/demo.php http://www.alta.ru/rail_tracking/rail_trf/demo.php]</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1403API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2026-09-29T06:43:13Z<p>Boluchevskikh: </p>
<hr />
<div>__TOC__<br />
<br />
= Описание протокола обмена данными (API) «ЖД Тариф» от Альта-Софт =<br />
<br />
Сервис предназначен для расчета провозной платы (тарифа) при железнодорожных перевозках грузов по территории России, стран СНГ, Балтии и сопредельных государств, а также для получения нормативно-справочной информации (станции, номенклатура грузов ЕТСНГ/ГНГ, классификатор подвижного состава, государства).<br />
<br />
== Общие положения ==<br />
<br />
* '''Базовый URL:''' <code>https://www.alta.ru/rail_tracking/rail_trf/</code><br />
* '''Протокол:''' HTTP / HTTPS.<br />
* '''Методы запросов:''' <code>GET</code>, <code>POST</code>.<br />
* '''Формат передачи данных:''' XML (кодировка <code>UTF-8</code>).<br />
* '''Аутентификация:''' Обязательный GET/POST-параметр <code>api_key</code>.<br />
<br />
{| class="wikitable" style="width: 100%;"<br />
! Параметр !! Тип !! Обязательный !! Описание<br />
|-<br />
| <code>api_key</code> || string || '''Да''' || Уникальный лицензионный ключ доступа. Выдается после оплаты, имеет ограниченный срок действия (6 месяцев или 1 год) и лимит доступных обращений.<br />
|-<br />
| <code>type</code> || string || '''Да''' || Тип выполняемой операции (<code>fre</code>, <code>frg</code>, <code>fst</code>, <code>tst</code>, <code>states</code>, <code>van_tree</code>, <code>calc</code>, <code>key_info</code>).<br />
|-<br />
| <code>encoding</code> || string || Нет || Кодировка ответа (рекомендуется передавать <code>utf-8</code>).<br />
|}<br />
<br />
----<br />
<br />
== 1. Справочник грузов (ЕТСНГ и ГНГ) ==<br />
<br />
Служит для поиска кодов грузов по ЕТСНГ (Единая тарифно-статистическая номенклатура грузов) и ГНГ (Гармонизированная номенклатура грузов), а также для автоматического сопоставления классификаторов.<br />
<br />
=== Параметры запроса ===<br />
{| class="wikitable" style="width: 100%;"<br />
! Параметр !! Тип !! По умолчанию !! Описание<br />
|-<br />
| <code>type</code> || string || — || Режим выборки:<br />
* <code>fre</code> — поиск по классификатору ЕТСНГ;<br />
* <code>frg</code> — поиск по классификатору ГНГ.<br />
|-<br />
| <code>index</code> || string || ''(пусто)'' || Поисковый запрос: код груза (или первые цифры кода) либо наименование (или фрагмент наименования). Если не задан — возвращается весь справочник.<br />
|-<br />
| <code>corr</code> || string || <code>yes</code> || <code>yes</code> — искать соответствие между ЕТСНГ и ГНГ; <code>no</code> — не выполнять кросс-поиск.<br />
|}<br />
<br />
=== Примеры запросов ===<br />
* Поиск в ЕТСНГ по началу кода с кросс-поиском по ГНГ:<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=fre&index=011&encoding=utf-8&api_key=[ВАШ_API_KEY]</code><br />
* Поиск в ГНГ по наименованию без сопоставления:<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=frg&index=пшен&corr=no&encoding=utf-8&api_key=[ВАШ_API_KEY]</code><br />
<br />
=== Описание полей ответа (XML) ===<br />
Корневой элемент: <code>&lt;fraights&gt;</code> (содержит атрибут <code>last_update</code> — дата актуализации справочника). Внутри расположен список элементов <code>&lt;fraight&gt;</code>.<br />
<br />
{| class="wikitable" style="width: 100%;"<br />
! Атрибут !! Тип !! Присутствует в !! Описание<br />
|-<br />
| <code>index</code> || string || ЕТСНГ / ГНГ || 6-значный код ЕТСНГ или 8-значный код ГНГ.<br />
|-<br />
| <code>name</code> || string || ЕТСНГ / ГНГ || Наименование груза.<br />
|-<br />
| <code>level</code> || integer || ЕТСНГ / ГНГ || Уровень вложенности в иерархическом справочнике (1, 2, 3...).<br />
|-<br />
| <code>parent</code> || string || ЕТСНГ / ГНГ || Код вышестоящего родительского узла/группы.<br />
|-<br />
| <code>isgroup</code> || boolean || ЕТСНГ / ГНГ || <code>true</code> — узел является группой грузов; <code>false</code> — конкретный груз (конечная позиция).<br />
|-<br />
| <code>danger</code> || boolean || ЕТСНГ || <code>true</code> — груз относится к категории опасных.<br />
|-<br />
| <code>guard</code> || boolean || ЕТСНГ || <code>true</code> — груз подлежит обязательной охране (ВОХР/сопровождение).<br />
|-<br />
| <code>frclass</code> || integer || ЕТСНГ || Тарифный класс груза (1, 2 или 3 класс).<br />
|-<br />
| <code>mwn</code> || string || ЕТСНГ || Минимальная весовая норма (МВН): число в тоннах либо <code>ГП</code> (грузоподъемность вагона).<br />
|-<br />
| <code>gng</code> || string || ЕТСНГ || Соответствующий 8-значный код по номенклатуре ГНГ (при <code>corr=yes</code>).<br />
|-<br />
| <code>frnameg</code> || string || ЕТСНГ || Наименование соответствующего груза по ГНГ.<br />
|-<br />
| <code>toetsng</code> || string || ГНГ || Соответствующий код ЕТСНГ (при <code>corr=yes</code>).<br />
|}<br />
<br />
=== Пример XML-ответа ===<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<fraights last_update="17.01.2026"><br />
<fraight index="011005" name="ПШЕНИЦА" level="3" parent="010002" isgroup="false" danger="false" guard="false" frclass="2" mwn="ГП" gng="10019000" frnameg="" /><br />
</fraights><br />
</syntaxhighlight><br />
<br />
----<br />
<br />
== 2. Справочник станций ==<br />
<br />
Служит для поиска железнодорожных станций по названию или коду ЕСР (Единая сетевая разметка), проверки выполняемых коммерческих операций (параграфов ТР №4) и определения принадлежности железной дороге и государству.<br />
<br />
=== Параметры запроса ===<br />
{| class="wikitable" style="width: 100%;"<br />
! Параметр !! Тип !! По умолчанию !! Описание<br />
|-<br />
| <code>type</code> || string || — || <code>fst</code> (станция отправления) или <code>tst</code> (станция назначения). Формат выдачи идентичен.<br />
|-<br />
| <code>index</code> || string || ''(пусто)'' || Поисковый запрос: код станции или наименование (регистронезависимо).<br />
|-<br />
| <code>exactly</code> || integer || <code>0</code> || <code>1</code> — строгое совпадение по наименованию; <code>0</code> — поиск по подстроке (вхождению символов).<br />
|-<br />
| <code>full_code</code> || integer || <code>0</code> || <code>1</code> — возвращать 6-значный код ЕСР (с контрольным знаком); <code>0</code> — стандартный 5-значный тарифный код.<br />
|}<br />
<br />
=== Примеры запросов ===<br />
* Поиск по коду станции:<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=tst&index=104&encoding=utf-8&api_key=[ВАШ_API_KEY]</code><br />
* Поиск по названию станции:<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=fst&index=моск&encoding=utf-8&api_key=[ВАШ_API_KEY]</code><br />
<br />
=== Описание полей ответа (XML) ===<br />
Корневой элемент: <code>&lt;stations&gt;</code> (атрибут <code>count</code> — число найденных записей). Дочерние элементы: <code>&lt;station&gt;</code>.<br />
<br />
{| class="wikitable" style="width: 100%;"<br />
! Атрибут !! Тип !! Описание<br />
|-<br />
| <code>index</code> || string || 5- или 6-значный код станции по ЕСР.<br />
|-<br />
| <code>name</code> || string || Наименование станции.<br />
|-<br />
| <code>paragrafs</code> || string || Номера параграфов Тарифного руководства №4 (коммерческие операции, выполняемые на станции).<br />
|-<br />
| <code>stateindex</code> || integer || Цифровой код государства расположения станции.<br />
|-<br />
| <code>statename</code> || string || Наименование государства.<br />
|-<br />
| <code>roadindex</code> || integer || Код железной дороги.<br />
|-<br />
| <code>roadname</code> || string || Наименование железной дороги (например, Приволжская, Октябрьская).<br />
|-<br />
| <code>tip</code> || integer || Числовой код типа станции.<br />
|-<br />
| <code>tipstr</code> || string || Текстовая расшифровка типа станции (например, «Внутренняя станция», «Пограничная экспортная»).<br />
|-<br />
| <code>toroad</code> || string || Код сопредельной дороги (для стыковых/пограничных станций).<br />
|-<br />
| <code>tostateindex</code> || string || Код сопредельного государства (для погранпереходов).<br />
|-<br />
| <code>tostatename</code> || string || Наименование сопредельного государства.<br />
|}<br />
<br />
=== Пример XML-ответа ===<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<stations count="1"><br />
<station index="62670" name="Питерка" paragrafs="1,3" stateindex="20" statename="Россия" roadindex="61" roadname="Приволжская" tip="10" tipstr="Внутренняя станция" toroad="00" tostatename="" tostateindex="" /><br />
</stations><br />
</syntaxhighlight><br />
<br />
----<br />
<br />
== 3. Справочник государств ==<br />
<br />
Возвращает перечень стран и их идентификаторов, используемых в тарифной системе.<br />
<br />
=== Запрос ===<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=states&api_key=[ВАШ_API_KEY]</code><br />
<br />
=== Описание полей ответа (XML) ===<br />
Корневой элемент: <code>&lt;states&gt;</code>, содержит элементы <code>&lt;state&gt;</code>:<br />
* <code>index</code> (integer) — уникальный код государства в ж/д классификаторе (например, 20 — Россия, 27 — Казахстан, 21 — Беларусь);<br />
* <code>name</code> (string) — наименование государства.<br />
<br />
=== Пример XML-ответа ===<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<states><br />
<state index="20" name="Россия" /><br />
<state index="21" name="Белоруссия" /><br />
<state index="27" name="Казахстан" /><br />
</states><br />
</syntaxhighlight><br />
<br />
----<br />
<br />
== 4. Дерево подвижного состава и перевозочных средств ==<br />
<br />
Возвращает иерархический классификатор вагонов и контейнеров. Конечный атрибут <code>index</code> элемента 3-го уровня используется в расчетах тарифа (параметр <code>van</code>).<br />
<br />
=== Параметры запроса ===<br />
{| class="wikitable" style="width: 100%;"<br />
! Параметр !! Тип !! По умолчанию !! Описание<br />
|-<br />
| <code>type</code> || string || — || Значение <code>van_tree</code>.<br />
|-<br />
| <code>kind</code> || string || <code>xml</code> || Формат вывода: <code>xml</code> (структурированное дерево XML) или <code>html</code> / <code>ul</code> (вложенные списки HTML для отображения на web-страницах).<br />
|}<br />
<br />
=== Пример запроса ===<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&kind=xml&encoding=utf-8&api_key=[ВАШ_API_KEY]</code><br />
<br />
=== Описание полей ответа (XML) ===<br />
Дерево состоит из вложенных элементов <code>&lt;van&gt;</code>:<br />
* <code>level</code> (integer) — уровень иерархии:<br />
** <code>1</code> — вид отправки (Повагонная, Контейнерная);<br />
** <code>2</code> — тип/категория ПС (В универсальных вагонах, В цистернах, Крупнотоннажные контейнеры и т.д.);<br />
** <code>3</code> — конкретный тип подвижного состава (листовой узел).<br />
* <code>name</code> (string) — наименование категории или типа ПС.<br />
* <code>index</code> (integer) — '''код типа ПС'''. Присутствует только на 3-м уровне. Именно это значение передается в параметр <code>van</code> при расчете тарифа (например: <code>200</code> — крытый, <code>400</code> — платформа, <code>600</code> — полувагон, <code>2220</code> — контейнер 20 футов).<br />
<br />
=== Пример XML-ответа ===<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<van_tree><br />
<van level="1" name="Повагонная"><br />
<van level="2" name="В универсальных вагонах"><br />
<van level="3" index="200" name="Крытый" /><br />
<van level="3" index="400" name="Платформа" /><br />
<van level="3" index="600" name="Полувагон" /><br />
</van><br />
</van><br />
<van level="1" name="Контейнерная"><br />
<van level="2" name="Универсальный контейнер"><br />
<van level="3" index="2220" name="Контейнер крупнотоннажный г/п 20 т (20 ft.)" /><br />
<van level="3" index="2430" name="Контейнер крупнотоннажный г/п 30 т (40 ft.)" /><br />
</van><br />
</van><br />
</van_tree><br />
</syntaxhighlight><br />
<br />
----<br />
<br />
== 5. Расчет нитки маршрута и расстояний между станциями ==<br />
<br />
Позволяет построить географический и тарифный маршрут следования с разбивкой по транзитным дорогам, опорным станциям и расчетным плечам без выполнения финансового расчета тарифа.<br />
<br />
=== Параметры запроса ===<br />
{| class="wikitable" style="width: 100%;"<br />
! Параметр !! Тип !! Обязательный !! Описание<br />
|-<br />
| <code>type</code> || string || '''Да''' || Значение <code>calc</code>.<br />
|-<br />
| <code>fst</code> || string || '''Да''' || 5-значный код ЕСР станции отправления.<br />
|-<br />
| <code>tst</code> || string || '''Да''' || 5-значный код ЕСР станции назначения.<br />
|-<br />
| <code>route_only</code> || integer || '''Да''' || Значение <code>1</code> (только маршрут).<br />
|-<br />
| <code>api_key</code> || string || '''Да''' || Лицензионный ключ.<br />
|}<br />
<br />
=== Пример запроса ===<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=calc&fst=69000&tst=19100&route_only=1&api_key=[ВАШ_API_KEY]</code><br />
<br />
Ответ содержит секцию <code>&lt;route&gt;</code>, идентичную блоку маршрута в полном расчете тарифа (см. раздел 6).<br />
<br />
----<br />
<br />
== 6. Расчет ЖД Тарифа ==<br />
<br />
Основной метод системы. Производит комплексный расчет провозных плат, сборов, платы за охрану, нормативных сроков доставки и построение нитки маршрута с детализацией по странам следования.<br />
<br />
=== Входные параметры ===<br />
{| class="wikitable" style="width: 100%;"<br />
! Параметр !! Тип !! По умолч. !! Описание<br />
|-<br />
| <code>type</code> || string || — || Обязательно: <code>calc</code>.<br />
|-<br />
| <code>fst</code> || string || — || Код ЕСР станции отправления (5 знаков).<br />
|-<br />
| <code>tst</code> || string || — || Код ЕСР станции назначения (5 знаков).<br />
|-<br />
| <code>fre</code> || string || — || Код груза по номенклатуре ЕТСНГ (5–6 знаков).<br />
|-<br />
| <code>frg</code> || string || — || Код груза по номенклатуре ГНГ (8 знаков). Если не задан, подбирается автоматически.<br />
|-<br />
| <code>fstate</code> || integer || — || Код государства станции отправления (из справочника <code>states</code>).<br />
|-<br />
| <code>tstate</code> || integer || — || Код государства станции назначения (из справочника <code>states</code>).<br />
|-<br />
| <code>van</code> || integer || — || Идентификатор типа вагона/контейнера из дерева <code>van_tree</code>.<br />
|-<br />
| <code>w</code> || integer/float || — || Масса груза в вагоне (в '''килограммах'''). Общая для всех вагонов отправки.<br />
|-<br />
| <code>gp</code> || integer/float || — || Грузоподъемность вагона (в '''тоннах''').<br />
|-<br />
| <code>owner</code> || integer || <code>0</code> || Принадлежность парка: <code>0</code> — вагон перевозчика (общий парк); <code>1</code> — собственный или арендованный парк.<br />
|-<br />
| <code>empt</code> || integer || <code>0</code> || <code>0</code> — груженый рейс; <code>1</code> — порожний рейс. Для грузов группы ЕТСНГ 421*** установка <code>empt=1</code> обязательна.<br />
|-<br />
| <code>num_vagons</code> || integer || <code>1</code> || Число вагонов в отправке.<br />
|-<br />
| <code>w1...wN</code> || integer || — || Индивидуальный вес груза в кг для вагона № N (например, <code>w2=65000</code>).<br />
|-<br />
| <code>gp1...gpN</code> || integer/float || — || Индивидуальная грузоподъемность вагона № N в тоннах (например, <code>gp3=70</code>).<br />
|-<br />
| <code>return</code> || integer || <code>0</code> || <code>1</code> — рассчитать плату за возврат вагона; <code>0</code> — не рассчитывать.<br />
|-<br />
| <code>return_st</code> || string || <code>fst</code> || Код ЕСР станции возврата вагона (если отличается от станции отправления).<br />
|-<br />
| <code>modular</code> || integer || <code>0</code> || Признак сборной отправки: <code>1</code> — сборная повагонная отправка нескольких грузов.<br />
|-<br />
| <code>fre1...freN</code> || string || — || Коды ЕТСНГ отдельных грузов при сборной отправке (<code>modular=1</code>).<br />
|-<br />
| <code>frg1...frgN</code> || string || — || Коды ГНГ отдельных грузов при сборной отправке.<br />
|-<br />
| <code>route</code> || integer || <code>1</code> || <code>1</code> — включить детальную нитку маршрута в XML; <code>0</code> — скрыть.<br />
|-<br />
| <code>calc_date</code> || string || Текущая || Дата применения тарифов в формате <code>ДД.ММ.ГГГГ</code> (например, <code>23.09.2026</code>).<br />
|-<br />
| <code>currency</code> || string || По странам || Мнемокод валюты итога (<code>RUB</code>, <code>USD</code>, <code>EUR</code>, <code>KZT</code>, <code>CHF</code>). По умолчанию расчет по участкам ведется в нац. валютах транзитных дорог, итог пересчитывается в рубли по курсу ЦБ РФ.<br />
|-<br />
| <code>dock_stations</code> || string || — || Коды стыковых станций через запятую для принудительной маршрутизации (например, <code>66380,54850</code>).<br />
|-<br />
| <code>crimea_bridge</code> || integer || <code>0</code> || Для Крымской ж/д: <code>1</code> — через Крымский мост; <code>0</code> — через паромную переправу Кавказ–Крым.<br />
|-<br />
| <code>for_loading</code> || integer || <code>0</code> || Для порожнего рейса по КТЖ (Казахстан): <code>1</code> — под погрузку; <code>0</code> — из-под выгрузки.<br />
|-<br />
| <code>fre_empty</code> || string || <code>fre</code> || Код ЕТСНГ груза, под погрузку которого следует вагон при порожнем рейсе по КТЖ.<br />
|-<br />
| <code>is_speed</code> || integer || <code>1</code> || <code>1</code> — перевозка большой скоростью; <code>0</code> — без учета надбавки.<br />
|-<br />
| <code>is_cont_train</code> || integer || <code>1</code> || <code>1</code> — в составе регулярного контейнерного поезда; <code>0</code> — повагонная/одиночная отправка.<br />
|}<br />
<br />
=== Примеры запросов ===<br />
<br />
* '''Расчет повагонной отправки (1 вагон):'''<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=calc&fst=01100&tst=66000&fre=01100&frg=10019000&fstate=20&tstate=27&van=200&w=60000&gp=66&owner=0&return=0&empt=0&api_key=[ВАШ_API_KEY]</code><br />
<br />
* '''Многовагонная отправка с индивидуальными параметрами:'''<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=calc&fst=01100&tst=22022&fre=01100&frg=10019000&fstate=20&tstate=20&van=200&w=60000&gp=66&num_vagons=3&w2=65000&gp3=70&owner=1&api_key=[ВАШ_API_KEY]</code><br />
<br />
* '''Сборная повагонная отправка (<code>modular=1</code>):'''<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=calc&fst=19350&tst=97040&fstate=20&tstate=20&van=200&gp=65&modular=1&num_vagons=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&api_key=[ВАШ_API_KEY]</code><br />
<br />
=== Описание структуры XML-ответа ===<br />
<br />
Ответ сервиса включает в себя:<br />
# <code>&lt;status&gt;</code> — общий статус обработки (<code>ok</code> или <code>error</code>).<br />
# <code>&lt;route&gt;</code> — нитка маршрута по странам и участкам.<br />
# <code>&lt;Calc&gt;</code> — блок финансовых результатов по странам и консолидированный итог.<br />
# <code>&lt;stat&gt;</code>, <code>&lt;client_thread&gt;</code>, <code>&lt;requests_available&gt;</code> — сервисная информация и остаток лимита.<br />
<br />
==== Структура блока <code>&lt;route&gt;</code> (Маршрут следования) ====<br />
* <code>&lt;route&gt;</code>:<br />
** <code>total_rst</code> (integer) — общее расстояние маршрута (км);<br />
** <code>from_state</code>, <code>to_state</code> (string) — страны отправления и назначения.<br />
* <code>&lt;st_part&gt;</code> — участок маршрута по территории отдельной страны:<br />
** <code>index</code> (integer) — код страны;<br />
** <code>name</code> (string) — наименование страны;<br />
** <code>rst</code> (integer) — протяженность участка по территории этой страны в км.<br />
* <code>&lt;stage&gt;</code> — расчетное плечо маршрута между ключевыми/стыковыми станциями:<br />
** <code>st1_ecp</code>, <code>st1_name</code> — ЕСР-код и наименование начальной станции плеча;<br />
** <code>st2_ecp</code>, <code>st2_name</code> — ЕСР-код и наименование конечной станции плеча;<br />
** <code>rst</code> (integer) — тарифное расстояние плеча в км.<br />
<br />
==== Структура блока <code>&lt;Calc&gt;</code> (Тарифные составляющие) ====<br />
<br />
Внутри <code>&lt;Calc&gt;</code> для каждого транзитного государства формируется узел <code>&lt;state&gt;</code>.<br />
<br />
'''Атрибуты элемента <code>&lt;state&gt;</code>:'''<br />
{| class="wikitable" style="width: 100%;"<br />
! Атрибут !! Тип !! Описание<br />
|-<br />
| <code>index</code> || integer || Цифровой код государства.<br />
|-<br />
| <code>name</code> || string || Наименование государства.<br />
|-<br />
| <code>rst</code> || integer || Тарифное расстояние по данному государству (км).<br />
|-<br />
| <code>return</code> || boolean || <code>true</code> — плата за порожний возврат; <code>false</code> — груженый рейс.<br />
|-<br />
| <code>id</code> || integer || Порядковый номер вагона в отправке.<br />
|-<br />
| <code>w</code> || integer || Расчетная масса груза в вагоне (кг).<br />
|-<br />
| <code>gp</code> || float || Грузоподъемность вагона (т).<br />
|-<br />
| <code>spec_tax</code> || boolean || Признак применения спецставки/исключительного тарифа.<br />
|}<br />
<br />
'''Дочерние элементы <code>&lt;state&gt;</code> (денежные составляющие):'''<br />
Все узлы содержат атрибуты <code>currency</code> (валюта) и <code>value</code> (сумма с двумя знаками после запятой).<br />
{| class="wikitable" style="width: 100%;"<br />
! Тег !! Описание<br />
|-<br />
| <code>&lt;summa&gt;</code> || Основная тарифная ставка за перевозку (инфраструктурная и локомотивная составляющие).<br />
|-<br />
| <code>&lt;summa_add_free&gt;</code> || Базовая ставка без учета дополнительных сборов.<br />
|-<br />
| <code>&lt;add_taxes&gt;</code> || Сумма дополнительных сборов и плат.<br />
|-<br />
| <code>&lt;guard&gt;</code> || Плата за военизированную охрану груза (ВОХР).<br />
|-<br />
| <code>&lt;nalog&gt;</code> || Сумма налога (НДС). При международных перевозках часто 0.00 (ставка 0%).<br />
|-<br />
| <code>&lt;total_tax_free&gt;</code> || Итоговая сумма по участку без НДС.<br />
|-<br />
| <code>&lt;total&gt;</code> || '''Итоговая провозная плата по стране''' с учетом всех сборов и налогов.<br />
|-<br />
| <code>&lt;tonna_tax_free&gt;</code> || Стоимость перевозки 1 тонны груза по данному участку без НДС.<br />
|-<br />
| <code>&lt;tonna&gt;</code> || Итоговая стоимость перевозки 1 тонны груза по стране с НДС.<br />
|-<br />
| <code>&lt;tonna_add_free&gt;</code> || Стоимость за 1 тонну без дополнительных сборов.<br />
|}<br />
<br />
'''Сводные итоговые элементы блока <code>&lt;Calc&gt;</code>:'''<br />
{| class="wikitable" style="width: 100%;"<br />
! Тег !! Атрибуты !! Описание<br />
|-<br />
| <code>&lt;total_all&gt;</code> || <code>currency</code>, <code>value</code> || '''Полная стоимость перевозки по всему маршруту''' (по всем странам). По умолчанию конвертирована в рубли (RUB).<br />
|-<br />
| <code>&lt;total_all_nalog&gt;</code> || <code>currency</code>, <code>value</code> || Суммарный налог (НДС) по всей перевозке.<br />
|-<br />
| <code>&lt;tonna_all&gt;</code> || <code>currency</code>, <code>value</code> || Суммарная стоимость перевозки 1 тонны по всему маршруту следования.<br />
|-<br />
| <code>&lt;guard_all&gt;</code> || <code>currency</code>, <code>value</code> || Общая плата за вооруженную охрану по всем дорогам.<br />
|-<br />
| <code>&lt;guide_c_all&gt;</code> || <code>currency</code>, <code>value</code> || Плата за проезд проводников отправителя при контейнерной перевозке.<br />
|-<br />
| <code>&lt;guide_v_all&gt;</code> || <code>currency</code>, <code>value</code> || Плата за проезд проводников отправителя в вагоне.<br />
|-<br />
| <code>&lt;delivery_time&gt;</code> || <code>unit</code>, <code>value</code> || '''Нормативный срок доставки'''. Значение <code>value</code> — количество, <code>unit</code> — единица измерения (например, <code>сутки</code>).<br />
|}<br />
<br />
==== Сервисные элементы ответа ====<br />
* <code>&lt;request&gt;</code> — копия входящей строки запроса в блоке CDATA.<br />
* <code>&lt;client_thread&gt;</code> — идентификатор внутреннего потока сервера обработки.<br />
* <code>&lt;stat&gt;</code>:<br />
** <code>&lt;calc_start&gt;</code>, <code>&lt;calc_finish&gt;</code> — временные метки начала и завершения расчета на сервере.<br />
* <code>&lt;requests_available binded="..."&gt;</code> — количество оставшихся оплаченных запросов по ключу.<br />
<br />
=== Пример XML-ответа при расчете тарифа ===<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<xml><br />
<status>ok</status><br />
<route total_rst="3093" from_state="20 Россия" to_state="27 Казахстан"><br />
<st_part index="20" name="Россия" rst="2804"><br />
<stage st1_ecp="01100" st1_name="Кяппесельга" st2_ecp="30260" st2_name="Кошта" rst="741" /><br />
<stage st1_ecp="30260" st1_name="Кошта" st2_ecp="26290" st2_name="Новки II" rst="577" /><br />
<stage st1_ecp="26290" st1_name="Новки II" st2_ecp="24700" st2_name="Красный Узел" rst="492" /><br />
<stage st1_ecp="24700" st1_name="Красный Узел" st2_ecp="65730" st2_name="Кинель" rst="540" /><br />
<stage st1_ecp="65730" st1_name="Кинель" st2_ecp="81300" st2_name="Канисай (эксп.)" rst="454" /><br />
</st_part><br />
<st_part index="27" name="Казахстан" rst="289"><br />
<stage st1_ecp="66650" st1_name="Илецк I (эксп.)" st2_ecp="66000" st2_name="Кандыагаш" rst="289" /><br />
</st_part><br />
</route><br />
<Calc><br />
<state index="20" name="Россия" rst="2804" return="false" id="1" w="60000" gp="66" spec_tax="false"><br />
<summa currency="RUB" value="254403.00" /><br />
<summa_add_free currency="RUB" value="0.00" /><br />
<add_taxes currency="RUB" value="0.00" /><br />
<guard currency="RUB" value="0.00" /><br />
<total_tax_free currency="RUB" value="254403.00" /><br />
<tonna_tax_free currency="RUB" value="4240.05" /><br />
<nalog currency="RUB" value="0.00" /><br />
<total currency="RUB" value="254403.00" /><br />
<tonna currency="RUB" value="4240.05" /><br />
<tonna_add_free currency="RUB" value="4240.05" /><br />
</state><br />
<state index="27" name="Казахстан" rst="289" return="false" id="1" w="60000" gp="66" spec_tax="false"><br />
<summa currency="KZT" value="176003.00" /><br />
<summa_add_free currency="KZT" value="176003.00" /><br />
<add_taxes currency="KZT" value="0.00" /><br />
<guard currency="KZT" value="0.00" /><br />
<total_tax_free currency="KZT" value="176003.00" /><br />
<tonna_tax_free currency="KZT" value="2933.38" /><br />
<nalog currency="KZT" value="0.00" /><br />
<total currency="KZT" value="176003.00" /><br />
<tonna currency="KZT" value="2933.38" /><br />
<tonna_add_free currency="KZT" value="2933.38" /><br />
</state><br />
<total_all currency="RUB" value="288023.00" /><br />
<total_all_nalog currency="RUB" value="0.00" /><br />
<tonna_all currency="RUB" value="4800.38" /><br />
<guard_all currency="" value="0.00" /><br />
<guide_c_all currency="" value="0.00" /><br />
<guide_v_all currency="" value="0.00" /><br />
<delivery_time unit="сутки" value="18" /><br />
</Calc><br />
<request><![CDATA[type=calc&fst=01100&tst=66000&fre=01100&frg=10019000&fstate=20&tstate=27&van=200&w=60000&gp=66&owner=0&return=0&empt=0&api_key=alta_rail&page=calc.xml]]></request><br />
<client_thread>84</client_thread><br />
<stat><br />
<calc_start>29.09.2026 10:15:13</calc_start><br />
<calc_finish>29.09.2026 10:15:15</calc_finish><br />
</stat><br />
<requests_available binded="0">9999999</requests_available><br />
</xml><br />
</syntaxhighlight><br />
<br />
=== XSD-схема валидации ответа расчета тарифа (calc.xsd) ===<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"><br />
<xs:complexType name="MoneyItemType"><br />
<xs:attribute name="currency" type="xs:string" use="optional" /><br />
<xs:attribute name="value" type="xs:decimal" use="required" /><br />
</xs:complexType><br />
<br />
<xs:element name="xml"><br />
<xs:complexType><br />
<xs:sequence><br />
<xs:element name="status" type="xs:string" /><br />
<xs:element minOccurs="0" name="error" type="xs:string" /><br />
<xs:element minOccurs="0" name="route"><br />
<xs:complexType><br />
<xs:sequence><br />
<xs:element maxOccurs="unbounded" name="st_part"><br />
<xs:complexType><br />
<xs:sequence><br />
<xs:element maxOccurs="unbounded" name="stage"><br />
<xs:complexType><br />
<xs:attribute name="st1_ecp" type="xs:string" use="required" /><br />
<xs:attribute name="st1_name" type="xs:string" use="required" /><br />
<xs:attribute name="st2_ecp" type="xs:string" use="required" /><br />
<xs:attribute name="st2_name" type="xs:string" use="required" /><br />
<xs:attribute name="rst" type="xs:integer" use="required" /><br />
</xs:complexType><br />
</xs:element><br />
</xs:sequence><br />
<xs:attribute name="index" type="xs:integer" use="required" /><br />
<xs:attribute name="name" type="xs:string" use="required" /><br />
<xs:attribute name="rst" type="xs:integer" use="required" /><br />
</xs:complexType><br />
</xs:element><br />
</xs:sequence><br />
<xs:attribute name="total_rst" type="xs:integer" use="required" /><br />
<xs:attribute name="from_state" type="xs:string" use="required" /><br />
<xs:attribute name="to_state" type="xs:string" use="required" /><br />
</xs:complexType><br />
</xs:element><br />
<xs:element minOccurs="0" name="Calc"><br />
<xs:complexType><br />
<xs:sequence><br />
<xs:element maxOccurs="unbounded" name="state"><br />
<xs:complexType><br />
<xs:sequence><br />
<xs:element name="summa" type="MoneyItemType" /><br />
<xs:element name="summa_add_free" type="MoneyItemType" /><br />
<xs:element name="add_taxes" type="MoneyItemType" /><br />
<xs:element name="guard" type="MoneyItemType" /><br />
<xs:element name="total_tax_free" type="MoneyItemType" /><br />
<xs:element name="tonna_tax_free" type="MoneyItemType" /><br />
<xs:element name="nalog" type="MoneyItemType" /><br />
<xs:element name="total" type="MoneyItemType" /><br />
<xs:element name="tonna" type="MoneyItemType" /><br />
<xs:element name="tonna_add_free" type="MoneyItemType" /><br />
</xs:sequence><br />
<xs:attribute name="index" type="xs:integer" use="required" /><br />
<xs:attribute name="name" type="xs:string" use="required" /><br />
<xs:attribute name="rst" type="xs:integer" use="required" /><br />
<xs:attribute name="return" type="xs:boolean" use="required" /><br />
<xs:attribute name="id" type="xs:integer" use="required" /><br />
<xs:attribute name="w" type="xs:decimal" use="required" /><br />
<xs:attribute name="gp" type="xs:decimal" use="required" /><br />
<xs:attribute name="spec_tax" type="xs:boolean" use="required" /><br />
</xs:complexType><br />
</xs:element><br />
<xs:element name="total_all" type="MoneyItemType" /><br />
<xs:element name="total_all_nalog" type="MoneyItemType" /><br />
<xs:element name="tonna_all" type="MoneyItemType" /><br />
<xs:element name="guard_all" type="MoneyItemType" /><br />
<xs:element name="guide_c_all" type="MoneyItemType" /><br />
<xs:element name="guide_v_all" type="MoneyItemType" /><br />
<xs:element name="delivery_time"><br />
<xs:complexType><br />
<xs:attribute name="unit" type="xs:string" use="required" /><br />
<xs:attribute name="value" type="xs:integer" use="required" /><br />
</xs:complexType><br />
</xs:element><br />
</xs:sequence><br />
</xs:complexType><br />
</xs:element><br />
<xs:element minOccurs="0" name="request" type="xs:string" /><br />
<xs:element minOccurs="0" name="client_thread" type="xs:string" /><br />
<xs:element minOccurs="0" name="stat"><br />
<xs:complexType><br />
<xs:sequence><br />
<xs:element name="calc_start" type="xs:string" /><br />
<xs:element name="calc_finish" type="xs:string" /><br />
</xs:sequence><br />
</xs:complexType><br />
</xs:element><br />
<xs:element minOccurs="0" name="requests_available"><br />
<xs:complexType><br />
<xs:simpleContent><br />
<xs:extension base="xs:integer"><br />
<xs:attribute name="binded" type="xs:integer" use="optional" /><br />
</xs:extension><br />
</xs:simpleContent><br />
</xs:complexType><br />
</xs:element><br />
</xs:sequence><br />
</xs:complexType><br />
</xs:element><br />
</xs:schema><br />
</syntaxhighlight><br />
<br />
----<br />
<br />
== 7. Получение информации о ключе (лимит и срок действия) ==<br />
<br />
=== Запрос ===<br />
: <code>https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[ВАШ_API_KEY]</code><br />
<br />
=== Пример XML-ответа ===<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<xml><br />
<status>ok</status><br />
<key_info requests_available="10000000" start_date="2026-01-01 00:00" expire_date="2026-12-31 23:59" /><br />
<requests_available binded="0">10000000</requests_available><br />
</xml><br />
</syntaxhighlight><br />
<br />
=== Описание полей элемента <code>&lt;key_info&gt;</code> ===<br />
* <code>requests_available</code> (integer) — остаток предоплаченных запросов по лицензии.<br />
* <code>start_date</code> (datetime) — дата и время активации ключа.<br />
* <code>expire_date</code> (datetime) — дата и время истечения срока действия ключа.<br />
<br />
----<br />
<br />
== 8. Обработка ошибок ==<br />
<br />
В случае возникновения ошибок (невалидный API-ключ, неверный код станции, невозможность построения маршрута и т.д.) сервер возвращает ответ со статусом <code>error</code>:<br />
<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<xml><br />
<status>error</status><br />
<error>Неверный ключ доступа или срок действия ключа истек</error><br />
</xml><br />
</syntaxhighlight><br />
<br />
{| class="wikitable" style="width: 100%;"<br />
! Типовая ошибка !! Причина возникновения !! Решение<br />
|-<br />
| <code>Неверный ключ доступа...</code> || Параметр <code>api_key</code> отсутствует, недействителен либо истек срок подписки. || Проверить актуальность ключа через <code>type=key_info</code> или обратиться к менеджеру Альта-Софт.<br />
|-<br />
| <code>Станция не найдена</code> || Передан несуществующий 5-значный код станции в <code>fst</code> или <code>tst</code>. || Выполнить поиск по справочнику через <code>type=fst</code> / <code>type=tst</code>.<br />
|-<br />
| <code>Не найден маршрут</code> || Отсутствует прямое или транзитное ж/д сообщение между станциями. || Проверить допустимость коммерческих операций на станциях либо задать промежуточные стыки (<code>dock_stations</code>).<br />
|}<br />
<br />
----<br />
<br />
== Интерактивное тестирование и демонстрация ==<br />
<br />
* Форма интерактивного тестирования всех методов API:<br />
: [http://www.alta.ru/rail_tracking/rail_trf/example.php http://www.alta.ru/rail_tracking/rail_trf/example.php]<br />
* Полнофункциональный веб-интерфейс калькулятора ЖД тарифа:<br />
: [http://www.alta.ru/rail_tracking/rail_trf/demo.php http://www.alta.ru/rail_tracking/rail_trf/demo.php]</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1399API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2026-01-30T11:40:12Z<p>Boluchevskikh: /* Расчет ЖД Тарифа */</p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования]. Если необходимо получить весь справочник - то нужно оставить этот параметр пустым. <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
<li><strong>exactly&nbsp;= [0|1]</strong> Искать точное соответствие - 1, по вхождению символов - 0. Только для поиска по наименованию. По умолчанию - 0.<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
По умолчанию код станций содержит 5 символов. В случае, если необходимо получить список с 6-значными кодами, необходимо в запрос включить дополнительный параметр full_code=1. В случае, если необходимо получить весь справочник, то нужно оставить параметр index пустым.<br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления </li><br />
<li>tstate - код страны назначения </li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0. При указании грузов ЕТСНГ группы "421**" обязательно устанавливать этот флаг в 1.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>return_st - код станции возврата для случаев возврата на станцию, отличающуюся от станции отправления. Необязательный, по умолчанию возврат принимается на станцию отправления.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>is_speed - [0|1], default = 1. Расчет перевозки большой скоростью - 1, не включать - 0. Необязательный. </li><br />
<li>is_cont_train - [0|1], default = 1. Расчет перевозки контейнерным поездом - 1, не включать - 0. Необязательный. </li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.</li><br />
<li>crimea_bridge - [0,1], default = 0, необязательный. В случае расчета тарифа на станции Крымской жд можно указать этот параметр. Crimea_bridge=1 - проезд по Крымскому мосту, 0 - проезд через паромную переправу Кавказ-Крым.</li><br />
<li>for_loading - [0,1], default = 0, необязательный. В случае расчета порожнего тарифа между станций Казахских жд: for_loading - 1 - под погрузку, 0 - из-под выгрузки (по умолчанию)</li><br />
<li>fre_empty - 5-и значный код груза ЕТСНГ под погрузку при расчете порожнего рейса по КЗХ, необязательно. По умолчанию принимается равному параметру fre. </li><br />
<li>calc_date - дата, на которую необходимо провести расчет. Необязательно, по умолчанию - текущая дата. Формат: дд.мм.гггг. Например, 23.09.2023. </li><br />
<li>dock_stations - ЕСР-коды станций - промежуточных стыков для расчета альтернативного маршрута через них, необязательный. Например: dock_stations=66380,54850</li><br />
<li>currency - мнемо-код валюты расчета, необязательный. По умолчанию - расчет по странам ведется в национальных валютах, общая сумма - в рублях. При указании этого параметра все суммы будут переведены в указанную валюту по курсу ЦБ РФ на дату расчета. Например, currency=RUB.</li><br />
<br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1389API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2025-08-21T08:03:55Z<p>Boluchevskikh: /* Выполнение запроса на выбор из справочника станций */</p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования]. Если необходимо получить весь справочник - то нужно оставить этот параметр пустым. <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
<li><strong>exactly&nbsp;= [0|1]</strong> Искать точное соответствие - 1, по вхождению символов - 0. Только для поиска по наименованию. По умолчанию - 0.<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
По умолчанию код станций содержит 5 символов. В случае, если необходимо получить список с 6-значными кодами, необходимо в запрос включить дополнительный параметр full_code=1. В случае, если необходимо получить весь справочник, то нужно оставить параметр index пустым.<br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления </li><br />
<li>tstate - код страны назначения </li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0. При указании грузов ЕТСНГ группы "421**" обязательно устанавливать этот флаг в 1.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>return_st - код станции возврата для случаев возврата на станцию, отличающуюся от станции отправления. Необязательный, по умолчанию возврат принимается на станцию отправления.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>is_speed - [0|1], default = 1. Расчет перевозки большой скоростью - 1, не включать - 0. Необязательный. </li><br />
<li>is_cont_train - [0|1], default = 1. Расчет перевозки контейнерным поездом - 1, не включать - 0. Необязательный. </li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.</li><br />
<li>crimea_bridge - [0,1], default = 0, необязательный. В случае расчета тарифа на станции Крымской жд можно указать этот параметр. Crimea_bridge=1 - проезд по Крымскому мосту, 0 - проезд через паромную переправу Кавказ-Крым.</li><br />
<li>for_loading - [0,1], default = 0, необязательный. В случае расчета порожнего тарифа между станций Казахских жд: for_loading - 1 - под погрузку, 0 - из-под выгрузки (по умолчанию)</li><br />
<li>fre_empty - 5-и значный код груза ЕТСНГ под погрузку при расчете порожнего рейса по КЗХ, необязательно. По умолчанию принимается равному параметру fre. </li><br />
<li>calc_date - дата, на которую необходимо провести расчет. Необязательно, по умолчанию - текущая дата. Формат: дд.мм.гггг. Например, 23.09.2023. </li><br />
<li>dock_stations - ЕСР-коды станций - промежуточных стыков для расчета альтернативного маршрута через них, необязательный. Например: dock_stations=66380,54850</li><br />
<br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1373API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2025-02-18T13:49:22Z<p>Boluchevskikh: /* Расчет ЖД Тарифа */</p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования]. Если необходимо получить весь справочник - то нужно оставить этот параметр пустым. <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
По умолчанию код станций содержит 5 символов. В случае, если необходимо получить список с 6-значными кодами, необходимо в запрос включить дополнительный параметр full_code=1. В случае, если необходимо получить весь справочник, то нужно оставить параметр index пустым.<br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления </li><br />
<li>tstate - код страны назначения </li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0. При указании грузов ЕТСНГ группы "421**" обязательно устанавливать этот флаг в 1.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>return_st - код станции возврата для случаев возврата на станцию, отличающуюся от станции отправления. Необязательный, по умолчанию возврат принимается на станцию отправления.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>is_speed - [0|1], default = 1. Расчет перевозки большой скоростью - 1, не включать - 0. Необязательный. </li><br />
<li>is_cont_train - [0|1], default = 1. Расчет перевозки контейнерным поездом - 1, не включать - 0. Необязательный. </li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.</li><br />
<li>crimea_bridge - [0,1], default = 0, необязательный. В случае расчета тарифа на станции Крымской жд можно указать этот параметр. Crimea_bridge=1 - проезд по Крымскому мосту, 0 - проезд через паромную переправу Кавказ-Крым.</li><br />
<li>for_loading - [0,1], default = 0, необязательный. В случае расчета порожнего тарифа между станций Казахских жд: for_loading - 1 - под погрузку, 0 - из-под выгрузки (по умолчанию)</li><br />
<li>fre_empty - 5-и значный код груза ЕТСНГ под погрузку при расчете порожнего рейса по КЗХ, необязательно. По умолчанию принимается равному параметру fre. </li><br />
<li>calc_date - дата, на которую необходимо провести расчет. Необязательно, по умолчанию - текущая дата. Формат: дд.мм.гггг. Например, 23.09.2023. </li><br />
<li>dock_stations - ЕСР-коды станций - промежуточных стыков для расчета альтернативного маршрута через них, необязательный. Например: dock_stations=66380,54850</li><br />
<br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1372API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2025-02-17T12:43:03Z<p>Boluchevskikh: </p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования]. Если необходимо получить весь справочник - то нужно оставить этот параметр пустым. <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
По умолчанию код станций содержит 5 символов. В случае, если необходимо получить список с 6-значными кодами, необходимо в запрос включить дополнительный параметр full_code=1. В случае, если необходимо получить весь справочник, то нужно оставить параметр index пустым.<br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления (необязательный). Если не указан код страны отправления, то автоматически будет установлена РФ.</li><br />
<li>tstate - код страны назначения (необязательный). Если не указан код страны назначения, то автоматически будет установлена РФ.</li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0. При указании грузов ЕТСНГ группы "421**" обязательно устанавливать этот флаг в 1.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>return_st - код станции возврата для случаев возврата на станцию, отличающуюся от станции отправления. Необязательный, по умолчанию возврат принимается на станцию отправления.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>is_speed - [0|1], default = 1. Расчет перевозки большой скоростью - 1, не включать - 0. Необязательный. </li><br />
<li>is_cont_train - [0|1], default = 1. Расчет перевозки контейнерным поездом - 1, не включать - 0. Необязательный. </li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.</li><br />
<li>crimea_bridge - [0,1], default = 0, необязательный. В случае расчета тарифа на станции Крымской жд можно указать этот параметр. Crimea_bridge=1 - проезд по Крымскому мосту, 0 - проезд через паромную переправу Кавказ-Крым.</li><br />
<li>for_loading - [0,1], default = 0, необязательный. В случае расчета порожнего тарифа между станций Казахских жд: for_loading - 1 - под погрузку, 0 - из-под выгрузки (по умолчанию)</li><br />
<li>fre_empty - 5-и значный код груза ЕТСНГ под погрузку при расчете порожнего рейса по КЗХ, необязательно. По умолчанию принимается равному параметру fre. </li><br />
<li>calc_date - дата, на которую необходимо провести расчет. Необязательно, по умолчанию - текущая дата. Формат: дд.мм.гггг. Например, 23.09.2023. </li><br />
<li>dock_stations - ЕСР-коды станций - промежуточных стыков для расчета альтернативного маршрута через них, необязательный. Например: dock_stations=66380,54850</li><br />
<br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1371API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2025-02-17T12:41:10Z<p>Boluchevskikh: </p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования] <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
По умолчанию код станций содержит 5 символов. В случае, если необходимо получить список с 6-значными кодами, необходимо в запрос включить дополнительный параметр full_code=1. В случае, если необходимо получить весь справочник, то нужно оставить параметр index пустым.<br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления (необязательный). Если не указан код страны отправления, то автоматически будет установлена РФ.</li><br />
<li>tstate - код страны назначения (необязательный). Если не указан код страны назначения, то автоматически будет установлена РФ.</li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0. При указании грузов ЕТСНГ группы "421**" обязательно устанавливать этот флаг в 1.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>return_st - код станции возврата для случаев возврата на станцию, отличающуюся от станции отправления. Необязательный, по умолчанию возврат принимается на станцию отправления.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>is_speed - [0|1], default = 1. Расчет перевозки большой скоростью - 1, не включать - 0. Необязательный. </li><br />
<li>is_cont_train - [0|1], default = 1. Расчет перевозки контейнерным поездом - 1, не включать - 0. Необязательный. </li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.</li><br />
<li>crimea_bridge - [0,1], default = 0, необязательный. В случае расчета тарифа на станции Крымской жд можно указать этот параметр. Crimea_bridge=1 - проезд по Крымскому мосту, 0 - проезд через паромную переправу Кавказ-Крым.</li><br />
<li>for_loading - [0,1], default = 0, необязательный. В случае расчета порожнего тарифа между станций Казахских жд: for_loading - 1 - под погрузку, 0 - из-под выгрузки (по умолчанию)</li><br />
<li>fre_empty - 5-и значный код груза ЕТСНГ под погрузку при расчете порожнего рейса по КЗХ, необязательно. По умолчанию принимается равному параметру fre. </li><br />
<li>calc_date - дата, на которую необходимо провести расчет. Необязательно, по умолчанию - текущая дата. Формат: дд.мм.гггг. Например, 23.09.2023. </li><br />
<li>dock_stations - ЕСР-коды станций - промежуточных стыков для расчета альтернативного маршрута через них, необязательный. Например: dock_stations=66380,54850</li><br />
<br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1352API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2024-08-21T16:25:20Z<p>Boluchevskikh: /* Расчет ЖД Тарифа */</p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования] <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
По умолчанию код станций содержит 5 символов. В случае, если необходимо получить список с 6-значными кодами, необходимо в запрос включить дополнительный параметр full_code=1. <br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления (необязательный). Если не указан код страны отправления, то автоматически будет установлена РФ.</li><br />
<li>tstate - код страны назначения (необязательный). Если не указан код страны назначения, то автоматически будет установлена РФ.</li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0. При указании грузов ЕТСНГ группы "421**" обязательно устанавливать этот флаг в 1.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>return_st - код станции возврата для случаев возврата на станцию, отличающуюся от станции отправления. Необязательный, по умолчанию возврат принимается на станцию отправления.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>is_speed - [0|1], default = 1. Расчет перевозки большой скоростью - 1, не включать - 0. Необязательный. </li><br />
<li>is_cont_train - [0|1], default = 1. Расчет перевозки контейнерным поездом - 1, не включать - 0. Необязательный. </li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.</li><br />
<li>crimea_bridge - [0,1], default = 0, необязательный. В случае расчета тарифа на станции Крымской жд можно указать этот параметр. Crimea_bridge=1 - проезд по Крымскому мосту, 0 - проезд через паромную переправу Кавказ-Крым.</li><br />
<li>for_loading - [0,1], default = 0, необязательный. В случае расчета порожнего тарифа между станций Казахских жд: for_loading - 1 - под погрузку, 0 - из-под выгрузки (по умолчанию)</li><br />
<li>fre_empty - 5-и значный код груза ЕТСНГ под погрузку при расчете порожнего рейса по КЗХ, необязательно. По умолчанию принимается равному параметру fre. </li><br />
<li>calc_date - дата, на которую необходимо провести расчет. Необязательно, по умолчанию - текущая дата. Формат: дд.мм.гггг. Например, 23.09.2023. </li><br />
<li>dock_stations - ЕСР-коды станций - промежуточных стыков для расчета альтернативного маршрута через них, необязательный. Например: dock_stations=66380,54850</li><br />
<br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1351API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2024-08-21T16:24:40Z<p>Boluchevskikh: /* Расчет ЖД Тарифа */</p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования] <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
По умолчанию код станций содержит 5 символов. В случае, если необходимо получить список с 6-значными кодами, необходимо в запрос включить дополнительный параметр full_code=1. <br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления (необязательный). Если не указан код страны отправления, то автоматически будет установлена РФ.</li><br />
<li>tstate - код страны назначения (необязательный). Если не указан код страны назначения, то автоматически будет установлена РФ.</li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0. При указании грузов ЕТСНГ группы "421**" обязательно устанавливать этот флаг в 1.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>return_st - код станции возврата для случаев возврата на станцию, отличающуюся от станции отправления. Необязательный, по умолчанию возврат принимается на станцию отправления.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>is_speed - [0|1], default = 1. Расчет перевозки большой скоростью - 1, не включать - 0. Необязательный. </li><br />
<li>is_cont_train - [0|1], default = 1. Расчет перевозки контейнерным поездом - 1, не включать - 0. Необязательный. </li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.</li><br />
<li>crimea_bridge - [0,1], default = 0, необязательный. В случае расчета тарифа на станции Крымской жд можно указать этот параметр. Crimea_bridge=1 - проезд по Крымскому мосту, 0 - проезд через паромную переправу Кавказ-Крым.</li><br />
<li>for_loading - [0,1], default = 0, необязательный. В случае расчета порожнего тарифа между станций Казахских жд: for_loading - 1 - под погрузку, 0 - из-под выгрузки (по умолчанию)</li><br />
<li>fre_empty - 5-и значный код груза ЕТСНГ под погрузку при расчете порожнего рейса по КЗХ, необязательно. По умолчанию принимается равному параметру fre. </li><br />
<li>calc_date - дата, на которую необходимо провести расчет. Необязательно, по умолчанию - текущая дата. Формат: дд.мм.гггг. Например, 23.09.2023. </li><br />
<li>dock_stations - коды станций-промежуточных стыки для расчета маршрута через них, необязательный. Например: dock_stations=66380,54850</li><br />
<br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1345API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2024-07-17T05:46:52Z<p>Boluchevskikh: /* Расчет ЖД Тарифа */</p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования] <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
По умолчанию код станций содержит 5 символов. В случае, если необходимо получить список с 6-значными кодами, необходимо в запрос включить дополнительный параметр full_code=1. <br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления (необязательный). Если не указан код страны отправления, то автоматически будет установлена РФ.</li><br />
<li>tstate - код страны назначения (необязательный). Если не указан код страны назначения, то автоматически будет установлена РФ.</li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0. При указании грузов ЕТСНГ группы "421**" обязательно устанавливать этот флаг в 1.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>return_st - код станции возврата для случаев возврата на станцию, отличающуюся от станции отправления. Необязательный, по умолчанию возврат принимается на станцию отправления.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>is_speed - [0|1], default = 1. Расчет перевозки большой скоростью - 1, не включать - 0. Необязательный. </li><br />
<li>is_cont_train - [0|1], default = 1. Расчет перевозки контейнерным поездом - 1, не включать - 0. Необязательный. </li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.</li><br />
<li>crimea_bridge - [0,1], default = 0, необязательный. В случае расчета тарифа на станции Крымской жд можно указать этот параметр. Crimea_bridge=1 - проезд по Крымскому мосту, 0 - проезд через паромную переправу Кавказ-Крым.</li><br />
<li>for_loading - [0,1], default = 0, необязательный. В случае расчета порожнего тарифа между станций Казахских жд: for_loading - 1 - под погрузку, 0 - из-под выгрузки (по умолчанию)</li><br />
<li>fre_empty - 5-и значный код груза ЕТСНГ под погрузку при расчете порожнего рейса по КЗХ, необязательно. По умолчанию принимается равному параметру fre. </li><br />
<li>calc_date - дата, на которую необходимо провести расчет. Необязательно, по умолчанию - текущая дата. Формат: дд.мм.гггг. Например, 23.09.2023. </li><br />
<br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1329API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2023-11-13T12:34:47Z<p>Boluchevskikh: </p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования] <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
По умолчанию код станций содержит 5 символов. В случае, если необходимо получить список с 6-значными кодами, необходимо в запрос включить дополнительный параметр full_code=1. <br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления (необязательный). Если не указан код страны отправления, то автоматически будет установлена РФ.</li><br />
<li>tstate - код страны назначения (необязательный). Если не указан код страны назначения, то автоматически будет установлена РФ.</li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0. При указании грузов ЕТСНГ группы "421**" обязательно устанавливать этот флаг в 1.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>is_speed - [0|1], default = 1. Расчет перевозки большой скоростью - 1, не включать - 0. Необязательный. </li><br />
<li>is_cont_train - [0|1], default = 1. Расчет перевозки контейнерным поездом - 1, не включать - 0. Необязательный. </li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.</li><br />
<li>crimea_bridge - [0,1], default = 0, необязательный. В случае расчета тарифа на станции Крымской жд можно указать этот параметр. Crimea_bridge=1 - проезд по Крымскому мосту, 0 - проезд через паромную переправу Кавказ-Крым.</li><br />
<li>for_loading - [0,1], default = 0, необязательный. В случае расчета порожнего тарифа между станций Казахских жд: for_loading - 1 - под погрузку, 0 - из-под выгрузки (по умолчанию)</li><br />
<li>fre_empty - 5-и значный код груза ЕТСНГ под погрузку при расчете порожнего рейса по КЗХ, необязательно. По умолчанию принимается равному параметру fre. </li><br />
<li>calc_date - дата, на которую необходимо провести расчет. Необязательно, по умолчанию - текущая дата. Формат: дд.мм.гггг. Например, 23.09.2023. </li><br />
<br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1326API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2023-10-04T09:42:53Z<p>Boluchevskikh: /* Выполнение запроса на выбор из справочника станций */</p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования] <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
По умолчанию код станций содержит 5 символов. В случае, если необходимо получить список с 6-значными кодами, необходимо в запрос включить дополнительный параметр full_code=1. <br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления (необязательный). Если не указан код страны отправления, то автоматически будет установлена РФ.</li><br />
<li>tstate - код страны назначения (необязательный). Если не указан код страны назначения, то автоматически будет установлена РФ.</li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0. При указании грузов ЕТСНГ группы "421**" обязательно устанавливать этот флаг в 1.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>is_speed - [0|1], default = 1. Расчет перевозки большой скоростью - 1, не включать - 0. Необязательный. </li><br />
<li>is_cont_train - [0|1], default = 1. Расчет перевозки контейнерным поездом - 1, не включать - 0. Необязательный. </li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.</li><br />
<li>crimea_bridge - [0,1], default = 0, необязательный. В случае расчета тарифа на станции Крымской жд можно указать этот параметр. Crimea_bridge=1 - проезд по Крымскому мосту, 0 - проезд через паромную переправу Кавказ-Крым.</li><br />
<li>for_loading - [0,1], default = 0, необязательный. В случае расчета порожнего тарифа между станций Казахских жд: for_loading - 1 - под погрузку, 0 - из-под выгрузки (по умолчанию)</li><br />
<li>fre_empty - 5-и значный код груза ЕТСНГ под погрузку при расчете порожнего рейса по КЗХ, необязательно. По умолчанию принимается равному параметру fre. </li><br />
<br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1325API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2023-09-13T15:18:00Z<p>Boluchevskikh: /* Расчет ЖД Тарифа */</p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования] <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления (необязательный). Если не указан код страны отправления, то автоматически будет установлена РФ.</li><br />
<li>tstate - код страны назначения (необязательный). Если не указан код страны назначения, то автоматически будет установлена РФ.</li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0. При указании грузов ЕТСНГ группы "421**" обязательно устанавливать этот флаг в 1.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>is_speed - [0|1], default = 1. Расчет перевозки большой скоростью - 1, не включать - 0. Необязательный. </li><br />
<li>is_cont_train - [0|1], default = 1. Расчет перевозки контейнерным поездом - 1, не включать - 0. Необязательный. </li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.</li><br />
<li>crimea_bridge - [0,1], default = 0, необязательный. В случае расчета тарифа на станции Крымской жд можно указать этот параметр. Crimea_bridge=1 - проезд по Крымскому мосту, 0 - проезд через паромную переправу Кавказ-Крым.</li><br />
<li>for_loading - [0,1], default = 0, необязательный. В случае расчета порожнего тарифа между станций Казахских жд: for_loading - 1 - под погрузку, 0 - из-под выгрузки (по умолчанию)</li><br />
<li>fre_empty - 5-и значный код груза ЕТСНГ под погрузку при расчете порожнего рейса по КЗХ, необязательно. По умолчанию принимается равному параметру fre. </li><br />
<br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1308JSON-API сервиса поиска вагонов2023-04-11T08:37:59Z<p>Boluchevskikh: </p>
<hr />
<div>==О сервисе==<br />
JSON-API сервиса «Поиск вагонов» позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно ставить и снимать вагоны и контейнеры на слежение по СНГ, странам Балтии, Монголии и Китаю.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET или POST. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса для поиска вагонов - всегда '''rail_tracking'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5('alta_test')") = bb92dcee8bf2b49287e1038b65a72b79 <br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих номеров: <br><br />
вагоны - 54676515 <br><br />
контейнеры - AMFU8899067 <br><br />
<br />
Hash для получения ответов по вагонам:<br />
- слежение ebc356dfa5beee7d3844ccacf535410c <br><br />
Cont_hash для получения ответов по контейнерам:<br />
- слежение 931700e35d7ff88a10bd5d680da50f02 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом эелементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о дислокации, список вагонов и проч.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}<br />
<br />
==Постановка вагонов/контейнеров на слежение. Метод "add".==<br />
Постановка на слежение выполняется с помощью метода "add". <br><br />
<br />
Обращаем внимание, что в связи с особенностями работы системы слежения получение первого отчета с актуальными данными возможно не ранее 3-6 часов с момента постановкии на слежение (иногда до 12).<br />
В противном случае могут прийти устаревшие данные (или не прийти вовсе). Особенно это характерно для контейнеров<br />
Например:<br />
На слежение был поставлен контейнер в начале рабочего дня в 09:00. Время обновления данных: 09:30, 14:30 и 17:30.<br />
В 09:30 этого же дня с высокой долей вероятности будут получены неактуальные (устаревшие) данные или данных не будет. В 14:30 и 17:30 будут получены уже актуализированные отчеты.<br />
Все последующие сутки актуальные отчеты будут приходить в любое из указанного в расписании время, т.е. и в 09:30 следующих суток уже придут свежие данные. <br/><br />
<br />
Существует несколько регионов слежения: РФ, СНГ и Балтия, СНГ и Балтия + Китай + Монголия. Ниже описаны основные особенности:<br><br />
- При слежении первый ответ (обновление) может формироваться довольно продолжительное время: от 3 часов по РФ до суток по странам Средней Азии и Китаю. <br />
- В течение суток можно получить до 3-х обновлений дислокации за одну цену.<br />
- Стоимость слежения по РФ значительно ниже слежения по другим регионам. Однако, в случае пересечения перевозочного средства границы нет никаких гарантий, что свежая информация продолжит поступать.<br />
- Слежение по СНГ и Балтии, Китаю и Монголии позволяет получать дислокацию по всем перечисленным регионам, независимо от того, где находится ПС<br />
- При постановке ПС на слежение задается регламент получения отчетов - в какой день недели и какое время удобно получать свежую информацию, а также способ снятия со слежения (ручной или автоматический)<br />
- Существуют 2 типа слежения: посуточное и рейс. Единственное отличие между ними - в способе тарификации. Посуточное слежение - это такой тип слежения, когда денежные средства списываются со счета клиента при очередном формировании отчета (т.е. первом отчете за сутки согласно расписанию). Рейс тарифицируется сразу за весь маршрут при постановке на слежение и нет необходимости следить за состоянием баланса.<br />
- Для слежения информация по hash будет постоянно обновляться до окончания слежения. <br />
Ниже приводится полный список входных параметров. Жирным шрифтом отмечены те из них, значению которых следует уделить внимание при постановке на слежение:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||add - добавление запроса на слежение<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067"<br />
<br />
|-<br />
|<b>state</b>||string||Код страны, по которой осуществляется запрос. Для РФ, СНГ, Балтии, Монголии, Китая - 20. <br />
<br />
|-<br />
|<b>track_state</b>||string||Регион слежения. ru - Россия, СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|<b>track_type</b>||int||Тип слежения. Для посуточного слежения запроса track_type=2, для рейса - track_type=3<br />
<br />
|-<br />
|<b>stop_station</b>||string||Снимать ли со слежения по прибытию на станцию назначения. "yes" - снимать, "no" - не снимать. Если указать <код ЕСР> - снимать по прибытию на станцию с кодом <код ЕСР>. Код ЕСР - 5-и значный код станции согласно Единой Сетевой Разметке (ЕСР). <br />
<br />
|-<br />
|<b>times</b>||string||Время обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Формат: "H:i", через запятую. Например: "09:00,13:00,18:00". Время московское. <br />
<br />
|-<br />
|<b>times_per_day</b>||string||Количество обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Если указано, что times меньше times_per_day, то times имеет больший приоритет. Например, times_per_day="2", a times="09:00,13:00,18:00", то отчет будет сформирован только в первое время и второе время, т.е. в 09:00 и в 13:00.<br />
<br />
|-<br />
|<b>days</b>||string||Дни недели, по которым необходимо получать отчет, через запятую. Номера начинаются с нуля (Воскресенье) до 6 (Суббота). Например, если отчеты необходимы по будням, то days="1,2,3,4,5". <br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу в urlencode<br />
<br />
|-<br />
|emails||string||Список email-адресов, куда отправить отчет о дислокации после выполнения, через запятую.<br />
<br />
|-<br />
|email_report_type||int||Всегда 2<br />
<br />
|-<br />
|attach_excel||int||Вкладывать ли в письма копию отчета в Excel. 1 - вкладывать, 0 - не вкладывать. По умолчанию 0.<br />
<br />
|}<br />
<br />
==Пример постановки на слежение==<br />
Контейнер AMFU8899067, получение инфорамции по будням дням (days=1,2,3,4,5) в 09:00 и 13:00 по московскому времени (times=09:00,13:00 и times_per_day=2), регион - только РФ (track_state=ru, state=20) без снятия со слежения по прибытии на станцию назначения (stop_station=no, т.е. ручное снятие), адреса для рассылки отчетов alta@alta.ru,mymail@mymail.com (emails=alta@alta.ru,mymail@mymail.com):<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&wagons=AMFU8899067&state=20&track_type=2&comment=%D0%BF%D0%B5%D1%80%D0%B2%D0%BE%D0%B5+%D1%81%D0%BB%D0%B5%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5+%28%D0%BA%D0%BE%D0%BD%D1%82%29&days=1,2,3,4,5&times_per_day=2&times=09:00,13:00&track_state=ru&stop_station=no&emails=alta@alta.ru,mymail@mymail.com<br />
<br><br />
JSON-ответ включает в себя отчет о состоянии запроса на слежение (поставлен/не поставлен на слежение) и hash, по которому можно получить ответ.<br><br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"cont_hash": "931700e35d7ff88a10bd5d680da50f02"<br />
}<br />
]<br />
</source><br />
<br />
При постановке вагона на слежение получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c"<br />
}<br />
]<br />
</source><br />
<br />
Поля hash и cont_hash можно использовать для получения <b>текущей</b> дислокации (согласно расписанию).<br />
<br />
==Получение ответа на ПС, стоящих на слежении. Метод "show". ==<br />
После размещения запроса он встает в очередь на обработку. В обозначенный момент времени (по расписанию) запрос выполняется. Обычно обработка запроса на слежение занимает около 1 минуты. В случае повышенной нагрузки на сервер обработка может занимать до 5 минут и более. <br><br />
Оптимальный период опроса сервера - 1 минута. В случае частых запросов ООО "Альта-Софт" оставляет за собой право заблокировать такие запросы и отказать в обслуживании. <br><br />
Для получение последней дислокации необходимо вызвать метод "show". <br><br><br />
Например, для получения дислокации контейнера AMFU8899067: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=show&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
JSON-ответ включает в себя отчет о состоянии запроса (в очереди/обрабатывается/обработан) в первом элементе массива, в последующих элементах - отчет о дислокации перевозочных средств.<br />
Например, на запрос AMFU8899067 получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Обработан",<br />
"query_status": "4",<br />
"hash": "fece39d1523836d03c3c2da73a6f1275",<br />
"type": "2",<br />
"count": 1<br />
},<br />
{<br />
"num": "AMFU8899067",<br />
"on_track": 0,<br />
"station": "24160",<br />
"station_name": "Вековка",<br />
"state": "20",<br />
"state_name": "Россия",<br />
"lon": "40.764762",<br />
"lat": "55.498762",<br />
"road_name": "Горьковская",<br />
"op_date": "2017-12-05 20:03:00",<br />
"departure_date": "2017-12-03 14:06:00",<br />
"route_start_date": "",<br />
"delivery_date": "2017-12-15 00:00:00",<br />
"etd_date": "2017-12-20:00:00",<br />
"operation": "ПРИБЫТИЕ С ПОЕЗДОМ НА СТАНЦИЮ",<br />
"nakl_nom": "",<br />
"okpo": "94421386",<br />
"owner": null,<br />
"kgro": "1386",<br />
"kgrp": "7575",<br />
"train_index": "18290-853-98130",<br />
"train_number": "1282",<br />
"fraight": "51403",<br />
"fraight_name": "Изделия кондитерские сахаристые, н.п.",<br />
"weight": "13000",<br />
"wagon_number": "94785045",<br />
"station_from": "18290",<br />
"is_loaded": 1,<br />
"hash": "ea7a000c4649388f68af14051f0827a04f11a2ee",<br />
"station_to": "98130",<br />
"station_from_name": "Тучково",<br />
"station_to_name": "Первая Речка",<br />
"route": "8928"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|-<br />
|type||string||Тип запроса. 1- вагоны, 2 - контейнеры<br />
<br />
|-<br />
|query_status||string||Состояние запроса. 1 - в очереди, 2 - обрабатывается, 3 или 4 - обработан<br />
<br />
|-<br />
|count||int||Количество перевозочных средств в отчете<br />
<br />
|-<br />
|hash||string||Хэш запроса.<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы''' (при query_status больше 2)<br />
<br />
|-<br />
|num||string||Номер перевозочного средства<br />
<br />
|-<br />
|station||string||Код станции, где была зафиксирована последняя операция с перевозочным средством. 5 символов(или 6 символов, 6-й - контрольный знак). В случае отсутствия данных по дислокации ПС значение будет "no_data".<br />
|-<br />
|station_name||string||Название станции, где была зафиксирована последняя операция с перевозочным средством. <br />
<br />
|-<br />
|op_date||string||Дата фиксирования последней операции. В формате "Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|operation||string||Наименование последней операции<br />
<br />
|-<br />
|route||string||Оставшееся до станции назначения расстояние, км<br />
<br />
|-<br />
|on_track||int||Стоит ли перевозочное средство на слежении. 1 - стоит, 0 - снят или оперативный запрос<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|state||string||Код государства станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|state_name||string||Название государства станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|lon||string||Долгота станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|lat||string||Широта станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|road_name||string||Дорога, где была зафиксирована последняя операция<br />
<br />
|-<br />
|departure_date||string||Дата отправки. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|route_start_date||string||Дата начала рейса. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|delivery_date||string||Ожидаемая дата прибытия на ст. назначения. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|etd_date||string||Ожидаемая дата доставки контейнера грузополучателю после раскредитовки. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|nakl_nom||string||Номер накладной<br />
<br />
|-<br />
|okpo||string||ОКПО отправителя<br />
<br />
|-<br />
|owner||string||Собственник перевозочного средства<br />
<br />
|-<br />
|kgro||string||Номер грузоотправителя<br />
|-<br />
<br />
|kgrp||string||Номер грузополучателя<br />
|-<br />
<br />
|train_index||string||Индекс поезда<br />
|-<br />
<br />
|train_number||string||Номер поезда<br />
|-<br />
<br />
|fraight||string||Код груза по номенклатуре ЕТСНГ<br />
|-<br />
<br />
|fraight_name||string||Наименование груза<br />
|-<br />
<br />
|weight||string||Вес груза (чаще всего в килограммах, но может быть в центнерах или тоннах)<br />
|-<br />
<br />
|wagon_number||string||Номер вагона (платформы), на котором закреплен контейнер (только для контейнерных запросов)<br />
|-<br />
<br />
|station_from||string||Код станции отправления<br />
|-<br />
<br />
|station_from_name||string||Название станции отправления<br />
|-<br />
<br />
|station_to||string||Код станции назначения<br />
|-<br />
<br />
|station_to_name||string||Название станции назначения<br />
|-<br />
<br />
|is_loaded||int||1 - груженый, 0 - порожний<br />
|-<br />
<br />
|sender_name||string||Наименование грузоотправителя<br />
|-<br />
<br />
|rcpt_name||string||Наименование грузополучателя<br />
|-<br />
<br />
|}<br />
<br />
<br />
==Снятие со слежения. Метод cancel_track.==<br />
<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||cancel_track - снятие со слежения запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например, ebc356dfa5beee7d3844ccacf535410c<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. В случае указания списка со слежения будут сняты только те ПС, которые в нем указаны, а не весь запрос. Например, "54676515"<br />
<br />
|}<br />
<br />
== Пример снятия со слежения==<br />
Снять со слежения вагон 54676515 из запроса с hash ebc356dfa5beee7d3844ccacf535410c<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=ebc356dfa5beee7d3844ccacf535410c&wagons=54676515<br />
<br />
Снять со слежения '''весь''' (т.е. все перевозочные средства из запроса) запрос с hash 931700e35d7ff88a10bd5d680da50f02<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Обратите внимание, что для тестовых данных ответ на запрос снятия со слежения будет "успешно", однако фактически запросы останутся на слежении.<br />
<br />
== Получение списка запросов на слежении. Метод "track_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||track_list - список запросов, стоящих на слежении<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=track_list&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"name": "первое слежение",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c",<br />
"modify_date": "29.07.2021 21:52",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
},<br />
{<br />
"name": "первое слежение (конт)",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "931700e35d7ff88a10bd5d680da50f02",<br />
"modify_date": "03.08.2021 13:10",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу<br />
<br />
|-<br />
|vagon_count||string||Количество ПС в запросе<br />
<br />
|-<br />
|email||string||Адреса электронной почты для рассылки отчетов о дислокации, через запятую.<br />
<br />
|-<br />
|hash||string||Hash запроса.<br />
<br />
|-<br />
|modify_date||string||Дата последнего изменения/выполнения запроса.<br />
<br />
|-<br />
|on_track||string||Стоит ли запрос на слежении. 1 - стоит, 0 - снят.<br />
<br />
|-<br />
|track_type||string||Тип слежения. 1 - постоянное, 2 - рейс. Обратите внимание, нумерация в данном случае отличае от таковой при постановке на слежение./<br />
<br />
|-<br />
|track_state||string||Регион слежения. ru - только РФ, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|state||string||Государство слежения. 20 - РФ, 22 - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|status||int||Статус обработки запроса. 1 - в очереди на обработку, 2 - обрабатывается, 3,4 - обработан<br />
<br />
|}<br />
<br />
== Получение списка ПС в запросе. Метод "carr_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||carr_list - список номеров перевозочных средств в запросе<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например 931700e35d7ff88a10bd5d680da50f02<br />
<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=carr_list&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"group_id": 1519743,<br />
"carrs": [<br />
"AMFU8899067"<br />
]<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|carrs||string||Массив номеров перевозочных средств в запросе<br />
<br />
|}<br />
<br />
== Получение баланса. Метод "balance"==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||balance - остаток денежных средств или бонусов на счету <br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=balance&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
Json-ответ<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Ваш баланс: 0.00 руб. / Бонусы 0",<br />
"balans": "0.00",<br />
"bonus": 0,<br />
"sa": "sa000000"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Остаток денежных средств/бонусов в текстовом виде<br />
<br />
|-<br />
|balans||string||Остаток денежных средств в рублях<br />
<br />
|-<br />
|bonus||string||Остаток бонусов<br />
<br />
|-<br />
|sa||string||Номер договора (сервис-аккаунта)<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1305API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2023-01-18T19:20:26Z<p>Boluchevskikh: /* Расчет ЖД Тарифа */</p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования] <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления (необязательный). Если не указан код страны отправления, то автоматически будет установлена РФ.</li><br />
<li>tstate - код страны назначения (необязательный). Если не указан код страны назначения, то автоматически будет установлена РФ.</li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>is_speed - [0|1], default = 1. Расчет перевозки большой скоростью - 1, не включать - 0. Необязательный. </li><br />
<li>is_cont_train - [0|1], default = 1. Расчет перевозки контейнерным поездом - 1, не включать - 0. Необязательный. </li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.</li><br />
<li>crimea_bridge - [0,1], default = 0, необязательный. В случае расчета тарифа на станции Крымской жд можно указать этот параметр. Crimea_bridge=1 - проезд по Крымскому мосту, 0 - проезд через паромную переправу Кавказ-Крым.</li><br />
<li>for_loading - [0,1], default = 0, необязательный. В случае расчета порожнего тарифа между станций Казахских жд: for_loading - 1 - под погрузку, 0 - из-под выгрузки (по умолчанию)</li><br />
<li>fre_empty - 5-и значный код груза ЕТСНГ под погрузку при расчете порожнего рейса по КЗХ, необязательно. По умолчанию принимается равному параметру fre. </li><br />
<br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1304API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2023-01-09T08:41:09Z<p>Boluchevskikh: /* Расчет ЖД Тарифа */</p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования] <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления (необязательный). Если не указан код страны отправления, то автоматически будет установлена РФ.</li><br />
<li>tstate - код страны назначения (необязательный). Если не указан код страны назначения, то автоматически будет установлена РФ.</li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>is_speed - [0|1], default = 1. Расчет перевозки большой скоростью - 1, не включать - 0. Необязательный. </li><br />
<li>is_cont_train - [0|1], default = 1. Расчет перевозки контейнерным поездом - 1, не включать - 0. Необязательный. </li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.</li><br />
<li>crimea_bridge - [0,1], default = 0, необязательный. В случае расчета тарифа на станции Крымской жд можно указать этот параметр. Crimea_bridge=1 - проезд по Крымскому мосту, 0 - проезд через паромную переправу Кавказ-Крым.</li><br />
<br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1303API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2023-01-09T08:40:37Z<p>Boluchevskikh: /* Расчет ЖД Тарифа */</p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования] <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления (необязательный). Если не указан код страны отправления, то автоматически будет установлена РФ.</li><br />
<li>tstate - код страны назначения (необязательный). Если не указан код страны назначения, то автоматически будет установлена РФ.</li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>is_speed - [0|1], default = 1. Расчет перевозки большой скоростью - 1, не включать - 0. Необязательный. </li><<br />
<li>is_cont_train - [0|1], default = 1. Расчет перевозки контейнерным поездом - 1, не включать - 0. Необязательный. </li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.</li><br />
<li>crimea_bridge - [0,1], default = 0, необязательный. В случае расчета тарифа на станции Крымской жд можно указать этот параметр. Crimea_bridge=1 - проезд по Крымскому мосту, 0 - проезд через паромную переправу Кавказ-Крым.</li><br />
<br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%B4%D0%BB%D1%8F_%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0_%D0%93%D0%9D%D0%93_%D0%B8_%D0%95%D0%A2%D0%A1%D0%9D%D0%93_%D0%BF%D0%BE_%D0%BA%D0%BE%D0%B4%D1%83_%D0%A2%D0%9D_%D0%92%D0%AD%D0%94&diff=1302API для получения кода ГНГ и ЕТСНГ по коду ТН ВЭД2022-12-27T09:09:09Z<p>Boluchevskikh: </p>
<hr />
<div>==О сервисе==<br />
API сервиса получения кодов ГНГ/ЕТСНГ по коду (и/или наименованию) ТН ВЭД позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно получить список кодов ГНГ/ЕТСНГ, наиболее подходящих заданному коду (наименованию) ТН ВЭД.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса - всегда '''gng_by_tnved'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("gng_by_tnved:sa000000:md5('alta_test')") = 6a962b91c37377a3be8f0c953aef0d3d<br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих кодов ТН ВЭД: <br><br />
8702109120 <br><br />
2710122100 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом элементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о подобранных кодах ГНГ и ЕТСНГ<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|}<br />
<br />
<br />
==Получение списка кодов номенклатур ГНГ и ЕТСНГ по коду ТН ВЭД==<br />
<br />
Необходимо выполнить запрос указанием GET-параметра tncode (см. примеры ниже).<br />
В случае отсутствия результата или его неудовлетворительности можно дополнительно указать наименование позиции ТН ВЭД (или часть наименования) в параметре srchstr (в urlencode). <br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например, 6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
|-<br />
|<b>tncode</b>||string||Код позиции ТН ВЭД. Например, 2710122100<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|srchstr||string||Наименование (часть наименования) позиции ТН ВЭД в urlencode. Например, urlencode('Уайт-Спирит').<br />
<br />
|}<br />
<br />
==Пример получения списка грузов ГНГ/ЕТСНГ по коду ТН ВЭД==<br />
<br />
<b>Получить список грузов ГНГ и ЕТСНГ по коду ТН ВЭД 8702109120:</b><br/><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=gng_by_tnved&tncode=8702109120&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
<br><br />
JSON-ответ включает в себя список подобранных грузов номенклатур ГНГ и ЕТСНГ.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"success": true,<br />
"tncode": "8702109120"<br />
},<br />
{<br />
"gng_node": {<br />
"index": "87021091",<br />
"name": "Средства моторные транспортные, предназначенные для перевозки 10 человек или более, включая водителя, с поршневым двигателем внутреннего сгорания с воспламенением от сжатия (дизелем или полудизелем, с рабочим объемом цилиндров двигателя не более 2500 куб.",<br />
"ett_class": "1",<br />
"etsng_list": [<br />
{<br />
"index": "381025",<br />
"name": "Автобусы",<br />
"frclass": 3,<br />
"guard": true,<br />
"danger": false<br />
},<br />
{<br />
"index": "381091",<br />
"name": "Автомобили специальные",<br />
"frclass": 3,<br />
"guard": true,<br />
"danger": false<br />
}<br />
]<br />
}<br />
}<br />
]<br />
</source><br />
<br />
<b>Получить список грузов ГНГ и ЕТСНГ по коду ТН ВЭД 2710122100 и наименованию 'Уайт-Спирит':</b><br/><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=gng_by_tnved&tncode=2710122100&srchstr=%D0%A3%D0%B0%D0%B9%D1%82-%D0%A1%D0%BF%D0%B8%D1%80%D0%B8%D1%82&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
<br><br />
JSON-ответ включает в себя список подобранных грузов номенклатур ГНГ и ЕТСНГ.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"success": true,<br />
"tncode": "2710122100"<br />
},<br />
{<br />
"gng_node": {<br />
"index": "27210000",<br />
"name": "Уайт-спирит",<br />
"ett_class": "1",<br />
"etsng_list": [<br />
{<br />
"index": "211100",<br />
"name": "Бензин растворитель `Галоша`,`Уайт-спирит`",<br />
"frclass": 2,<br />
"guard": true,<br />
"danger": true<br />
}<br />
]<br />
}<br />
}<br />
]<br />
</source><br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|-<br />
|tncode||string||Код ТН ВЭД, по которому был выполнен подбор грузов<br />
<br />
|-<br />
|gng_node||array||Список грузов по номенклатуре ГНГ, соответствующих заданному коду ТН ВЭД<br />
<br />
|-<br />
|gng_node->index||string||Код ГНГ<br />
<br />
|-<br />
|gng_node->name||string||Наименование позиции ГНГ<br />
<br />
|-<br />
|gng_node->ettclass||string||Класс груза по классификации ЕТТ<br />
<br />
|-<br />
|etsng_list||array||Массив грузов ЕТСНГ, соответствующих подобранному коду ГНГ из gng_node<br />
<br />
|-<br />
|etsng_list->index||string||Код груза ЕТСНГ<br />
<br />
|-<br />
|etsng_list->name||string||Наименование груза ЕТСНГ<br />
<br />
|-<br />
|etsng_list->frclass||integer||Класс груза<br />
<br />
|-<br />
|etsng_list->guard||boolean||Необходима ли грузу охрана в пути следования<br />
<br />
|-<br />
|etsng_list->danger||boolean||Признак опасности груза. Поскольку однозначного соответствия номенклатуры ЕТСНГ и классификатора опасных грузов ООН не существует, то данный признак предоставляется справочно и может быть ошибочным.<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%B4%D0%BB%D1%8F_%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0_%D0%93%D0%9D%D0%93_%D0%B8_%D0%95%D0%A2%D0%A1%D0%9D%D0%93_%D0%BF%D0%BE_%D0%BA%D0%BE%D0%B4%D1%83_%D0%A2%D0%9D_%D0%92%D0%AD%D0%94&diff=1301API для получения кода ГНГ и ЕТСНГ по коду ТН ВЭД2022-12-27T08:58:59Z<p>Boluchevskikh: /* Пример получения списка грузов ГНГ/ЕТСНГ по коду ТН ВЭД */</p>
<hr />
<div>==О сервисе==<br />
API сервиса получения кодов ГНГ/ЕТСНГ по коду (и/или наименованию) ТН ВЭД позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно получить список кодов ГНГ/ЕТСНГ, наиболее подходящих заданному коду (наименованию) ТН ВЭД.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса - всегда '''gng_by_tnved'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("gng_by_tnved:sa000000:md5('alta_test')") = 6a962b91c37377a3be8f0c953aef0d3d<br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих кодов ТН ВЭД: <br><br />
8702109120 <br><br />
2710122100 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом элементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о подобранных кодах ГНГ и ЕТСНГ<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|}<br />
<br />
<br />
==Получение списка кодов номенклатур ГНГ и ЕТСНГ по коду ТН ВЭД==<br />
<br />
Необходимо выполнить запрос указанием GET-параметра tncode (см. примеры ниже).<br />
В случае отсутствия результата или его неудовлетворительности можно дополнительно указать наименование позиции ТН ВЭД (или часть наименования) в параметре srchstr (в urlencode). <br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например, 6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
|-<br />
|<b>tncode</b>||string||Код позиции ТН ВЭД. Например, 2710122100<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|srchstr||string||Наименование (часть наименования) позиции ТН ВЭД в urlencode. Например, urlencode('Уайт-Спирит').<br />
<br />
|}<br />
<br />
==Пример получения списка грузов ГНГ/ЕТСНГ по коду ТН ВЭД==<br />
<br />
<b>Получить список грузов ГНГ и ЕТСНГ по коду ТН ВЭД 8702109120:</b><br/><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=gng_by_tnved&tncode=8702109120&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
<br><br />
JSON-ответ включает в себя список подобранных грузов номенклатур ГНГ и ЕТСНГ.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"success": true,<br />
"tncode": "8702109120"<br />
},<br />
{<br />
"gng_node": {<br />
"index": "87021091",<br />
"name": "Средства моторные транспортные, предназначенные для перевозки 10 человек или более, включая водителя, с поршневым двигателем внутреннего сгорания с воспламенением от сжатия (дизелем или полудизелем, с рабочим объемом цилиндров двигателя не более 2500 куб.",<br />
"ett_class": "1",<br />
"etsng_list": [<br />
{<br />
"index": "381025",<br />
"name": "Автобусы",<br />
"frclass": 3,<br />
"guard": true,<br />
"danger": false<br />
},<br />
{<br />
"index": "381091",<br />
"name": "Автомобили специальные",<br />
"frclass": 3,<br />
"guard": true,<br />
"danger": false<br />
}<br />
]<br />
}<br />
}<br />
]<br />
</source><br />
<br />
<b>Получить список грузов ГНГ и ЕТСНГ по коду ТН ВЭД 2710122100 и наименованию 'Уайт-Спирит':</b><br/><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=gng_by_tnved&tncode=2710122100&srchstr=%D0%A3%D0%B0%D0%B9%D1%82-%D0%A1%D0%BF%D0%B8%D1%80%D0%B8%D1%82&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
<br><br />
JSON-ответ включает в себя список подобранных грузов номенклатур ГНГ и ЕТСНГ.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"success": true,<br />
"tncode": "2710122100"<br />
},<br />
{<br />
"gng_node": {<br />
"index": "27210000",<br />
"name": "Уайт-спирит",<br />
"ett_class": "1",<br />
"etsng_list": [<br />
{<br />
"index": "211100",<br />
"name": "Бензин растворитель `Галоша`,`Уайт-спирит`",<br />
"frclass": 2,<br />
"guard": true,<br />
"danger": true<br />
}<br />
]<br />
}<br />
}<br />
]<br />
</source></div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%B4%D0%BB%D1%8F_%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0_%D0%93%D0%9D%D0%93_%D0%B8_%D0%95%D0%A2%D0%A1%D0%9D%D0%93_%D0%BF%D0%BE_%D0%BA%D0%BE%D0%B4%D1%83_%D0%A2%D0%9D_%D0%92%D0%AD%D0%94&diff=1300API для получения кода ГНГ и ЕТСНГ по коду ТН ВЭД2022-12-27T08:58:06Z<p>Boluchevskikh: /* Пример получения списка грузов ГНГ/ЕТСНГ по коду ТН ВЭД */</p>
<hr />
<div>==О сервисе==<br />
API сервиса получения кодов ГНГ/ЕТСНГ по коду (и/или наименованию) ТН ВЭД позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно получить список кодов ГНГ/ЕТСНГ, наиболее подходящих заданному коду (наименованию) ТН ВЭД.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса - всегда '''gng_by_tnved'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("gng_by_tnved:sa000000:md5('alta_test')") = 6a962b91c37377a3be8f0c953aef0d3d<br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих кодов ТН ВЭД: <br><br />
8702109120 <br><br />
2710122100 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом элементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о подобранных кодах ГНГ и ЕТСНГ<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|}<br />
<br />
<br />
==Получение списка кодов номенклатур ГНГ и ЕТСНГ по коду ТН ВЭД==<br />
<br />
Необходимо выполнить запрос указанием GET-параметра tncode (см. примеры ниже).<br />
В случае отсутствия результата или его неудовлетворительности можно дополнительно указать наименование позиции ТН ВЭД (или часть наименования) в параметре srchstr (в urlencode). <br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например, 6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
|-<br />
|<b>tncode</b>||string||Код позиции ТН ВЭД. Например, 2710122100<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|srchstr||string||Наименование (часть наименования) позиции ТН ВЭД в urlencode. Например, urlencode('Уайт-Спирит').<br />
<br />
|}<br />
<br />
==Пример получения списка грузов ГНГ/ЕТСНГ по коду ТН ВЭД==<br />
<br />
<b>Получить список грузов ГНГ и ЕТСНГ по коду ТН ВЭД 8702109120:</b><br/><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=gng_by_tnved&tncode=8702109120&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
<br><br />
JSON-ответ включает в себя список подобранных грузов номенклатур ГНГ и ЕТСНГ.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"success": true,<br />
"tncode": "8702109120"<br />
},<br />
{<br />
"gng_node": {<br />
"index": "87021091",<br />
"name": "Средства моторные транспортные, предназначенные для перевозки 10 человек или более, включая водителя, с поршневым двигателем внутреннего сгорания с воспламенением от сжатия (дизелем или полудизелем, с рабочим объемом цилиндров двигателя не более 2500 куб.",<br />
"ett_class": "1",<br />
"etsng_list": [<br />
{<br />
"index": "381025",<br />
"name": "Автобусы",<br />
"frclass": 3,<br />
"guard": true,<br />
"danger": false<br />
},<br />
{<br />
"index": "381091",<br />
"name": "Автомобили специальные",<br />
"frclass": 3,<br />
"guard": true,<br />
"danger": false<br />
}<br />
]<br />
}<br />
}<br />
]<br />
</source><br />
<br />
<b>Получить список грузов ГНГ и ЕТСНГ по коду ТН ВЭД 2710122100 и наименованию 'Уайт-Спирит':</b><br/><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=gng_by_tnved&tncode=2710122100&srchstr=%D0%A3%D0%B0%D0%B9%D1%82-%D0%A1%D0%BF%D0%B8%D1%80%D0%B8%D1%82&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
<br><br />
JSON-ответ включает в себя список подобранных грузов номенклатур ГНГ и ЕТСНГ.<br />
<br />
[<br />
{<br />
"status": "ok",<br />
"success": true,<br />
"tncode": "2710122100"<br />
},<br />
{<br />
"gng_node": {<br />
"index": "27210000",<br />
"name": "Уайт-спирит",<br />
"ett_class": "1",<br />
"etsng_list": [<br />
{<br />
"index": "211100",<br />
"name": "Бензин растворитель `Галоша`,`Уайт-спирит`",<br />
"frclass": 2,<br />
"guard": true,<br />
"danger": true<br />
}<br />
]<br />
}<br />
}<br />
]</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%B4%D0%BB%D1%8F_%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0_%D0%93%D0%9D%D0%93_%D0%B8_%D0%95%D0%A2%D0%A1%D0%9D%D0%93_%D0%BF%D0%BE_%D0%BA%D0%BE%D0%B4%D1%83_%D0%A2%D0%9D_%D0%92%D0%AD%D0%94&diff=1299API для получения кода ГНГ и ЕТСНГ по коду ТН ВЭД2022-12-27T08:54:38Z<p>Boluchevskikh: /* Пример получения списка грузов ГНГ/ЕТСНГ по коду ТН ВЭД */</p>
<hr />
<div>==О сервисе==<br />
API сервиса получения кодов ГНГ/ЕТСНГ по коду (и/или наименованию) ТН ВЭД позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно получить список кодов ГНГ/ЕТСНГ, наиболее подходящих заданному коду (наименованию) ТН ВЭД.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса - всегда '''gng_by_tnved'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("gng_by_tnved:sa000000:md5('alta_test')") = 6a962b91c37377a3be8f0c953aef0d3d<br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих кодов ТН ВЭД: <br><br />
8702109120 <br><br />
2710122100 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом элементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о подобранных кодах ГНГ и ЕТСНГ<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|}<br />
<br />
<br />
==Получение списка кодов номенклатур ГНГ и ЕТСНГ по коду ТН ВЭД==<br />
<br />
Необходимо выполнить запрос указанием GET-параметра tncode (см. примеры ниже).<br />
В случае отсутствия результата или его неудовлетворительности можно дополнительно указать наименование позиции ТН ВЭД (или часть наименования) в параметре srchstr (в urlencode). <br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например, 6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
|-<br />
|<b>tncode</b>||string||Код позиции ТН ВЭД. Например, 2710122100<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|srchstr||string||Наименование (часть наименования) позиции ТН ВЭД в urlencode. Например, urlencode('Уайт-Спирит').<br />
<br />
|}<br />
<br />
==Пример получения списка грузов ГНГ/ЕТСНГ по коду ТН ВЭД==<br />
<br />
<b>Получить список грузов ГНГ и ЕТСНГ по коду ТН ВЭД 8702109120:</b><br/><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=gng_by_tnved&tncode=8702109120&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
<br><br />
JSON-ответ включает в себя список подобранных грузов номенклатур ГНГ и ЕТСНГ.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"success": true,<br />
"tncode": "8702109120"<br />
},<br />
{<br />
"gng_node": {<br />
"index": "87021091",<br />
"name": "Средства моторные транспортные, предназначенные для перевозки 10 человек или более, включая водителя, с поршневым двигателем внутреннего сгорания с воспламенением от сжатия (дизелем или полудизелем, с рабочим объемом цилиндров двигателя не более 2500 куб.",<br />
"ett_class": "1",<br />
"etsng_list": [<br />
{<br />
"index": "381025",<br />
"name": "Автобусы",<br />
"frclass": 3,<br />
"guard": true,<br />
"danger": false<br />
},<br />
{<br />
"index": "381091",<br />
"name": "Автомобили специальные",<br />
"frclass": 3,<br />
"guard": true,<br />
"danger": false<br />
}<br />
]<br />
}<br />
}<br />
]<br />
</source></div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%B4%D0%BB%D1%8F_%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0_%D0%93%D0%9D%D0%93_%D0%B8_%D0%95%D0%A2%D0%A1%D0%9D%D0%93_%D0%BF%D0%BE_%D0%BA%D0%BE%D0%B4%D1%83_%D0%A2%D0%9D_%D0%92%D0%AD%D0%94&diff=1298API для получения кода ГНГ и ЕТСНГ по коду ТН ВЭД2022-12-27T08:53:20Z<p>Boluchevskikh: /* Пример получения списка грузов ГНГ/ЕТСНГ по коду ТН ВЭД */</p>
<hr />
<div>==О сервисе==<br />
API сервиса получения кодов ГНГ/ЕТСНГ по коду (и/или наименованию) ТН ВЭД позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно получить список кодов ГНГ/ЕТСНГ, наиболее подходящих заданному коду (наименованию) ТН ВЭД.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса - всегда '''gng_by_tnved'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("gng_by_tnved:sa000000:md5('alta_test')") = 6a962b91c37377a3be8f0c953aef0d3d<br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих кодов ТН ВЭД: <br><br />
8702109120 <br><br />
2710122100 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом элементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о подобранных кодах ГНГ и ЕТСНГ<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|}<br />
<br />
<br />
==Получение списка кодов номенклатур ГНГ и ЕТСНГ по коду ТН ВЭД==<br />
<br />
Необходимо выполнить запрос указанием GET-параметра tncode (см. примеры ниже).<br />
В случае отсутствия результата или его неудовлетворительности можно дополнительно указать наименование позиции ТН ВЭД (или часть наименования) в параметре srchstr (в urlencode). <br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например, 6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
|-<br />
|<b>tncode</b>||string||Код позиции ТН ВЭД. Например, 2710122100<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|srchstr||string||Наименование (часть наименования) позиции ТН ВЭД в urlencode. Например, urlencode('Уайт-Спирит').<br />
<br />
|}<br />
<br />
==Пример получения списка грузов ГНГ/ЕТСНГ по коду ТН ВЭД==<br />
<br />
<b>Получить список грузов ГНГ и ЕТСНГ по коду ТН ВЭД 8702109120:</b><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=gng_by_tnved&tncode=8702109120&srchstr=%D0%A3%D0%B0%D0%B9%D1%82-%D0%A1%D0%BF%D0%B8%D1%80%D0%B8%D1%82&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
<br><br />
JSON-ответ включает в себя список подобранных грузов номенклатур ГНГ и ЕТСНГ.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"success": true,<br />
"tncode": "8702109120"<br />
},<br />
{<br />
"gng_node": {<br />
"index": "87021091",<br />
"name": "Средства моторные транспортные, предназначенные для перевозки 10 человек или более, включая водителя, с поршневым двигателем внутреннего сгорания с воспламенением от сжатия (дизелем или полудизелем, с рабочим объемом цилиндров двигателя не более 2500 куб.",<br />
"ett_class": "1",<br />
"etsng_list": [<br />
{<br />
"index": "381025",<br />
"name": "Автобусы",<br />
"frclass": 3,<br />
"guard": true,<br />
"danger": false<br />
},<br />
{<br />
"index": "381091",<br />
"name": "Автомобили специальные",<br />
"frclass": 3,<br />
"guard": true,<br />
"danger": false<br />
}<br />
]<br />
}<br />
}<br />
]<br />
</source></div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%B4%D0%BB%D1%8F_%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0_%D0%93%D0%9D%D0%93_%D0%B8_%D0%95%D0%A2%D0%A1%D0%9D%D0%93_%D0%BF%D0%BE_%D0%BA%D0%BE%D0%B4%D1%83_%D0%A2%D0%9D_%D0%92%D0%AD%D0%94&diff=1297API для получения кода ГНГ и ЕТСНГ по коду ТН ВЭД2022-12-27T08:48:10Z<p>Boluchevskikh: /* Получение списка кодов номенклатур ГНГ и ЕТСНГ по коду ТН ВЭД */</p>
<hr />
<div>==О сервисе==<br />
API сервиса получения кодов ГНГ/ЕТСНГ по коду (и/или наименованию) ТН ВЭД позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно получить список кодов ГНГ/ЕТСНГ, наиболее подходящих заданному коду (наименованию) ТН ВЭД.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса - всегда '''gng_by_tnved'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("gng_by_tnved:sa000000:md5('alta_test')") = 6a962b91c37377a3be8f0c953aef0d3d<br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих кодов ТН ВЭД: <br><br />
8702109120 <br><br />
2710122100 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом элементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о подобранных кодах ГНГ и ЕТСНГ<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|}<br />
<br />
<br />
==Получение списка кодов номенклатур ГНГ и ЕТСНГ по коду ТН ВЭД==<br />
<br />
Необходимо выполнить запрос указанием GET-параметра tncode (см. примеры ниже).<br />
В случае отсутствия результата или его неудовлетворительности можно дополнительно указать наименование позиции ТН ВЭД (или часть наименования) в параметре srchstr (в urlencode). <br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например, 6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
|-<br />
|<b>tncode</b>||string||Код позиции ТН ВЭД. Например, 2710122100<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|srchstr||string||Наименование (часть наименования) позиции ТН ВЭД в urlencode. Например, urlencode('Уайт-Спирит').<br />
<br />
|}<br />
<br />
==Пример получения списка грузов ГНГ/ЕТСНГ по коду ТН ВЭД==<br />
Контейнер AMFU8899067, получение инфорамции по будням дням (days=1,2,3,4,5) в 09:00 и 13:00 по московскому времени (times=09:00,13:00 и times_per_day=2), регион - только РФ (track_state=ru, state=20) без снятия со слежения по прибытии на станцию назначения (stop_station=no, т.е. ручное снятие), адреса для рассылки отчетов alta@alta.ru,mymail@mymail.com (emails=alta@alta.ru,mymail@mymail.com):<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&wagons=AMFU8899067&state=20&track_type=2&comment=%D0%BF%D0%B5%D1%80%D0%B2%D0%BE%D0%B5+%D1%81%D0%BB%D0%B5%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5+%28%D0%BA%D0%BE%D0%BD%D1%82%29&days=1,2,3,4,5&times_per_day=2&times=09:00,13:00&track_state=ru&stop_station=no&emails=alta@alta.ru,mymail@mymail.com<br />
<br><br />
JSON-ответ включает в себя отчет о состоянии запроса на слежение (поставлен/не поставлен на слежение) и hash, по которому можно получить ответ.<br><br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"cont_hash": "931700e35d7ff88a10bd5d680da50f02"<br />
}<br />
]<br />
</source><br />
<br />
При постановке вагона на слежение получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c"<br />
}<br />
]<br />
</source></div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%B4%D0%BB%D1%8F_%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0_%D0%93%D0%9D%D0%93_%D0%B8_%D0%95%D0%A2%D0%A1%D0%9D%D0%93_%D0%BF%D0%BE_%D0%BA%D0%BE%D0%B4%D1%83_%D0%A2%D0%9D_%D0%92%D0%AD%D0%94&diff=1296API для получения кода ГНГ и ЕТСНГ по коду ТН ВЭД2022-12-27T08:47:28Z<p>Boluchevskikh: /* Получение списка кодов номенклатур ГНГ и ЕТСНГ по коду ТН ВЭД */</p>
<hr />
<div>==О сервисе==<br />
API сервиса получения кодов ГНГ/ЕТСНГ по коду (и/или наименованию) ТН ВЭД позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно получить список кодов ГНГ/ЕТСНГ, наиболее подходящих заданному коду (наименованию) ТН ВЭД.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса - всегда '''gng_by_tnved'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("gng_by_tnved:sa000000:md5('alta_test')") = 6a962b91c37377a3be8f0c953aef0d3d<br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих кодов ТН ВЭД: <br><br />
8702109120 <br><br />
2710122100 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом элементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о подобранных кодах ГНГ и ЕТСНГ<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|}<br />
<br />
<br />
==Получение списка кодов номенклатур ГНГ и ЕТСНГ по коду ТН ВЭД==<br />
<br />
Необходимо выполнить запрос указанием GET-параметра tncode (см. примеры ниже).<br />
В случае отсутствия результата или его неудовлетворительности можно дополнительно указать наименование позиции ТН ВЭД (или часть наименования) в параметре srchstr (в urlencode). <br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например, 6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
|-<br />
|<b>tncode</b>||string||Код позиции ТН ВЭД. Например, 2710122100<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|srchstr||string||Наименование (часть наименования) позиции ТН ВЭД. Например, 'Уайт-Спирит'.<br />
<br />
|}<br />
<br />
==Пример получения списка грузов ГНГ/ЕТСНГ по коду ТН ВЭД==<br />
Контейнер AMFU8899067, получение инфорамции по будням дням (days=1,2,3,4,5) в 09:00 и 13:00 по московскому времени (times=09:00,13:00 и times_per_day=2), регион - только РФ (track_state=ru, state=20) без снятия со слежения по прибытии на станцию назначения (stop_station=no, т.е. ручное снятие), адреса для рассылки отчетов alta@alta.ru,mymail@mymail.com (emails=alta@alta.ru,mymail@mymail.com):<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&wagons=AMFU8899067&state=20&track_type=2&comment=%D0%BF%D0%B5%D1%80%D0%B2%D0%BE%D0%B5+%D1%81%D0%BB%D0%B5%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5+%28%D0%BA%D0%BE%D0%BD%D1%82%29&days=1,2,3,4,5&times_per_day=2&times=09:00,13:00&track_state=ru&stop_station=no&emails=alta@alta.ru,mymail@mymail.com<br />
<br><br />
JSON-ответ включает в себя отчет о состоянии запроса на слежение (поставлен/не поставлен на слежение) и hash, по которому можно получить ответ.<br><br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"cont_hash": "931700e35d7ff88a10bd5d680da50f02"<br />
}<br />
]<br />
</source><br />
<br />
При постановке вагона на слежение получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c"<br />
}<br />
]<br />
</source></div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%B4%D0%BB%D1%8F_%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0_%D0%93%D0%9D%D0%93_%D0%B8_%D0%95%D0%A2%D0%A1%D0%9D%D0%93_%D0%BF%D0%BE_%D0%BA%D0%BE%D0%B4%D1%83_%D0%A2%D0%9D_%D0%92%D0%AD%D0%94&diff=1295API для получения кода ГНГ и ЕТСНГ по коду ТН ВЭД2022-12-27T08:46:40Z<p>Boluchevskikh: /* Получение списка кодов номенклатур ГНГ и ЕТСНГ по коду ТН ВЭД */</p>
<hr />
<div>==О сервисе==<br />
API сервиса получения кодов ГНГ/ЕТСНГ по коду (и/или наименованию) ТН ВЭД позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно получить список кодов ГНГ/ЕТСНГ, наиболее подходящих заданному коду (наименованию) ТН ВЭД.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса - всегда '''gng_by_tnved'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("gng_by_tnved:sa000000:md5('alta_test')") = 6a962b91c37377a3be8f0c953aef0d3d<br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих кодов ТН ВЭД: <br><br />
8702109120 <br><br />
2710122100 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом элементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о подобранных кодах ГНГ и ЕТСНГ<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|}<br />
<br />
<br />
==Получение списка кодов номенклатур ГНГ и ЕТСНГ по коду ТН ВЭД==<br />
<br />
Необходимо выполнить запрос указанием GET-параметра tncode (см. примеры ниже).<br />
В случае отсутствия результата или его неудовлетворительности можно дополнительно указать наименование позиции ТН ВЭД (или часть наименования) в параметре srchstr (в urlencode). <br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например, 6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
|-<br />
|<b>tncode</b>||string||Код позиции ТН ВЭД. Например, 2710122100<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|srchstr||string||Наименование (часть наименования) позиции ТН ВЭД. Например, 'Уайт-Спирит'.<br />
<br />
<br />
|}<br />
<br />
==Пример получения списка грузов ГНГ/ЕТСНГ по коду ТН ВЭД==<br />
Контейнер AMFU8899067, получение инфорамции по будням дням (days=1,2,3,4,5) в 09:00 и 13:00 по московскому времени (times=09:00,13:00 и times_per_day=2), регион - только РФ (track_state=ru, state=20) без снятия со слежения по прибытии на станцию назначения (stop_station=no, т.е. ручное снятие), адреса для рассылки отчетов alta@alta.ru,mymail@mymail.com (emails=alta@alta.ru,mymail@mymail.com):<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&wagons=AMFU8899067&state=20&track_type=2&comment=%D0%BF%D0%B5%D1%80%D0%B2%D0%BE%D0%B5+%D1%81%D0%BB%D0%B5%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5+%28%D0%BA%D0%BE%D0%BD%D1%82%29&days=1,2,3,4,5&times_per_day=2&times=09:00,13:00&track_state=ru&stop_station=no&emails=alta@alta.ru,mymail@mymail.com<br />
<br><br />
JSON-ответ включает в себя отчет о состоянии запроса на слежение (поставлен/не поставлен на слежение) и hash, по которому можно получить ответ.<br><br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"cont_hash": "931700e35d7ff88a10bd5d680da50f02"<br />
}<br />
]<br />
</source><br />
<br />
При постановке вагона на слежение получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c"<br />
}<br />
]<br />
</source></div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%B4%D0%BB%D1%8F_%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0_%D0%93%D0%9D%D0%93_%D0%B8_%D0%95%D0%A2%D0%A1%D0%9D%D0%93_%D0%BF%D0%BE_%D0%BA%D0%BE%D0%B4%D1%83_%D0%A2%D0%9D_%D0%92%D0%AD%D0%94&diff=1294API для получения кода ГНГ и ЕТСНГ по коду ТН ВЭД2022-12-27T08:46:02Z<p>Boluchevskikh: </p>
<hr />
<div>==О сервисе==<br />
API сервиса получения кодов ГНГ/ЕТСНГ по коду (и/или наименованию) ТН ВЭД позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно получить список кодов ГНГ/ЕТСНГ, наиболее подходящих заданному коду (наименованию) ТН ВЭД.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса - всегда '''gng_by_tnved'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("gng_by_tnved:sa000000:md5('alta_test')") = 6a962b91c37377a3be8f0c953aef0d3d<br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих кодов ТН ВЭД: <br><br />
8702109120 <br><br />
2710122100 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом элементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о подобранных кодах ГНГ и ЕТСНГ<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|}<br />
<br />
<br />
==Получение списка кодов номенклатур ГНГ и ЕТСНГ по коду ТН ВЭД==<br />
<br />
Необходимо выполнить запрос указанием GET-параметра tncode (см. примеры ниже).<br />
В случае отсутствия результата или его неудовлетворительности можно дополнительно указать наименование позиции ТН ВЭД (или часть наименования) в параметре srchstr (в urlencode). <br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например, 6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
<br />
|<b>tncode</b>||string||Код позиции ТН ВЭД. Например, 2710122100<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|srchstr||string||Наименование (часть наименования) позиции ТН ВЭД. Например, 'Уайт-Спирит'.<br />
<br />
<br />
|}<br />
<br />
==Пример получения списка грузов ГНГ/ЕТСНГ по коду ТН ВЭД==<br />
Контейнер AMFU8899067, получение инфорамции по будням дням (days=1,2,3,4,5) в 09:00 и 13:00 по московскому времени (times=09:00,13:00 и times_per_day=2), регион - только РФ (track_state=ru, state=20) без снятия со слежения по прибытии на станцию назначения (stop_station=no, т.е. ручное снятие), адреса для рассылки отчетов alta@alta.ru,mymail@mymail.com (emails=alta@alta.ru,mymail@mymail.com):<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&wagons=AMFU8899067&state=20&track_type=2&comment=%D0%BF%D0%B5%D1%80%D0%B2%D0%BE%D0%B5+%D1%81%D0%BB%D0%B5%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5+%28%D0%BA%D0%BE%D0%BD%D1%82%29&days=1,2,3,4,5&times_per_day=2&times=09:00,13:00&track_state=ru&stop_station=no&emails=alta@alta.ru,mymail@mymail.com<br />
<br><br />
JSON-ответ включает в себя отчет о состоянии запроса на слежение (поставлен/не поставлен на слежение) и hash, по которому можно получить ответ.<br><br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"cont_hash": "931700e35d7ff88a10bd5d680da50f02"<br />
}<br />
]<br />
</source><br />
<br />
При постановке вагона на слежение получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c"<br />
}<br />
]<br />
</source></div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%B4%D0%BB%D1%8F_%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0_%D0%93%D0%9D%D0%93_%D0%B8_%D0%95%D0%A2%D0%A1%D0%9D%D0%93_%D0%BF%D0%BE_%D0%BA%D0%BE%D0%B4%D1%83_%D0%A2%D0%9D_%D0%92%D0%AD%D0%94&diff=1293API для получения кода ГНГ и ЕТСНГ по коду ТН ВЭД2022-12-27T08:34:26Z<p>Boluchevskikh: /* Структура ответа и статус запроса */</p>
<hr />
<div>==О сервисе==<br />
API сервиса получения кодов ГНГ/ЕТСНГ по коду (и/или наименованию) ТН ВЭД позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно получить список кодов ГНГ/ЕТСНГ, наиболее подходящих заданному коду (наименованию) ТН ВЭД.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса - всегда '''gng_by_tnved'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("gng_by_tnved:sa000000:md5('alta_test')") = 6a962b91c37377a3be8f0c953aef0d3d<br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих кодов ТН ВЭД: <br><br />
8702109120 <br><br />
2710122100 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом элементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о подобранных кодах ГНГ и ЕТСНГ<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%B4%D0%BB%D1%8F_%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0_%D0%93%D0%9D%D0%93_%D0%B8_%D0%95%D0%A2%D0%A1%D0%9D%D0%93_%D0%BF%D0%BE_%D0%BA%D0%BE%D0%B4%D1%83_%D0%A2%D0%9D_%D0%92%D0%AD%D0%94&diff=1292API для получения кода ГНГ и ЕТСНГ по коду ТН ВЭД2022-12-27T08:31:35Z<p>Boluchevskikh: /* Структура ответа и статус запроса */</p>
<hr />
<div>==О сервисе==<br />
API сервиса получения кодов ГНГ/ЕТСНГ по коду (и/или наименованию) ТН ВЭД позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно получить список кодов ГНГ/ЕТСНГ, наиболее подходящих заданному коду (наименованию) ТН ВЭД.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса - всегда '''gng_by_tnved'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("gng_by_tnved:sa000000:md5('alta_test')") = 6a962b91c37377a3be8f0c953aef0d3d<br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих кодов ТН ВЭД: <br><br />
8702109120 <br><br />
2710122100 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом элементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о подобранных кодах ГНГ и ЕТСНГ<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%B4%D0%BB%D1%8F_%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0_%D0%93%D0%9D%D0%93_%D0%B8_%D0%95%D0%A2%D0%A1%D0%9D%D0%93_%D0%BF%D0%BE_%D0%BA%D0%BE%D0%B4%D1%83_%D0%A2%D0%9D_%D0%92%D0%AD%D0%94&diff=1291API для получения кода ГНГ и ЕТСНГ по коду ТН ВЭД2022-12-27T08:30:10Z<p>Boluchevskikh: /* Тестирование JSON-API */</p>
<hr />
<div>==О сервисе==<br />
API сервиса получения кодов ГНГ/ЕТСНГ по коду (и/или наименованию) ТН ВЭД позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно получить список кодов ГНГ/ЕТСНГ, наиболее подходящих заданному коду (наименованию) ТН ВЭД.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса - всегда '''gng_by_tnved'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("gng_by_tnved:sa000000:md5('alta_test')") = 6a962b91c37377a3be8f0c953aef0d3d<br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих кодов ТН ВЭД: <br><br />
8702109120 <br><br />
2710122100 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом эелементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о дислокации, список вагонов и проч.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%B4%D0%BB%D1%8F_%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0_%D0%93%D0%9D%D0%93_%D0%B8_%D0%95%D0%A2%D0%A1%D0%9D%D0%93_%D0%BF%D0%BE_%D0%BA%D0%BE%D0%B4%D1%83_%D0%A2%D0%9D_%D0%92%D0%AD%D0%94&diff=1290API для получения кода ГНГ и ЕТСНГ по коду ТН ВЭД2022-12-27T08:28:12Z<p>Boluchevskikh: /* API. Авторизация. Метод "test_secret". */</p>
<hr />
<div>==О сервисе==<br />
API сервиса получения кодов ГНГ/ЕТСНГ по коду (и/или наименованию) ТН ВЭД позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно получить список кодов ГНГ/ЕТСНГ, наиболее подходящих заданному коду (наименованию) ТН ВЭД.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса - всегда '''gng_by_tnved'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("gng_by_tnved:sa000000:md5('alta_test')") = 6a962b91c37377a3be8f0c953aef0d3d<br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=6a962b91c37377a3be8f0c953aef0d3d<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих номеров: <br><br />
вагоны - 54676515 <br><br />
контейнеры - AMFU8899067 <br><br />
<br />
Hash для получения ответов по вагонам:<br />
- слежение ebc356dfa5beee7d3844ccacf535410c <br><br />
Cont_hash для получения ответов по контейнерам:<br />
- слежение 931700e35d7ff88a10bd5d680da50f02 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом эелементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о дислокации, список вагонов и проч.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%B4%D0%BB%D1%8F_%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0_%D0%93%D0%9D%D0%93_%D0%B8_%D0%95%D0%A2%D0%A1%D0%9D%D0%93_%D0%BF%D0%BE_%D0%BA%D0%BE%D0%B4%D1%83_%D0%A2%D0%9D_%D0%92%D0%AD%D0%94&diff=1289API для получения кода ГНГ и ЕТСНГ по коду ТН ВЭД2022-12-27T08:14:58Z<p>Boluchevskikh: </p>
<hr />
<div>==О сервисе==<br />
API сервиса получения кодов ГНГ/ЕТСНГ по коду (и/или наименованию) ТН ВЭД позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно получить список кодов ГНГ/ЕТСНГ, наиболее подходящих заданному коду (наименованию) ТН ВЭД.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса - всегда '''gng_by_tnvd'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5('alta_test')") = bb92dcee8bf2b49287e1038b65a72b79 <br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих номеров: <br><br />
вагоны - 54676515 <br><br />
контейнеры - AMFU8899067 <br><br />
<br />
Hash для получения ответов по вагонам:<br />
- слежение ebc356dfa5beee7d3844ccacf535410c <br><br />
Cont_hash для получения ответов по контейнерам:<br />
- слежение 931700e35d7ff88a10bd5d680da50f02 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом эелементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о дислокации, список вагонов и проч.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%B4%D0%BB%D1%8F_%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F_%D0%BA%D0%BE%D0%B4%D0%B0_%D0%93%D0%9D%D0%93_%D0%B8_%D0%95%D0%A2%D0%A1%D0%9D%D0%93_%D0%BF%D0%BE_%D0%BA%D0%BE%D0%B4%D1%83_%D0%A2%D0%9D_%D0%92%D0%AD%D0%94&diff=1288API для получения кода ГНГ и ЕТСНГ по коду ТН ВЭД2022-12-27T08:11:37Z<p>Boluchevskikh: Новая страница: «==О сервисе== JSON-API сервиса «Поиск вагонов» позволяет интегрировать возможности сервиса в…»</p>
<hr />
<div>==О сервисе==<br />
JSON-API сервиса «Поиск вагонов» позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно ставить и снимать вагоны и контейнеры на слежение по СНГ, странам Балтии, Монголии и Китаю.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET или POST. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса для поиска вагонов - всегда '''rail_tracking'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5('alta_test')") = bb92dcee8bf2b49287e1038b65a72b79 <br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих номеров: <br><br />
вагоны - 54676515 <br><br />
контейнеры - AMFU8899067 <br><br />
<br />
Hash для получения ответов по вагонам:<br />
- слежение ebc356dfa5beee7d3844ccacf535410c <br><br />
Cont_hash для получения ответов по контейнерам:<br />
- слежение 931700e35d7ff88a10bd5d680da50f02 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом эелементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о дислокации, список вагонов и проч.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1285JSON-API сервиса поиска вагонов2022-10-31T08:05:59Z<p>Boluchevskikh: </p>
<hr />
<div>==О сервисе==<br />
JSON-API сервиса «Поиск вагонов» позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно ставить и снимать вагоны и контейнеры на слежение по СНГ, странам Балтии, Монголии и Китаю.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET или POST. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса для поиска вагонов - всегда '''rail_tracking'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5('alta_test')") = bb92dcee8bf2b49287e1038b65a72b79 <br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих номеров: <br><br />
вагоны - 54676515 <br><br />
контейнеры - AMFU8899067 <br><br />
<br />
Hash для получения ответов по вагонам:<br />
- слежение ebc356dfa5beee7d3844ccacf535410c <br><br />
Cont_hash для получения ответов по контейнерам:<br />
- слежение 931700e35d7ff88a10bd5d680da50f02 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом эелементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о дислокации, список вагонов и проч.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}<br />
<br />
==Постановка вагонов/контейнеров на слежение. Метод "add".==<br />
Постановка на слежение выполняется с помощью метода "add". <br><br />
<br />
Обращаем внимание, что в связи с особенностями работы системы слежения получение первого отчета с актуальными данными возможно не ранее 3-6 часов с момента постановкии на слежение (иногда до 12).<br />
В противном случае могут прийти устаревшие данные (или не прийти вовсе). Особенно это характерно для контейнеров<br />
Например:<br />
На слежение был поставлен контейнер в начале рабочего дня в 09:00. Время обновления данных: 09:30, 14:30 и 17:30.<br />
В 09:30 этого же дня с высокой долей вероятности будут получены неактуальные (устаревшие) данные или данных не будет. В 14:30 и 17:30 будут получены уже актуализированные отчеты.<br />
Все последующие сутки актуальные отчеты будут приходить в любое из указанного в расписании время, т.е. и в 09:30 следующих суток уже придут свежие данные. <br/><br />
<br />
Существует несколько регионов слежения: РФ, СНГ и Балтия, СНГ и Балтия + Китай + Монголия. Ниже описаны основные особенности:<br><br />
- При слежении первый ответ (обновление) может формироваться довольно продолжительное время: от 3 часов по РФ до суток по странам Средней Азии и Китаю. <br />
- В течение суток можно получить до 3-х обновлений дислокации за одну цену.<br />
- Стоимость слежения по РФ значительно ниже слежения по другим регионам. Однако, в случае пересечения перевозочного средства границы нет никаких гарантий, что свежая информация продолжит поступать.<br />
- Слежение по СНГ и Балтии, Китаю и Монголии позволяет получать дислокацию по всем перечисленным регионам, независимо от того, где находится ПС<br />
- При постановке ПС на слежение задается регламент получения отчетов - в какой день недели и какое время удобно получать свежую информацию, а также способ снятия со слежения (ручной или автоматический)<br />
- Существуют 2 типа слежения: посуточное и рейс. Единственное отличие между ними - в способе тарификации. Посуточное слежение - это такой тип слежения, когда денежные средства списываются со счета клиента при очередном формировании отчета (т.е. первом отчете за сутки согласно расписанию). Рейс тарифицируется сразу за весь маршрут при постановке на слежение и нет необходимости следить за состоянием баланса.<br />
- Для слежения информация по hash будет постоянно обновляться до окончания слежения. <br />
Ниже приводится полный список входных параметров. Жирным шрифтом отмечены те из них, значению которых следует уделить внимание при постановке на слежение:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||add - добавление запроса на слежение<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067"<br />
<br />
|-<br />
|<b>state</b>||string||Код страны, по которой осуществляется запрос. Для РФ, СНГ, Балтии, Монголии, Китая - 20. <br />
<br />
|-<br />
|<b>track_state</b>||string||Регион слежения. ru - Россия, СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|<b>track_type</b>||int||Тип слежения. Для посуточного слежения запроса track_type=2, для рейса - track_type=3<br />
<br />
|-<br />
|<b>stop_station</b>||string||Снимать ли со слежения по прибытию на станцию назначения. "yes" - снимать, "no" - не снимать. Если указать <код ЕСР> - снимать по прибытию на станцию с кодом <код ЕСР>. Код ЕСР - 5-и значный код станции согласно Единой Сетевой Разметке (ЕСР). <br />
<br />
|-<br />
|<b>times</b>||string||Время обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Формат: "H:i", через запятую. Например: "09:00,13:00,18:00". Время московское. <br />
<br />
|-<br />
|<b>times_per_day</b>||string||Количество обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Если указано, что times меньше times_per_day, то times имеет больший приоритет. Например, times_per_day="2", a times="09:00,13:00,18:00", то отчет будет сформирован только в первое время и второе время, т.е. в 09:00 и в 13:00.<br />
<br />
|-<br />
|<b>days</b>||string||Дни недели, по которым необходимо получать отчет, через запятую. Номера начинаются с нуля (Воскресенье) до 6 (Суббота). Например, если отчеты необходимы по будням, то days="1,2,3,4,5". <br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу в urlencode<br />
<br />
|-<br />
|emails||string||Список email-адресов, куда отправить отчет о дислокации после выполнения, через запятую.<br />
<br />
|-<br />
|email_report_type||int||Всегда 2<br />
<br />
|-<br />
|attach_excel||int||Вкладывать ли в письма копию отчета в Excel. 1 - вкладывать, 0 - не вкладывать. По умолчанию 0.<br />
<br />
|}<br />
<br />
==Пример постановки на слежение==<br />
Контейнер AMFU8899067, получение инфорамции по будням дням (days=1,2,3,4,5) в 09:00 и 13:00 по московскому времени (times=09:00,13:00 и times_per_day=2), регион - только РФ (track_state=ru, state=20) без снятия со слежения по прибытии на станцию назначения (stop_station=no, т.е. ручное снятие), адреса для рассылки отчетов alta@alta.ru,mymail@mymail.com (emails=alta@alta.ru,mymail@mymail.com):<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&wagons=AMFU8899067&state=20&track_type=2&comment=%D0%BF%D0%B5%D1%80%D0%B2%D0%BE%D0%B5+%D1%81%D0%BB%D0%B5%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5+%28%D0%BA%D0%BE%D0%BD%D1%82%29&days=1,2,3,4,5&times_per_day=2&times=09:00,13:00&track_state=ru&stop_station=no&emails=alta@alta.ru,mymail@mymail.com<br />
<br><br />
JSON-ответ включает в себя отчет о состоянии запроса на слежение (поставлен/не поставлен на слежение) и hash, по которому можно получить ответ.<br><br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"cont_hash": "931700e35d7ff88a10bd5d680da50f02"<br />
}<br />
]<br />
</source><br />
<br />
При постановке вагона на слежение получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c"<br />
}<br />
]<br />
</source><br />
<br />
Поля hash и cont_hash можно использовать для получения <b>текущей</b> дислокации (согласно расписанию).<br />
<br />
==Получение ответа на ПС, стоящих на слежении. Метод "show". ==<br />
После размещения запроса он встает в очередь на обработку. В обозначенный момент времени (по расписанию) запрос выполняется. Обычно обработка запроса на слежение занимает около 1 минуты. В случае повышенной нагрузки на сервер обработка может занимать до 5 минут и более. <br><br />
Оптимальный период опроса сервера - 1 минута. В случае частых запросов ООО "Альта-Софт" оставляет за собой право заблокировать такие запросы и отказать в обслуживании. <br><br />
Для получение последней дислокации необходимо вызвать метод "show". <br><br><br />
Например, для получения дислокации контейнера AMFU8899067: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=show&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
JSON-ответ включает в себя отчет о состоянии запроса (в очереди/обрабатывается/обработан) в первом элементе массива, в последующих элементах - отчет о дислокации перевозочных средств.<br />
Например, на запрос AMFU8899067 получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Обработан",<br />
"query_status": "4",<br />
"hash": "fece39d1523836d03c3c2da73a6f1275",<br />
"type": "2",<br />
"count": 1<br />
},<br />
{<br />
"num": "AMFU8899067",<br />
"on_track": 0,<br />
"station": "24160",<br />
"station_name": "Вековка",<br />
"state": "20",<br />
"state_name": "Россия",<br />
"lon": "40.764762",<br />
"lat": "55.498762",<br />
"road_name": "Горьковская",<br />
"op_date": "2017-12-05 20:03:00",<br />
"departure_date": "2017-12-03 14:06:00",<br />
"route_start_date": "",<br />
"delivery_date": "2017-12-15 00:00:00",<br />
"etd_date": "2017-12-20:00:00",<br />
"operation": "ПРИБЫТИЕ С ПОЕЗДОМ НА СТАНЦИЮ",<br />
"nakl_nom": "",<br />
"okpo": "94421386",<br />
"owner": null,<br />
"kgro": "1386",<br />
"kgrp": "7575",<br />
"train_index": "18290-853-98130",<br />
"train_number": "1282",<br />
"fraight": "51403",<br />
"fraight_name": "Изделия кондитерские сахаристые, н.п.",<br />
"weight": "13000",<br />
"wagon_number": "94785045",<br />
"station_from": "18290",<br />
"is_loaded": 1,<br />
"hash": "ea7a000c4649388f68af14051f0827a04f11a2ee",<br />
"station_to": "98130",<br />
"station_from_name": "Тучково",<br />
"station_to_name": "Первая Речка",<br />
"route": "8928"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|-<br />
|type||string||Тип запроса. 1- вагоны, 2 - контейнеры<br />
<br />
|-<br />
|query_status||string||Состояние запроса. 1 - в очереди, 2 - обрабатывается, 3 или 4 - обработан<br />
<br />
|-<br />
|count||int||Количество перевозочных средств в отчете<br />
<br />
|-<br />
|hash||string||Хэш запроса.<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы''' (при query_status больше 2)<br />
<br />
|-<br />
|num||string||Номер перевозочного средства<br />
<br />
|-<br />
|station||string||Код станции, где была зафиксирована последняя операция с перевозочным средством. 5 символов(или 6 символов, 6-й - контрольный знак). В случае отсутствия данных по дислокации ПС значение будет "no_data".<br />
|-<br />
|station_name||string||Название станции, где была зафиксирована последняя операция с перевозочным средством. <br />
<br />
|-<br />
|op_date||string||Дата фиксирования последней операции. В формате "Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|operation||string||Наименование последней операции<br />
<br />
|-<br />
|route||string||Оставшееся до станции назначения расстояние, км<br />
<br />
|-<br />
|on_track||int||Стоит ли перевозочное средство на слежении. 1 - стоит, 0 - снят или оперативный запрос<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|state||string||Код государства станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|state_name||string||Название государства станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|lon||string||Долгота станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|lat||string||Широта станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|road_name||string||Дорога, где была зафиксирована последняя операция<br />
<br />
|-<br />
|departure_date||string||Дата отправки. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|route_start_date||string||Дата начала рейса. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|delivery_date||string||Ожидаемая дата прибытия на ст. назначения. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|etd_date||string||Ожидаемая дата доставки контейнера грузополучателю после раскредитовки. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|nakl_nom||string||Номер накладной<br />
<br />
|-<br />
|okpo||string||ОКПО отправителя<br />
<br />
|-<br />
|owner||string||Собственник перевозочного средства<br />
<br />
|-<br />
|kgro||string||Номер грузоотправителя<br />
|-<br />
<br />
|kgrp||string||Номер грузополучателя<br />
|-<br />
<br />
|train_index||string||Индекс поезда<br />
|-<br />
<br />
|train_number||string||Номер поезда<br />
|-<br />
<br />
|fraight||string||Код груза по номенклатуре ЕТСНГ<br />
|-<br />
<br />
|fraight_name||string||Наименование груза<br />
|-<br />
<br />
|weight||string||Вес груза (чаще всего в килограммах, но может быть в центнерах или тоннах)<br />
|-<br />
<br />
|wagon_number||string||Номер вагона (платформы), на котором закреплен контейнер (только для контейнерных запросов)<br />
|-<br />
<br />
|station_from||string||Код станции отправления<br />
|-<br />
<br />
|station_from_name||string||Название станции отправления<br />
|-<br />
<br />
|station_to||string||Код станции назначения<br />
|-<br />
<br />
|station_to_name||string||Название станции назначения<br />
|-<br />
<br />
|is_loaded||int||1 - груженый, 0 - порожний<br />
|-<br />
<br />
|}<br />
<br />
<br />
==Снятие со слежения. Метод cancel_track.==<br />
<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||cancel_track - снятие со слежения запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например, ebc356dfa5beee7d3844ccacf535410c<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. В случае указания списка со слежения будут сняты только те ПС, которые в нем указаны, а не весь запрос. Например, "54676515"<br />
<br />
|}<br />
<br />
== Пример снятия со слежения==<br />
Снять со слежения вагон 54676515 из запроса с hash ebc356dfa5beee7d3844ccacf535410c<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=ebc356dfa5beee7d3844ccacf535410c&wagons=54676515<br />
<br />
Снять со слежения '''весь''' (т.е. все перевозочные средства из запроса) запрос с hash 931700e35d7ff88a10bd5d680da50f02<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Обратите внимание, что для тестовых данных ответ на запрос снятия со слежения будет "успешно", однако фактически запросы останутся на слежении.<br />
<br />
== Получение списка запросов на слежении. Метод "track_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||track_list - список запросов, стоящих на слежении<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=track_list&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"name": "первое слежение",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c",<br />
"modify_date": "29.07.2021 21:52",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
},<br />
{<br />
"name": "первое слежение (конт)",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "931700e35d7ff88a10bd5d680da50f02",<br />
"modify_date": "03.08.2021 13:10",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу<br />
<br />
|-<br />
|vagon_count||string||Количество ПС в запросе<br />
<br />
|-<br />
|email||string||Адреса электронной почты для рассылки отчетов о дислокации, через запятую.<br />
<br />
|-<br />
|hash||string||Hash запроса.<br />
<br />
|-<br />
|modify_date||string||Дата последнего изменения/выполнения запроса.<br />
<br />
|-<br />
|on_track||string||Стоит ли запрос на слежении. 1 - стоит, 0 - снят.<br />
<br />
|-<br />
|track_type||string||Тип слежения. 1 - постоянное, 2 - рейс. Обратите внимание, нумерация в данном случае отличае от таковой при постановке на слежение./<br />
<br />
|-<br />
|track_state||string||Регион слежения. ru - только РФ, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|state||string||Государство слежения. 20 - РФ, 22 - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|status||int||Статус обработки запроса. 1 - в очереди на обработку, 2 - обрабатывается, 3,4 - обработан<br />
<br />
|}<br />
<br />
== Получение списка ПС в запросе. Метод "carr_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||carr_list - список номеров перевозочных средств в запросе<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например 931700e35d7ff88a10bd5d680da50f02<br />
<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=carr_list&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"group_id": 1519743,<br />
"carrs": [<br />
"AMFU8899067"<br />
]<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|carrs||string||Массив номеров перевозочных средств в запросе<br />
<br />
|}<br />
<br />
== Получение баланса. Метод "balance"==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||balance - остаток денежных средств или бонусов на счету <br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=balance&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
Json-ответ<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Ваш баланс: 0.00 руб. / Бонусы 0",<br />
"balans": "0.00",<br />
"bonus": 0,<br />
"sa": "sa000000"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Остаток денежных средств/бонусов в текстовом виде<br />
<br />
|-<br />
|balans||string||Остаток денежных средств в рублях<br />
<br />
|-<br />
|bonus||string||Остаток бонусов<br />
<br />
|-<br />
|sa||string||Номер договора (сервис-аккаунта)<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1230JSON-API сервиса поиска вагонов2022-07-01T16:00:24Z<p>Boluchevskikh: </p>
<hr />
<div>==О сервисе==<br />
JSON-API сервиса «Поиск вагонов» позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно ставить и снимать вагоны и контейнеры на слежение по СНГ, странам Балтии, Монголии и Китаю.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET или POST. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса для поиска вагонов - всегда '''rail_tracking'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5('alta_test')") = bb92dcee8bf2b49287e1038b65a72b79 <br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих номеров: <br><br />
вагоны - 54676515 <br><br />
контейнеры - AMFU8899067 <br><br />
<br />
Hash для получения ответов по вагонам:<br />
- слежение ebc356dfa5beee7d3844ccacf535410c <br><br />
Cont_hash для получения ответов по контейнерам:<br />
- слежение 931700e35d7ff88a10bd5d680da50f02 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом эелементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о дислокации, список вагонов и проч.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}<br />
<br />
==Постановка вагонов/контейнеров на слежение. Метод "add".==<br />
Постановка на слежение выполняется с помощью метода "add". <br><br />
<br />
Обращаем внимание, что в связи с особенностями работы системы слежения получение первого отчета с актуальными данными возможно не ранее 2-3 часов с момента постановкии на слежение.<br />
В противном случае могут прийти устаревшие данные (или не прийти вовсе). Особенно это характерно для контейнеров<br />
Например:<br />
На слежение был поставлен контейнер в начале рабочего дня в 09:00. Время обновления данных: 09:30, 14:30 и 17:30.<br />
В 09:30 этого же дня с высокой долей вероятности будут получены неактуальные (устаревшие) данные или данных не будет. В 14:30 и 17:30 будут получены уже актуализированные отчеты.<br />
Все последующие сутки актуальные отчеты будут приходить в любое из указанного в расписании время, т.е. и в 09:30 следующих суток уже придут свежие данные. <br/><br />
<br />
Существует несколько регионов слежения: РФ, СНГ и Балтия, СНГ и Балтия + Китай + Монголия. Ниже описаны основные особенности:<br><br />
- При слежении первый ответ (обновление) может формироваться довольно продолжительное время: от 2-3 часов по РФ до суток по странам Средней Азии и Китаю. <br />
- В течение суток можно получить до 3-х обновлений дислокации за одну цену.<br />
- Стоимость слежения по РФ значительно ниже слежения по другим регионам. Однако, в случае пересечения перевозочного средства границы нет никаких гарантий, что свежая информация продолжит поступать.<br />
- Слежение по СНГ и Балтии, Китаю и Монголии позволяет получать дислокацию по всем перечисленным регионам, независимо от того, где находится ПС<br />
- При постановке ПС на слежение задается регламент получения отчетов - в какой день недели и какое время удобно получать свежую информацию, а также способ снятия со слежения (ручной или автоматический)<br />
- Существуют 2 типа слежения: посуточное и рейс. Единственное отличие между ними - в способе тарификации. Посуточное слежение - это такой тип слежения, когда денежные средства списываются со счета клиента при очередном формировании отчета (т.е. первом отчете за сутки согласно расписанию). Рейс тарифицируется сразу за весь маршрут при постановке на слежение и нет необходимости следить за состоянием баланса.<br />
- Для слежения информация по hash будет постоянно обновляться до окончания слежения. <br />
Ниже приводится полный список входных параметров. Жирным шрифтом отмечены те из них, значению которых следует уделить внимание при постановке на слежение:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||add - добавление запроса на слежение<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067"<br />
<br />
|-<br />
|<b>state</b>||string||Код страны, по которой осуществляется запрос. Для РФ - 20. По странам СНГ и Балтии, Монголии, Китаю - 22.<br />
<br />
|-<br />
|<b>track_state</b>||string||Регион слежения. ru - только Россия, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|<b>track_type</b>||int||Тип слежения. Для посуточного слежения запроса track_type=2, для рейса - track_type=3<br />
<br />
|-<br />
|<b>stop_station</b>||string||Снимать ли со слежения по прибытию на станцию назначения. "yes" - снимать, "no" - не снимать. Если указать <код ЕСР> - снимать по прибытию на станцию с кодом <код ЕСР>. Код ЕСР - 5-и значный код станции согласно Единой Сетевой Разметке (ЕСР). <br />
<br />
|-<br />
|<b>times</b>||string||Время обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Формат: "H:i", через запятую. Например: "09:00,13:00,18:00". Время московское. <br />
<br />
|-<br />
|<b>times_per_day</b>||string||Количество обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Если указано, что times меньше times_per_day, то times имеет больший приоритет. Например, times_per_day="2", a times="09:00,13:00,18:00", то отчет будет сформирован только в первое время и второе время, т.е. в 09:00 и в 13:00.<br />
<br />
|-<br />
|<b>days</b>||string||Дни недели, по которым необходимо получать отчет, через запятую. Номера начинаются с нуля (Воскресенье) до 6 (Суббота). Например, если отчеты необходимы по будням, то days="1,2,3,4,5". <br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу в urlencode<br />
<br />
|-<br />
|emails||string||Список email-адресов, куда отправить отчет о дислокации после выполнения, через запятую.<br />
<br />
|-<br />
|email_report_type||int||Всегда 2<br />
<br />
|-<br />
|attach_excel||int||Вкладывать ли в письма копию отчета в Excel. 1 - вкладывать, 0 - не вкладывать. По умолчанию 0.<br />
<br />
|}<br />
<br />
==Пример постановки на слежение==<br />
Контейнер AMFU8899067, получение инфорамции по будням дням (days=1,2,3,4,5) в 09:00 и 13:00 по московскому времени (times=09:00,13:00 и times_per_day=2), регион - только РФ (track_state=ru, state=20) без снятия со слежения по прибытии на станцию назначения (stop_station=no, т.е. ручное снятие), адреса для рассылки отчетов alta@alta.ru,mymail@mymail.com (emails=alta@alta.ru,mymail@mymail.com):<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&wagons=AMFU8899067&state=20&track_type=2&comment=%D0%BF%D0%B5%D1%80%D0%B2%D0%BE%D0%B5+%D1%81%D0%BB%D0%B5%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5+%28%D0%BA%D0%BE%D0%BD%D1%82%29&days=1,2,3,4,5&times_per_day=2&times=09:00,13:00&track_state=ru&stop_station=no&emails=alta@alta.ru,mymail@mymail.com<br />
<br><br />
JSON-ответ включает в себя отчет о состоянии запроса на слежение (поставлен/не поставлен на слежение) и hash, по которому можно получить ответ.<br><br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"cont_hash": "931700e35d7ff88a10bd5d680da50f02"<br />
}<br />
]<br />
</source><br />
<br />
При постановке вагона на слежение получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c"<br />
}<br />
]<br />
</source><br />
<br />
Поля hash и cont_hash можно использовать для получения <b>текущей</b> дислокации (согласно расписанию).<br />
<br />
==Получение ответа на ПС, стоящих на слежении. Метод "show". ==<br />
После размещения запроса он встает в очередь на обработку. В обозначенный момент времени (по расписанию) запрос выполняется. Обычно обработка запроса на слежение занимает около 1 минуты. В случае повышенной нагрузки на сервер обработка может занимать до 5 минут и более. <br><br />
Оптимальный период опроса сервера - 1 минута. В случае частых запросов ООО "Альта-Софт" оставляет за собой право заблокировать такие запросы и отказать в обслуживании. <br><br />
Для получение последней дислокации необходимо вызвать метод "show". <br><br><br />
Например, для получения дислокации контейнера AMFU8899067: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=show&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
JSON-ответ включает в себя отчет о состоянии запроса (в очереди/обрабатывается/обработан) в первом элементе массива, в последующих элементах - отчет о дислокации перевозочных средств.<br />
Например, на запрос AMFU8899067 получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Обработан",<br />
"query_status": "4",<br />
"hash": "fece39d1523836d03c3c2da73a6f1275",<br />
"type": "2",<br />
"count": 1<br />
},<br />
{<br />
"num": "AMFU8899067",<br />
"on_track": 0,<br />
"station": "24160",<br />
"station_name": "Вековка",<br />
"state": "20",<br />
"state_name": "Россия",<br />
"lon": "40.764762",<br />
"lat": "55.498762",<br />
"road_name": "Горьковская",<br />
"op_date": "2017-12-05 20:03:00",<br />
"departure_date": "2017-12-03 14:06:00",<br />
"route_start_date": "",<br />
"delivery_date": "2017-12-15 00:00:00",<br />
"etd_date": "2017-12-20:00:00",<br />
"operation": "ПРИБЫТИЕ С ПОЕЗДОМ НА СТАНЦИЮ",<br />
"nakl_nom": "",<br />
"okpo": "94421386",<br />
"owner": null,<br />
"kgro": "1386",<br />
"kgrp": "7575",<br />
"train_index": "18290-853-98130",<br />
"train_number": "1282",<br />
"fraight": "51403",<br />
"fraight_name": "Изделия кондитерские сахаристые, н.п.",<br />
"weight": "13000",<br />
"wagon_number": "94785045",<br />
"station_from": "18290",<br />
"is_loaded": 1,<br />
"hash": "ea7a000c4649388f68af14051f0827a04f11a2ee",<br />
"station_to": "98130",<br />
"station_from_name": "Тучково",<br />
"station_to_name": "Первая Речка",<br />
"route": "8928"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|-<br />
|type||string||Тип запроса. 1- вагоны, 2 - контейнеры<br />
<br />
|-<br />
|query_status||string||Состояние запроса. 1 - в очереди, 2 - обрабатывается, 3 или 4 - обработан<br />
<br />
|-<br />
|count||int||Количество перевозочных средств в отчете<br />
<br />
|-<br />
|hash||string||Хэш запроса.<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы''' (при query_status больше 2)<br />
<br />
|-<br />
|num||string||Номер перевозочного средства<br />
<br />
|-<br />
|station||string||Код станции, где была зафиксирована последняя операция с перевозочным средством. 5 символов(или 6 символов, 6-й - контрольный знак). В случае отсутствия данных по дислокации ПС значение будет "no_data".<br />
|-<br />
|station_name||string||Название станции, где была зафиксирована последняя операция с перевозочным средством. <br />
<br />
|-<br />
|op_date||string||Дата фиксирования последней операции. В формате "Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|operation||string||Наименование последней операции<br />
<br />
|-<br />
|route||string||Оставшееся до станции назначения расстояние, км<br />
<br />
|-<br />
|on_track||int||Стоит ли перевозочное средство на слежении. 1 - стоит, 0 - снят или оперативный запрос<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|state||string||Код государства станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|state_name||string||Название государства станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|lon||string||Долгота станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|lat||string||Широта станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|road_name||string||Дорога, где была зафиксирована последняя операция<br />
<br />
|-<br />
|departure_date||string||Дата отправки. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|route_start_date||string||Дата начала рейса. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|delivery_date||string||Ожидаемая дата прибытия на ст. назначения. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|etd_date||string||Ожидаемая дата доставки контейнера грузополучателю после раскредитовки. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|nakl_nom||string||Номер накладной<br />
<br />
|-<br />
|okpo||string||ОКПО отправителя<br />
<br />
|-<br />
|owner||string||Собственник перевозочного средства<br />
<br />
|-<br />
|kgro||string||Номер грузоотправителя<br />
|-<br />
<br />
|kgrp||string||Номер грузополучателя<br />
|-<br />
<br />
|train_index||string||Индекс поезда<br />
|-<br />
<br />
|train_number||string||Номер поезда<br />
|-<br />
<br />
|fraight||string||Код груза по номенклатуре ЕТСНГ<br />
|-<br />
<br />
|fraight_name||string||Наименование груза<br />
|-<br />
<br />
|weight||string||Вес груза (чаще всего в килограммах, но может быть в центнерах или тоннах)<br />
|-<br />
<br />
|wagon_number||string||Номер вагона (платформы), на котором закреплен контейнер (только для контейнерных запросов)<br />
|-<br />
<br />
|station_from||string||Код станции отправления<br />
|-<br />
<br />
|station_from_name||string||Название станции отправления<br />
|-<br />
<br />
|station_to||string||Код станции назначения<br />
|-<br />
<br />
|station_to_name||string||Название станции назначения<br />
|-<br />
<br />
|is_loaded||int||1 - груженый, 0 - порожний<br />
|-<br />
<br />
|}<br />
<br />
<br />
==Снятие со слежения. Метод cancel_track.==<br />
<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||cancel_track - снятие со слежения запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например, ebc356dfa5beee7d3844ccacf535410c<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. В случае указания списка со слежения будут сняты только те ПС, которые в нем указаны, а не весь запрос. Например, "54676515"<br />
<br />
|}<br />
<br />
== Пример снятия со слежения==<br />
Снять со слежения вагон 54676515 из запроса с hash ebc356dfa5beee7d3844ccacf535410c<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=ebc356dfa5beee7d3844ccacf535410c&wagons=54676515<br />
<br />
Снять со слежения '''весь''' (т.е. все перевозочные средства из запроса) запрос с hash 931700e35d7ff88a10bd5d680da50f02<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Обратите внимание, что для тестовых данных ответ на запрос снятия со слежения будет "успешно", однако фактически запросы останутся на слежении.<br />
<br />
== Получение списка запросов на слежении. Метод "track_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||track_list - список запросов, стоящих на слежении<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=track_list&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"name": "первое слежение",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c",<br />
"modify_date": "29.07.2021 21:52",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
},<br />
{<br />
"name": "первое слежение (конт)",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "931700e35d7ff88a10bd5d680da50f02",<br />
"modify_date": "03.08.2021 13:10",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу<br />
<br />
|-<br />
|vagon_count||string||Количество ПС в запросе<br />
<br />
|-<br />
|email||string||Адреса электронной почты для рассылки отчетов о дислокации, через запятую.<br />
<br />
|-<br />
|hash||string||Hash запроса.<br />
<br />
|-<br />
|modify_date||string||Дата последнего изменения/выполнения запроса.<br />
<br />
|-<br />
|on_track||string||Стоит ли запрос на слежении. 1 - стоит, 0 - снят.<br />
<br />
|-<br />
|track_type||string||Тип слежения. 1 - постоянное, 2 - рейс. Обратите внимание, нумерация в данном случае отличае от таковой при постановке на слежение./<br />
<br />
|-<br />
|track_state||string||Регион слежения. ru - только РФ, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|state||string||Государство слежения. 20 - РФ, 22 - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|status||int||Статус обработки запроса. 1 - в очереди на обработку, 2 - обрабатывается, 3,4 - обработан<br />
<br />
|}<br />
<br />
== Получение списка ПС в запросе. Метод "carr_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||carr_list - список номеров перевозочных средств в запросе<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например 931700e35d7ff88a10bd5d680da50f02<br />
<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=carr_list&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"group_id": 1519743,<br />
"carrs": [<br />
"AMFU8899067"<br />
]<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|carrs||string||Массив номеров перевозочных средств в запросе<br />
<br />
|}<br />
<br />
== Получение баланса. Метод "balance"==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||balance - остаток денежных средств или бонусов на счету <br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=balance&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
Json-ответ<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Ваш баланс: 0.00 руб. / Бонусы 0",<br />
"balans": "0.00",<br />
"bonus": 0,<br />
"sa": "sa000000"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Остаток денежных средств/бонусов в текстовом виде<br />
<br />
|-<br />
|balans||string||Остаток денежных средств в рублях<br />
<br />
|-<br />
|bonus||string||Остаток бонусов<br />
<br />
|-<br />
|sa||string||Номер договора (сервис-аккаунта)<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1229JSON-API сервиса поиска вагонов2022-07-01T10:01:59Z<p>Boluchevskikh: </p>
<hr />
<div>==О сервисе==<br />
JSON-API сервиса «Поиск вагонов» позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно ставить и снимать вагоны и контейнеры на слежение по СНГ, странам Балтии, Монголии и Китаю.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET или POST. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса для поиска вагонов - всегда '''rail_tracking'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5('alta_test')") = bb92dcee8bf2b49287e1038b65a72b79 <br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих номеров: <br><br />
вагоны - 54676515 <br><br />
контейнеры - AMFU8899067 <br><br />
<br />
Hash для получения ответов по вагонам:<br />
- слежение ebc356dfa5beee7d3844ccacf535410c <br><br />
Cont_hash для получения ответов по контейнерам:<br />
- слежение 931700e35d7ff88a10bd5d680da50f02 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом эелементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о дислокации, список вагонов и проч.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}<br />
<br />
==Постановка вагонов/контейнеров на слежение. Метод "add".==<br />
Постановка на слежение выполняется с помощью метода "add". <br><br />
<br />
Обращаем внимание, что в связи с особенностями работы системы слежения получение первого отчета с актуальными данными возможно не ранее 2-3 часов с момента постановкии на слежение.<br />
В противном случае могут прийти устаревшие данные (или не прийти вовсе). Особенно это характерно для контейнеров<br />
Например:<br />
На слежение был поставлен контейнер в начале рабочего дня в 09:00. Время обновления данных: 09:30, 14:30 и 17:30.<br />
В 09:30 этого же дня с высокой долей вероятности будут получены неактуальные (устаревшие) данные или данных не будет. В 14:30 и 17:30 будут получены уже актуализированные отчеты.<br />
Все последующие сутки актуальные отчеты будут приходить в любое из указанного в расписании время, т.е. и в 09:30 следующих суток уже придут свежие данные. <br/><br />
<br />
Существует несколько регионов слежения: РФ, СНГ и Балтия, СНГ и Балтия + Китай + Монголия. Ниже описаны основные особенности:<br><br />
- При слежении первый ответ (обновление) может формироваться довольно продолжительное время: от 2-3 часов по РФ до суток по странам Средней Азии и Китаю. <br />
- В течение суток можно получить до 3-х обновлений дислокации за одну цену.<br />
- Стоимость слежения по РФ значительно ниже слежения по другим регионам. Однако, в случае пересечения перевозочного средства границы нет никаких гарантий, что свежая информация продолжит поступать.<br />
- Слежение по СНГ и Балтии, Китаю и Монголии позволяет получать дислокацию по всем перечисленным регионам, независимо от того, где находится ПС<br />
- При постановке ПС на слежение задается регламент получения отчетов - в какой день недели и какое время удобно получать свежую информацию, а также способ снятия со слежения (ручной или автоматический)<br />
- Существуют 2 типа слежения: посуточное и рейс. Единственное отличие между ними - в способе тарификации. Посуточное слежение - это такой тип слежения, когда денежные средства списываются со счета клиента при очередном формировании отчета (т.е. первом отчете за сутки согласно расписанию). Рейс тарифицируется сразу за весь маршрут при постановке на слежение и нет необходимости следить за состоянием баланса.<br />
- Для слежения информация по hash будет постоянно обновляться до окончания слежения. <br />
Ниже приводится полный список входных параметров. Жирным шрифтом отмечены те из них, значению которых следует уделить внимание при постановке на слежение:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||add - добавление запроса на слежение<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067"<br />
<br />
|-<br />
|<b>state</b>||string||Код страны, по которой осуществляется запрос. Для РФ - 20. По странам СНГ и Балтии, Монголии, Китаю - 22.<br />
<br />
|-<br />
|<b>track_state</b>||string||Регион слежения. ru - только Россия, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|<b>track_type</b>||int||Тип слежения. Для посуточного слежения запроса track_type=2, для рейса - track_type=3<br />
<br />
|-<br />
|<b>stop_station</b>||string||Снимать ли со слежения по прибытию на станцию назначения. "yes" - снимать, "no" - не снимать. Если указать <код ЕСР> - снимать по прибытию на станцию с кодом <код ЕСР>. Код ЕСР - 5-и значный код станции согласно Единой Сетевой Разметке (ЕСР). <br />
<br />
|-<br />
|<b>times</b>||string||Время обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Формат: "H:i", через запятую. Например: "09:00,13:00,18:00". Время московское. <br />
<br />
|-<br />
|<b>times_per_day</b>||string||Количество обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Если указано, что times меньше times_per_day, то times имеет больший приоритет. Например, times_per_day="2", a times="09:00,13:00,18:00", то отчет будет сформирован только в первое время и второе время, т.е. в 09:00 и в 13:00.<br />
<br />
|-<br />
|<b>days</b>||string||Дни недели, по которым необходимо получать отчет, через запятую. Номера начинаются с нуля (Воскресенье) до 6 (Суббота). Например, если отчеты необходимы по будням, то days="1,2,3,4,5". <br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу в urlencode<br />
<br />
|-<br />
|emails||string||Список email-адресов, куда отправить отчет о дислокации после выполнения, через запятую.<br />
<br />
|-<br />
|email_report_type||int||Всегда 2<br />
<br />
|-<br />
|attach_excel||int||Вкладывать ли в письма копию отчета в Excel. 1 - вкладывать, 0 - не вкладывать. По умолчанию 0.<br />
<br />
|}<br />
<br />
==Пример постановки на слежение==<br />
Контейнер AMFU8899067, получение инфорамции по будням дням (days=1,2,3,4,5) в 09:00 и 13:00 по московскому времени (times=09:00,13:00 и times_per_day=2), регион - только РФ (track_state=ru, state=20) без снятия со слежения по прибытии на станцию назначения (stop_station=no, т.е. ручное снятие), адреса для рассылки отчетов alta@alta.ru,mymail@mymail.com (emails=alta@alta.ru,mymail@mymail.com):<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&wagons=AMFU8899067&state=20&track_type=2&comment=%D0%BF%D0%B5%D1%80%D0%B2%D0%BE%D0%B5+%D1%81%D0%BB%D0%B5%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5+%28%D0%BA%D0%BE%D0%BD%D1%82%29&days=1,2,3,4,5&times_per_day=2&times=09:00,13:00&track_state=ru&stop_station=no&emails=alta@alta.ru,mymail@mymail.com<br />
<br><br />
JSON-ответ включает в себя отчет о состоянии запроса на слежение (поставлен/не поставлен на слежение) и hash, по которому можно получить ответ.<br><br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"cont_hash": "931700e35d7ff88a10bd5d680da50f02"<br />
}<br />
]<br />
</source><br />
<br />
При постановке вагона на слежение получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c"<br />
}<br />
]<br />
</source><br />
<br />
Поля hash и cont_hash можно использовать для получения <b>текущей</b> дислокации (согласно расписанию).<br />
<br />
==Получение ответа на ПС, стоящих на слежении. Метод "show". ==<br />
После размещения запроса он встает в очередь на обработку. В обозначенный момент времени (по расписанию) запрос выполняется. Обычно обработка запроса на слежение занимает около 1 минуты. В случае повышенной нагрузки на сервер обработка может занимать до 5 минут и более. <br><br />
Оптимальный период опроса сервера - 1 минута. В случае частых запросов ООО "Альта-Софт" оставляет за собой право заблокировать такие запросы и отказать в обслуживании. <br><br />
Для получение последней дислокации необходимо вызвать метод "show". <br><br><br />
Например, для получения дислокации контейнера AMFU8899067: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=show&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
==Снятие со слежения. Метод cancel_track.==<br />
<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||cancel_track - снятие со слежения запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например, ebc356dfa5beee7d3844ccacf535410c<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. В случае указания списка со слежения будут сняты только те ПС, которые в нем указаны, а не весь запрос. Например, "54676515"<br />
<br />
|}<br />
<br />
== Пример снятия со слежения==<br />
Снять со слежения вагон 54676515 из запроса с hash ebc356dfa5beee7d3844ccacf535410c<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=ebc356dfa5beee7d3844ccacf535410c&wagons=54676515<br />
<br />
Снять со слежения '''весь''' (т.е. все перевозочные средства из запроса) запрос с hash 931700e35d7ff88a10bd5d680da50f02<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Обратите внимание, что для тестовых данных ответ на запрос снятия со слежения будет "успешно", однако фактически запросы останутся на слежении.<br />
<br />
== Получение списка запросов на слежении. Метод "track_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||track_list - список запросов, стоящих на слежении<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=track_list&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"name": "первое слежение",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c",<br />
"modify_date": "29.07.2021 21:52",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
},<br />
{<br />
"name": "первое слежение (конт)",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "931700e35d7ff88a10bd5d680da50f02",<br />
"modify_date": "03.08.2021 13:10",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу<br />
<br />
|-<br />
|vagon_count||string||Количество ПС в запросе<br />
<br />
|-<br />
|email||string||Адреса электронной почты для рассылки отчетов о дислокации, через запятую.<br />
<br />
|-<br />
|hash||string||Hash запроса.<br />
<br />
|-<br />
|modify_date||string||Дата последнего изменения/выполнения запроса.<br />
<br />
|-<br />
|on_track||string||Стоит ли запрос на слежении. 1 - стоит, 0 - снят.<br />
<br />
|-<br />
|track_type||string||Тип слежения. 1 - постоянное, 2 - рейс. Обратите внимание, нумерация в данном случае отличае от таковой при постановке на слежение./<br />
<br />
|-<br />
|track_state||string||Регион слежения. ru - только РФ, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|state||string||Государство слежения. 20 - РФ, 22 - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|status||int||Статус обработки запроса. 1 - в очереди на обработку, 2 - обрабатывается, 3,4 - обработан<br />
<br />
|}<br />
<br />
== Получение списка ПС в запросе. Метод "carr_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||carr_list - список номеров перевозочных средств в запросе<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например 931700e35d7ff88a10bd5d680da50f02<br />
<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=carr_list&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"group_id": 1519743,<br />
"carrs": [<br />
"AMFU8899067"<br />
]<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|carrs||string||Массив номеров перевозочных средств в запросе<br />
<br />
|}<br />
<br />
== Получение баланса. Метод "balance"==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||balance - остаток денежных средств или бонусов на счету <br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=balance&login=alta@alta.ru&sa=sa000000&secret=bb92dcee8bf2b49287e1038b65a72b79<br />
<br />
Json-ответ<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Ваш баланс: 0.00 руб. / Бонусы 0",<br />
"balans": "0.00",<br />
"bonus": 0,<br />
"sa": "sa000000"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Остаток денежных средств/бонусов в текстовом виде<br />
<br />
|-<br />
|balans||string||Остаток денежных средств в рублях<br />
<br />
|-<br />
|bonus||string||Остаток бонусов<br />
<br />
|-<br />
|sa||string||Номер договора (сервис-аккаунта)<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1228API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2022-06-30T12:16:19Z<p>Boluchevskikh: </p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования] <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления (необязательный). Если не указан код страны отправления, то автоматически будет установлена РФ.</li><br />
<li>tstate - код страны назначения (необязательный). Если не указан код страны назначения, то автоматически будет установлена РФ.</li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>is_speed - [0|1], default = 1. Расчет перевозки большой скоростью - 1, не включать - 0. Необязательный. <br /><br />
<li>is_cont_train - [0|1], default = 1. Расчет перевозки контейнерным поездом - 1, не включать - 0. Необязательный. <br /><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.<br /><br />
<br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1226JSON-API сервиса поиска вагонов2022-06-20T12:15:26Z<p>Boluchevskikh: </p>
<hr />
<div>==О сервисе==<br />
JSON-API сервиса «Поиск вагонов» позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно ставить и снимать вагоны и контейнеры на слежение по СНГ, странам Балтии, Монголии и Китаю.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET или POST. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса для поиска вагонов - всегда '''rail_tracking'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5('alta_test')") = 5ec1514f1b5a383fc5ad3f04bb9ac0e3 <br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих номеров: <br><br />
вагоны - 54676515 <br><br />
контейнеры - AMFU8899067 <br><br />
<br />
Hash для получения ответов по вагонам:<br />
- слежение ebc356dfa5beee7d3844ccacf535410c <br><br />
Cont_hash для получения ответов по контейнерам:<br />
- слежение 931700e35d7ff88a10bd5d680da50f02 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом эелементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о дислокации, список вагонов и проч.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}<br />
<br />
==Постановка вагонов/контейнеров на слежение. Метод "add".==<br />
Постановка на слежение выполняется с помощью метода "add". <br><br />
<br />
Обращаем внимание, что в связи с особенностями работы системы слежения получение первого отчета с актуальными данными возможно не ранее 2-3 часов с момента постановкии на слежение.<br />
В противном случае могут прийти устаревшие данные (или не прийти вовсе). Особенно это характерно для контейнеров<br />
Например:<br />
На слежение был поставлен контейнер в начале рабочего дня в 09:00. Время обновления данных: 09:30, 14:30 и 17:30.<br />
В 09:30 этого же дня с высокой долей вероятности будут получены неактуальные (устаревшие) данные или данных не будет. В 14:30 и 17:30 будут получены уже актуализированные отчеты.<br />
Все последующие сутки актуальные отчеты будут приходить в любое из указанного в расписании время, т.е. и в 09:30 следующих суток уже придут свежие данные. <br/><br />
<br />
Существует несколько регионов слежения: РФ, СНГ и Балтия, СНГ и Балтия + Китай + Монголия. Ниже описаны основные особенности:<br><br />
- При слежении первый ответ (обновление) может формироваться довольно продолжительное время: от 2-3 часов по РФ до суток по странам Средней Азии и Китаю. <br />
- В течение суток можно получить до 3-х обновлений дислокации за одну цену.<br />
- Стоимость слежения по РФ значительно ниже слежения по другим регионам. Однако, в случае пересечения перевозочного средства границы нет никаких гарантий, что свежая информация продолжит поступать.<br />
- Слежение по СНГ и Балтии, Китаю и Монголии позволяет получать дислокацию по всем перечисленным регионам, независимо от того, где находится ПС<br />
- При постановке ПС на слежение задается регламент получения отчетов - в какой день недели и какое время удобно получать свежую информацию, а также способ снятия со слежения (ручной или автоматический)<br />
- Существуют 2 типа слежения: посуточное и рейс. Единственное отличие между ними - в способе тарификации. Посуточное слежение - это такой тип слежения, когда денежные средства списываются со счета клиента при очередном формировании отчета (т.е. первом отчете за сутки согласно расписанию). Рейс тарифицируется сразу за весь маршрут при постановке на слежение и нет необходимости следить за состоянием баланса.<br />
- Для слежения информация по hash будет постоянно обновляться до окончания слежения. <br />
Ниже приводится полный список входных параметров. Жирным шрифтом отмечены те из них, значению которых следует уделить внимание при постановке на слежение:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||add - добавление запроса на слежение<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067"<br />
<br />
|-<br />
|<b>state</b>||string||Код страны, по которой осуществляется запрос. Для РФ - 20. По странам СНГ и Балтии, Монголии, Китаю - 22.<br />
<br />
|-<br />
|<b>track_state</b>||string||Регион слежения. ru - только Россия, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|<b>track_type</b>||int||Тип слежения. Для посуточного слежения запроса track_type=2, для рейса - track_type=3<br />
<br />
|-<br />
|<b>stop_station</b>||string||Снимать ли со слежения по прибытию на станцию назначения. "yes" - снимать, "no" - не снимать. Если указать <код ЕСР> - снимать по прибытию на станцию с кодом <код ЕСР>. Код ЕСР - 5-и значный код станции согласно Единой Сетевой Разметке (ЕСР). <br />
<br />
|-<br />
|<b>times</b>||string||Время обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Формат: "H:i", через запятую. Например: "09:00,13:00,18:00". Время московское. <br />
<br />
|-<br />
|<b>times_per_day</b>||string||Количество обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Если указано, что times меньше times_per_day, то times имеет больший приоритет. Например, times_per_day="2", a times="09:00,13:00,18:00", то отчет будет сформирован только в первое время и второе время, т.е. в 09:00 и в 13:00.<br />
<br />
|-<br />
|<b>days</b>||string||Дни недели, по которым необходимо получать отчет, через запятую. Номера начинаются с нуля (Воскресенье) до 6 (Суббота). Например, если отчеты необходимы по будням, то days="1,2,3,4,5". <br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу в urlencode<br />
<br />
|-<br />
|emails||string||Список email-адресов, куда отправить отчет о дислокации после выполнения, через запятую.<br />
<br />
|-<br />
|email_report_type||int||Всегда 2<br />
<br />
|-<br />
|attach_excel||int||Вкладывать ли в письма копию отчета в Excel. 1 - вкладывать, 0 - не вкладывать. По умолчанию 0.<br />
<br />
|}<br />
<br />
==Пример постановки на слежение==<br />
Контейнер AMFU8899067, получение инфорамции по будням дням (days=1,2,3,4,5) в 09:00 и 13:00 по московскому времени (times=09:00,13:00 и times_per_day=2), регион - только РФ (track_state=ru, state=20) без снятия со слежения по прибытии на станцию назначения (stop_station=no, т.е. ручное снятие), адреса для рассылки отчетов alta@alta.ru,mymail@mymail.com (emails=alta@alta.ru,mymail@mymail.com):<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&wagons=AMFU8899067&state=20&track_type=2&comment=%D0%BF%D0%B5%D1%80%D0%B2%D0%BE%D0%B5+%D1%81%D0%BB%D0%B5%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5+%28%D0%BA%D0%BE%D0%BD%D1%82%29&days=1,2,3,4,5&times_per_day=2&times=09:00,13:00&track_state=ru&stop_station=no&emails=alta@alta.ru,mymail@mymail.com<br />
<br><br />
JSON-ответ включает в себя отчет о состоянии запроса на слежение (поставлен/не поставлен на слежение) и hash, по которому можно получить ответ.<br><br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"cont_hash": "931700e35d7ff88a10bd5d680da50f02"<br />
}<br />
]<br />
</source><br />
<br />
При постановке вагона на слежение получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c"<br />
}<br />
]<br />
</source><br />
<br />
Поля hash и cont_hash можно использовать для получения <b>текущей</b> дислокации (согласно расписанию).<br />
<br />
==Получение ответа на ПС, стоящих на слежении. Метод "show". ==<br />
После размещения запроса он встает в очередь на обработку. В обозначенный момент времени (по расписанию) запрос выполняется. Обычно обработка запроса на слежение занимает около 1 минуты. В случае повышенной нагрузки на сервер обработка может занимать до 5 минут и более. <br><br />
Оптимальный период опроса сервера - 1 минута. В случае частых запросов ООО "Альта-Софт" оставляет за собой право заблокировать такие запросы и отказать в обслуживании. <br><br />
Для получение последней дислокации необходимо вызвать метод "show". <br><br><br />
Например, для получения дислокации контейнера AMFU8899067: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=show&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
==Снятие со слежения. Метод cancel_track.==<br />
<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||cancel_track - снятие со слежения запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например, ebc356dfa5beee7d3844ccacf535410c<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. В случае указания списка со слежения будут сняты только те ПС, которые в нем указаны, а не весь запрос. Например, "54676515"<br />
<br />
|}<br />
<br />
== Пример снятия со слежения==<br />
Снять со слежения вагон 54676515 из запроса с hash ebc356dfa5beee7d3844ccacf535410c<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=ebc356dfa5beee7d3844ccacf535410c&wagons=54676515<br />
<br />
Снять со слежения '''весь''' (т.е. все перевозочные средства из запроса) запрос с hash 931700e35d7ff88a10bd5d680da50f02<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Обратите внимание, что для тестовых данных ответ на запрос снятия со слежения будет "успешно", однако фактически запросы останутся на слежении.<br />
<br />
== Получение списка запросов на слежении. Метод "track_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||track_list - список запросов, стоящих на слежении<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=track_list&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"name": "первое слежение",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c",<br />
"modify_date": "29.07.2021 21:52",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
},<br />
{<br />
"name": "первое слежение (конт)",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "931700e35d7ff88a10bd5d680da50f02",<br />
"modify_date": "03.08.2021 13:10",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу<br />
<br />
|-<br />
|vagon_count||string||Количество ПС в запросе<br />
<br />
|-<br />
|email||string||Адреса электронной почты для рассылки отчетов о дислокации, через запятую.<br />
<br />
|-<br />
|hash||string||Hash запроса.<br />
<br />
|-<br />
|modify_date||string||Дата последнего изменения/выполнения запроса.<br />
<br />
|-<br />
|on_track||string||Стоит ли запрос на слежении. 1 - стоит, 0 - снят.<br />
<br />
|-<br />
|track_type||string||Тип слежения. 1 - постоянное, 2 - рейс. Обратите внимание, нумерация в данном случае отличае от таковой при постановке на слежение./<br />
<br />
|-<br />
|track_state||string||Регион слежения. ru - только РФ, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|state||string||Государство слежения. 20 - РФ, 22 - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|status||int||Статус обработки запроса. 1 - в очереди на обработку, 2 - обрабатывается, 3,4 - обработан<br />
<br />
|}<br />
<br />
== Получение списка ПС в запросе. Метод "carr_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||carr_list - список номеров перевозочных средств в запросе<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например 931700e35d7ff88a10bd5d680da50f02<br />
<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=carr_list&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"group_id": 1519743,<br />
"carrs": [<br />
"AMFU8899067"<br />
]<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|carrs||string||Массив номеров перевозочных средств в запросе<br />
<br />
|}<br />
<br />
== Получение баланса. Метод "balance"==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||balance - остаток денежных средств или бонусов на счету <br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=balance&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
Json-ответ<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Ваш баланс: 0.00 руб. / Бонусы 0",<br />
"balans": "0.00",<br />
"bonus": 0,<br />
"sa": "sa000000"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Остаток денежных средств/бонусов в текстовом виде<br />
<br />
|-<br />
|balans||string||Остаток денежных средств в рублях<br />
<br />
|-<br />
|bonus||string||Остаток бонусов<br />
<br />
|-<br />
|sa||string||Номер договора (сервис-аккаунта)<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1225JSON-API сервиса поиска вагонов2022-06-20T12:14:46Z<p>Boluchevskikh: </p>
<hr />
<div>==О сервисе==<br />
JSON-API сервиса «Поиск вагонов» позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно ставить и снимать вагоны и контейнеры на слежение по СНГ, странам Балтии, Монголии и Китаю.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET или POST. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса для поиска вагонов - всегда '''rail_tracking'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5('alta_test')") = 5ec1514f1b5a383fc5ad3f04bb9ac0e3 <br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих номеров: <br><br />
вагоны - 54676515 <br><br />
контейнеры - AMFU8899067 <br><br />
<br />
Hash для получения ответов по вагонам:<br />
- слежение ebc356dfa5beee7d3844ccacf535410c <br><br />
Cont_hash для получения ответов по контейнерам:<br />
- слежение 931700e35d7ff88a10bd5d680da50f02 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом эелементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о дислокации, список вагонов и проч.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}<br />
<br />
==Постановка вагонов/контейнеров на слежение. Метод "add".==<br />
Постановка на слежение выполняется с помощью метода "add". <br><br />
<br />
Обращаем внимание, что в связи с особенностями работы системы слежения получение первого отчета с актуальными данными возможно не ранее 2-3 часов с момента постановкии на слежение.<br />
В противном случае могут прийти устаревшие данные (или не прийти вовсе). Особенно это характерно для контейнеров<br />
Например:<br />
На слежение был поставлен контейнер в начале рабочего дня в 09:00. Время обновления данных: 09:30, 14:30 и 17:30.<br />
В 09:30 этого же дня с высокой долей вероятности будут получены неактуальные (устаревшие) данные или данных не будет. В 14:30 и 17:30 будут получены уже актуализированные отчеты.<br />
Все последующие сутки актуальные отчеты будут приходить в любое из указанного в расписании время, т.е. и в 09:30 следующих суток уже придут свежие данные. <br/><br />
<br />
Существует несколько регионов слежения: РФ, СНГ и Балтия, СНГ и Балтия + Китай + Монголия. Ниже описаны основные особенности:<br><br />
- При слежении первый ответ (обновление) может формироваться довольно продолжительное время: от 2-3 часов по РФ до суток по странам Средней Азии и Китаю. <br />
- В течение суток можно получить до 3-х обновлений дислокации за одну цену.<br />
- Стоимость слежения по РФ значительно ниже слежения по другим регионам. Однако, в случае пересечения перевозочного средства границы нет никаких гарантий, что свежая информация продолжит поступать.<br />
- Слежение по СНГ и Балтии, Китаю и Монголии позволяет получать дислокацию по всем перечисленным регионам, независимо от того, где находится ПС<br />
- При постановке ПС на слежение задается регламент получения отчетов - в какой день недели и какое время удобно получать свежую информацию, а также способ снятия со слежения (ручной или автоматический)<br />
- Существуют 2 типа слежения: посуточное и рейс. Единственное отличие между ними - в способе тарификации. Посуточное слежение - это такой тип слежения, когда денежные средства списываются со счета клиента при очередном формировании отчета (т.е. первом отчете за сутки согласно расписанию). Рейс тарифицируется сразу за весь маршрут при постановке на слежение и нет необходимости следить за состоянием баланса.<br />
- Для слежения информация по hash будет постоянно обновляться до окончания слежения. <br />
Ниже приводится полный список входных параметров. Жирным шрифтом отмечены те из них, значению которых следует уделить внимание при постановке на слежение:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||add - добавление оперативного запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067"<br />
<br />
|-<br />
|<b>state</b>||string||Код страны, по которой осуществляется запрос. Для РФ - 20. По странам СНГ и Балтии, Монголии, Китаю - 22.<br />
<br />
|-<br />
|<b>track_state</b>||string||Регион слежения. ru - только Россия, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|<b>track_type</b>||int||Тип слежения. Для посуточного слежения запроса track_type=2, для рейса - track_type=3<br />
<br />
|-<br />
|<b>stop_station</b>||string||Снимать ли со слежения по прибытию на станцию назначения. "yes" - снимать, "no" - не снимать. Если указать <код ЕСР> - снимать по прибытию на станцию с кодом <код ЕСР>. Код ЕСР - 5-и значный код станции согласно Единой Сетевой Разметке (ЕСР). <br />
<br />
|-<br />
|<b>times</b>||string||Время обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Формат: "H:i", через запятую. Например: "09:00,13:00,18:00". Время московское. <br />
<br />
|-<br />
|<b>times_per_day</b>||string||Количество обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Если указано, что times меньше times_per_day, то times имеет больший приоритет. Например, times_per_day="2", a times="09:00,13:00,18:00", то отчет будет сформирован только в первое время и второе время, т.е. в 09:00 и в 13:00.<br />
<br />
|-<br />
|<b>days</b>||string||Дни недели, по которым необходимо получать отчет, через запятую. Номера начинаются с нуля (Воскресенье) до 6 (Суббота). Например, если отчеты необходимы по будням, то days="1,2,3,4,5". <br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу в urlencode<br />
<br />
|-<br />
|emails||string||Список email-адресов, куда отправить отчет о дислокации после выполнения, через запятую.<br />
<br />
|-<br />
|email_report_type||int||Всегда 2<br />
<br />
|-<br />
|attach_excel||int||Вкладывать ли в письма копию отчета в Excel. 1 - вкладывать, 0 - не вкладывать. По умолчанию 0.<br />
<br />
|}<br />
<br />
==Пример постановки на слежение==<br />
Контейнер AMFU8899067, получение инфорамции по будням дням (days=1,2,3,4,5) в 09:00 и 13:00 по московскому времени (times=09:00,13:00 и times_per_day=2), регион - только РФ (track_state=ru, state=20) без снятия со слежения по прибытии на станцию назначения (stop_station=no, т.е. ручное снятие), адреса для рассылки отчетов alta@alta.ru,mymail@mymail.com (emails=alta@alta.ru,mymail@mymail.com):<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&wagons=AMFU8899067&state=20&track_type=2&comment=%D0%BF%D0%B5%D1%80%D0%B2%D0%BE%D0%B5+%D1%81%D0%BB%D0%B5%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5+%28%D0%BA%D0%BE%D0%BD%D1%82%29&days=1,2,3,4,5&times_per_day=2&times=09:00,13:00&track_state=ru&stop_station=no&emails=alta@alta.ru,mymail@mymail.com<br />
<br><br />
JSON-ответ включает в себя отчет о состоянии запроса на слежение (поставлен/не поставлен на слежение) и hash, по которому можно получить ответ.<br><br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"cont_hash": "931700e35d7ff88a10bd5d680da50f02"<br />
}<br />
]<br />
</source><br />
<br />
При постановке вагона на слежение получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c"<br />
}<br />
]<br />
</source><br />
<br />
Поля hash и cont_hash можно использовать для получения <b>текущей</b> дислокации (согласно расписанию).<br />
<br />
==Получение ответа на ПС, стоящих на слежении. Метод "show". ==<br />
После размещения запроса он встает в очередь на обработку. В обозначенный момент времени (по расписанию) запрос выполняется. Обычно обработка запроса на слежение занимает около 1 минуты. В случае повышенной нагрузки на сервер обработка может занимать до 5 минут и более. <br><br />
Оптимальный период опроса сервера - 1 минута. В случае частых запросов ООО "Альта-Софт" оставляет за собой право заблокировать такие запросы и отказать в обслуживании. <br><br />
Для получение последней дислокации необходимо вызвать метод "show". <br><br><br />
Например, для получения дислокации контейнера AMFU8899067: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=show&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
==Снятие со слежения. Метод cancel_track.==<br />
<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||cancel_track - снятие со слежения запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например, ebc356dfa5beee7d3844ccacf535410c<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. В случае указания списка со слежения будут сняты только те ПС, которые в нем указаны, а не весь запрос. Например, "54676515"<br />
<br />
|}<br />
<br />
== Пример снятия со слежения==<br />
Снять со слежения вагон 54676515 из запроса с hash ebc356dfa5beee7d3844ccacf535410c<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=ebc356dfa5beee7d3844ccacf535410c&wagons=54676515<br />
<br />
Снять со слежения '''весь''' (т.е. все перевозочные средства из запроса) запрос с hash 931700e35d7ff88a10bd5d680da50f02<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Обратите внимание, что для тестовых данных ответ на запрос снятия со слежения будет "успешно", однако фактически запросы останутся на слежении.<br />
<br />
== Получение списка запросов на слежении. Метод "track_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||track_list - список запросов, стоящих на слежении<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=track_list&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"name": "первое слежение",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c",<br />
"modify_date": "29.07.2021 21:52",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
},<br />
{<br />
"name": "первое слежение (конт)",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "931700e35d7ff88a10bd5d680da50f02",<br />
"modify_date": "03.08.2021 13:10",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу<br />
<br />
|-<br />
|vagon_count||string||Количество ПС в запросе<br />
<br />
|-<br />
|email||string||Адреса электронной почты для рассылки отчетов о дислокации, через запятую.<br />
<br />
|-<br />
|hash||string||Hash запроса.<br />
<br />
|-<br />
|modify_date||string||Дата последнего изменения/выполнения запроса.<br />
<br />
|-<br />
|on_track||string||Стоит ли запрос на слежении. 1 - стоит, 0 - снят.<br />
<br />
|-<br />
|track_type||string||Тип слежения. 1 - постоянное, 2 - рейс. Обратите внимание, нумерация в данном случае отличае от таковой при постановке на слежение./<br />
<br />
|-<br />
|track_state||string||Регион слежения. ru - только РФ, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|state||string||Государство слежения. 20 - РФ, 22 - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|status||int||Статус обработки запроса. 1 - в очереди на обработку, 2 - обрабатывается, 3,4 - обработан<br />
<br />
|}<br />
<br />
== Получение списка ПС в запросе. Метод "carr_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||carr_list - список номеров перевозочных средств в запросе<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например 931700e35d7ff88a10bd5d680da50f02<br />
<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=carr_list&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"group_id": 1519743,<br />
"carrs": [<br />
"AMFU8899067"<br />
]<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|carrs||string||Массив номеров перевозочных средств в запросе<br />
<br />
|}<br />
<br />
== Получение баланса. Метод "balance"==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||balance - остаток денежных средств или бонусов на счету <br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=balance&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
Json-ответ<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Ваш баланс: 0.00 руб. / Бонусы 0",<br />
"balans": "0.00",<br />
"bonus": 0,<br />
"sa": "sa000000"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Остаток денежных средств/бонусов в текстовом виде<br />
<br />
|-<br />
|balans||string||Остаток денежных средств в рублях<br />
<br />
|-<br />
|bonus||string||Остаток бонусов<br />
<br />
|-<br />
|sa||string||Номер договора (сервис-аккаунта)<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1224JSON-API сервиса поиска вагонов2022-06-20T12:12:18Z<p>Boluchevskikh: </p>
<hr />
<div>==О сервисе==<br />
JSON-API сервиса «Поиск вагонов» позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно ставить и снимать вагоны и контейнеры на слежение по СНГ, странам Балтии, Монголии и Китаю.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET или POST. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса для поиска вагонов - всегда '''rail_tracking'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5('alta_test')") = 5ec1514f1b5a383fc5ad3f04bb9ac0e3 <br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих номеров: <br><br />
вагоны - 54676515 <br><br />
контейнеры - AMFU8899067 <br><br />
<br />
Hash для получения ответов по вагонам:<br />
- слежение ebc356dfa5beee7d3844ccacf535410c <br><br />
Cont_hash для получения ответов по контейнерам:<br />
- слежение 931700e35d7ff88a10bd5d680da50f02 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом эелементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о дислокации, список вагонов и проч.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}<br />
<br />
==Постановка вагонов/контейнеров на слежение. Метод "add".==<br />
Постановка на слежение выполняется с помощью метода "add". <br><br />
<br />
Обращаем внимание, что в связи с особенностями работы системы слежения получение первого отчета с актуальными данными возможно не ранее 2-3 часов с момента постановкии на слежение.<br />
В противном случае могут прийти устаревшие данные (или не прийти вовсе). Особенно это характерно для контейнеров<br />
Например:<br />
На слежение был поставлен контейнер в начале рабочего дня в 09:00. Время обновления данных: 09:30, 14:30 и 17:30.<br />
В 09:30 этого же дня с высокой долей вероятности будут получены неактуальные (устаревшие) данные или данных не будет. В 14:30 и 17:30 будут получены уже актуализированные отчеты.<br />
Все последующие сутки актуальные отчеты будут приходить в любое из указанного в расписании время, т.е. и в 09:30 следующих суток уже придут свежие данные. <br/><br />
<br />
Существует несколько регионов слежения: РФ, СНГ и Балтия, СНГ и Балтия + Китай + Монголия. Ниже описаны основные особенности:<br><br />
- При слежении первый ответ (обновление) может формироваться довольно продолжительное время: от 2-3 часов по РФ до суток по странам Средней Азии и Китаю. <br />
- В течение суток можно получить до 3-х обновлений дислокации за одну цену.<br />
- Стоимость слежения по РФ значительно ниже слежения по другим регионам. Однако, в случае пересечения перевозочного средства границы нет никаких гарантий, что свежая информация продолжит поступать.<br />
- Слежение по СНГ и Балтии, Китаю и Монголии позволяет получать дислокацию по всем перечисленным регионам, независимо от того, где находится ПС<br />
- При постановке ПС на слежение задается регламент получения отчетов - в какой день недели и какое время удобно получать свежую информацию, а также способ снятия со слежения (ручной или автоматический)<br />
- Существуют 2 типа слежения: посуточное и рейс. Единственное отличие между ними - в способе тарификации. Посуточное слежение - это такой тип слежения, когда денежные средства списываются со счета клиента при очередном формировании отчета (т.е. первом отчете за сутки согласно расписанию). Рейс тарифицируется сразу за весь маршрут при постановке на слежение и нет необходимости следить за состоянием баланса.<br />
- Для слежения информация по hash будет постоянно обновляться до окончания слежения. <br />
Ниже приводится полный список входных параметров. Жирным шрифтом отмечены те из них, которых или нет в оперативном запросе, или их значению следует уделить внимание при постановке на слежение:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||add - добавление оперативного запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067"<br />
<br />
|-<br />
|<b>state</b>||string||Код страны, по которой осуществляется запрос. Для РФ - 20. По странам СНГ и Балтии, Монголии, Китаю - 22.<br />
<br />
|-<br />
|<b>track_state</b>||string||Регион слежения. ru - только Россия, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|<b>track_type</b>||int||Тип слежения. Для посуточного слежения запроса track_type=2, для рейса - track_type=3<br />
<br />
|-<br />
|<b>stop_station</b>||string||Снимать ли со слежения по прибытию на станцию назначения. "yes" - снимать, "no" - не снимать. Если указать <код ЕСР> - снимать по прибытию на станцию с кодом <код ЕСР>. Код ЕСР - 5-и значный код станции согласно Единой Сетевой Разметке (ЕСР). <br />
<br />
|-<br />
|<b>times</b>||string||Время обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Формат: "H:i", через запятую. Например: "09:00,13:00,18:00". Время московское. <br />
<br />
|-<br />
|<b>times_per_day</b>||string||Количество обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Если указано, что times меньше times_per_day, то times имеет больший приоритет. Например, times_per_day="2", a times="09:00,13:00,18:00", то отчет будет сформирован только в первое время и второе время, т.е. в 09:00 и в 13:00.<br />
<br />
|-<br />
|<b>days</b>||string||Дни недели, по которым необходимо получать отчет, через запятую. Номера начинаются с нуля (Воскресенье) до 6 (Суббота). Например, если отчеты необходимы по будням, то days="1,2,3,4,5". <br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу в urlencode<br />
<br />
|-<br />
|emails||string||Список email-адресов, куда отправить отчет о дислокации после выполнения, через запятую.<br />
<br />
|-<br />
|email_report_type||int||Всегда 2<br />
<br />
|-<br />
|attach_excel||int||Вкладывать ли в письма копию отчета в Excel. 1 - вкладывать, 0 - не вкладывать. По умолчанию 0.<br />
<br />
|}<br />
<br />
==Пример постановки на слежение==<br />
Контейнер AMFU8899067, получение инфорамции по будням дням (days=1,2,3,4,5) в 09:00 и 13:00 по московскому времени (times=09:00,13:00 и times_per_day=2), регион - только РФ (track_state=ru, state=20) без снятия со слежения по прибытии на станцию назначения (stop_station=no, т.е. ручное снятие), адреса для рассылки отчетов alta@alta.ru,mymail@mymail.com (emails=alta@alta.ru,mymail@mymail.com):<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&wagons=AMFU8899067&state=20&track_type=2&comment=%D0%BF%D0%B5%D1%80%D0%B2%D0%BE%D0%B5+%D1%81%D0%BB%D0%B5%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5+%28%D0%BA%D0%BE%D0%BD%D1%82%29&days=1,2,3,4,5&times_per_day=2&times=09:00,13:00&track_state=ru&stop_station=no&emails=alta@alta.ru,mymail@mymail.com<br />
<br><br />
JSON-ответ включает в себя отчет о состоянии запроса на слежение (поставлен/не поставлен на слежение) и hash, по которому можно получить ответ.<br><br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"cont_hash": "931700e35d7ff88a10bd5d680da50f02"<br />
}<br />
]<br />
</source><br />
<br />
При постановке вагона на слежение получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c"<br />
}<br />
]<br />
</source><br />
<br />
Поля hash и cont_hash можно использовать для получения <b>текущей</b> дислокации (согласно расписанию).<br />
<br />
==Получение ответа на ПС, стоящих на слежении. Метод "show". ==<br />
После размещения запроса он встает в очередь на обработку. В обозначенный момент времени (по расписанию) запрос выполняется. Обычно обработка запроса на слежение занимает около 1 минуты. В случае повышенной нагрузки на сервер обработка может занимать до 5 минут и более. <br><br />
Оптимальный период опроса сервера - 1 минута. В случае частых запросов ООО "Альта-Софт" оставляет за собой право заблокировать такие запросы и отказать в обслуживании. <br><br />
Для получение последней дислокации необходимо вызвать метод "show". <br><br><br />
Например, для получения дислокации контейнера AMFU8899067: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=show&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
==Снятие со слежения. Метод cancel_track.==<br />
<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||cancel_track - снятие со слежения запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например, ebc356dfa5beee7d3844ccacf535410c<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. В случае указания списка со слежения будут сняты только те ПС, которые в нем указаны, а не весь запрос. Например, "54676515"<br />
<br />
|}<br />
<br />
== Пример снятия со слежения==<br />
Снять со слежения вагон 54676515 из запроса с hash ebc356dfa5beee7d3844ccacf535410c<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=ebc356dfa5beee7d3844ccacf535410c&wagons=54676515<br />
<br />
Снять со слежения '''весь''' (т.е. все перевозочные средства из запроса) запрос с hash 931700e35d7ff88a10bd5d680da50f02<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Обратите внимание, что для тестовых данных ответ на запрос снятия со слежения будет "успешно", однако фактически запросы останутся на слежении.<br />
<br />
== Получение списка запросов на слежении. Метод "track_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||track_list - список запросов, стоящих на слежении<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=track_list&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"name": "первое слежение",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c",<br />
"modify_date": "29.07.2021 21:52",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
},<br />
{<br />
"name": "первое слежение (конт)",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "931700e35d7ff88a10bd5d680da50f02",<br />
"modify_date": "03.08.2021 13:10",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу<br />
<br />
|-<br />
|vagon_count||string||Количество ПС в запросе<br />
<br />
|-<br />
|email||string||Адреса электронной почты для рассылки отчетов о дислокации, через запятую.<br />
<br />
|-<br />
|hash||string||Hash запроса.<br />
<br />
|-<br />
|modify_date||string||Дата последнего изменения/выполнения запроса.<br />
<br />
|-<br />
|on_track||string||Стоит ли запрос на слежении. 1 - стоит, 0 - снят.<br />
<br />
|-<br />
|track_type||string||Тип слежения. 1 - постоянное, 2 - рейс. Обратите внимание, нумерация в данном случае отличае от таковой при постановке на слежение./<br />
<br />
|-<br />
|track_state||string||Регион слежения. ru - только РФ, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|state||string||Государство слежения. 20 - РФ, 22 - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|status||int||Статус обработки запроса. 1 - в очереди на обработку, 2 - обрабатывается, 3,4 - обработан<br />
<br />
|}<br />
<br />
== Получение списка ПС в запросе. Метод "carr_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||carr_list - список номеров перевозочных средств в запросе<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например 931700e35d7ff88a10bd5d680da50f02<br />
<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=carr_list&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"group_id": 1519743,<br />
"carrs": [<br />
"AMFU8899067"<br />
]<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|carrs||string||Массив номеров перевозочных средств в запросе<br />
<br />
|}<br />
<br />
== Получение баланса. Метод "balance"==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||balance - остаток денежных средств или бонусов на счету <br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=balance&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
Json-ответ<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Ваш баланс: 0.00 руб. / Бонусы 0",<br />
"balans": "0.00",<br />
"bonus": 0,<br />
"sa": "sa000000"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Остаток денежных средств/бонусов в текстовом виде<br />
<br />
|-<br />
|balans||string||Остаток денежных средств в рублях<br />
<br />
|-<br />
|bonus||string||Остаток бонусов<br />
<br />
|-<br />
|sa||string||Номер договора (сервис-аккаунта)<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1223JSON-API сервиса поиска вагонов2022-06-20T12:09:16Z<p>Boluchevskikh: </p>
<hr />
<div>==О сервисе==<br />
JSON-API сервиса «Поиск вагонов» позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно ставить и снимать вагоны и контейнеры на слежение по СНГ, странам Балтии, Монголии и Китаю.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET или POST. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса для поиска вагонов - всегда '''rail_tracking'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5('alta_test')") = 5ec1514f1b5a383fc5ad3f04bb9ac0e3 <br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих номеров: <br><br />
вагоны - 54676515 <br><br />
контейнеры - AMFU8899067 <br><br />
<br />
Hash для получения ответов по вагонам:<br />
- слежение ebc356dfa5beee7d3844ccacf535410c <br><br />
Cont_hash для получения ответов по контейнерам:<br />
- слежение 931700e35d7ff88a10bd5d680da50f02 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом эелементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о дислокации, список вагонов и проч.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}<br />
<br />
==Постановка вагонов/контейнеров на слежение. Метод "add".==<br />
Постановка на слежение выполняется с помощью метода "add". <br><br />
Существует несколько регионов слежения: РФ, СНГ и Балтия, СНГ и Балтия + Китай + Монголия. Ниже описаны основные особенности:<br><br />
- При слежении первый ответ (обновление) может формироваться довольно продолжительное время: от 2-3 часов по РФ до суток по странам Средней Азии и Китаю. <br />
- В течение суток можно получить до 3-х обновлений дислокации за одну цену.<br />
- Стоимость слежения по РФ значительно ниже слежения по другим регионам. Однако, в случае пересечения перевозочного средства границы нет никаких гарантий, что свежая информация продолжит поступать.<br />
- Слежение по СНГ и Балтии, Китаю и Монголии позволяет получать дислокацию по всем перечисленным регионам, независимо от того, где находится ПС<br />
- При постановке ПС на слежение задается регламент получения отчетов - в какой день недели и какое время удобно получать свежую информацию, а также способ снятия со слежения (ручной или автоматический)<br />
- Существуют 2 типа слежения: посуточное и рейс. Единственное отличие между ними - в способе тарификации. Посуточное слежение - это такой тип слежения, когда денежные средства списываются со счета клиента при очередном формировании отчета (т.е. первом отчете за сутки согласно расписанию). Рейс тарифицируется сразу за весь маршрут при постановке на слежение и нет необходимости следить за состоянием баланса.<br />
- Для слежения информация по hash будет постоянно обновляться до окончания слежения. <br />
Ниже приводится полный список входных параметров. Жирным шрифтом отмечены те из них, которых или нет в оперативном запросе, или их значению следует уделить внимание при постановке на слежение:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||add - добавление оперативного запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067"<br />
<br />
|-<br />
|<b>state</b>||string||Код страны, по которой осуществляется запрос. Для РФ - 20. По странам СНГ и Балтии, Монголии, Китаю - 22.<br />
<br />
|-<br />
|<b>track_state</b>||string||Регион слежения. ru - только Россия, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|<b>track_type</b>||int||Тип слежения. Для посуточного слежения запроса track_type=2, для рейса - track_type=3<br />
<br />
|-<br />
|<b>stop_station</b>||string||Снимать ли со слежения по прибытию на станцию назначения. "yes" - снимать, "no" - не снимать. Если указать <код ЕСР> - снимать по прибытию на станцию с кодом <код ЕСР>. Код ЕСР - 5-и значный код станции согласно Единой Сетевой Разметке (ЕСР). <br />
<br />
|-<br />
|<b>times</b>||string||Время обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Формат: "H:i", через запятую. Например: "09:00,13:00,18:00". Время московское. <br />
<br />
|-<br />
|<b>times_per_day</b>||string||Количество обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Если указано, что times меньше times_per_day, то times имеет больший приоритет. Например, times_per_day="2", a times="09:00,13:00,18:00", то отчет будет сформирован только в первое время и второе время, т.е. в 09:00 и в 13:00.<br />
<br />
|-<br />
|<b>days</b>||string||Дни недели, по которым необходимо получать отчет, через запятую. Номера начинаются с нуля (Воскресенье) до 6 (Суббота). Например, если отчеты необходимы по будням, то days="1,2,3,4,5". <br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу в urlencode<br />
<br />
|-<br />
|emails||string||Список email-адресов, куда отправить отчет о дислокации после выполнения, через запятую.<br />
<br />
|-<br />
|email_report_type||int||Всегда 2<br />
<br />
|-<br />
|attach_excel||int||Вкладывать ли в письма копию отчета в Excel. 1 - вкладывать, 0 - не вкладывать. По умолчанию 0.<br />
<br />
|}<br />
<br />
==Пример постановки на слежение==<br />
Контейнер AMFU8899067, получение инфорамции по будням дням (days=1,2,3,4,5) в 09:00 и 13:00 по московскому времени (times=09:00,13:00 и times_per_day=2), регион - только РФ (track_state=ru, state=20) без снятия со слежения по прибытии на станцию назначения (stop_station=no, т.е. ручное снятие), адреса для рассылки отчетов alta@alta.ru,mymail@mymail.com (emails=alta@alta.ru,mymail@mymail.com):<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&wagons=AMFU8899067&state=20&track_type=2&comment=%D0%BF%D0%B5%D1%80%D0%B2%D0%BE%D0%B5+%D1%81%D0%BB%D0%B5%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5+%28%D0%BA%D0%BE%D0%BD%D1%82%29&days=1,2,3,4,5&times_per_day=2&times=09:00,13:00&track_state=ru&stop_station=no&emails=alta@alta.ru,mymail@mymail.com<br />
<br><br />
JSON-ответ включает в себя отчет о состоянии запроса на слежение (поставлен/не поставлен на слежение) и hash, по которому можно получить ответ.<br><br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"cont_hash": "931700e35d7ff88a10bd5d680da50f02"<br />
}<br />
]<br />
</source><br />
<br />
При постановке вагона на слежение получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c"<br />
}<br />
]<br />
</source><br />
<br />
Поля hash и cont_hash можно использовать для получения <b>текущей</b> дислокации (согласно расписанию).<br />
<br />
==Получение ответа на ПС, стоящих на слежении. Метод "show". ==<br />
После размещения запроса он встает в очередь на обработку. В обозначенный момент времени (по расписанию) запрос выполняется. Обычно обработка запроса на слежение занимает около 1 минуты. В случае повышенной нагрузки на сервер обработка может занимать до 5 минут и более. <br><br />
Оптимальный период опроса сервера - 1 минута. В случае частых запросов ООО "Альта-Софт" оставляет за собой право заблокировать такие запросы и отказать в обслуживании. <br><br />
Для получение последней дислокации необходимо вызвать метод "show". <br><br><br />
Например, для получения дислокации контейнера AMFU8899067: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=show&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
==Снятие со слежения. Метод cancel_track.==<br />
<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||cancel_track - снятие со слежения запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например, ebc356dfa5beee7d3844ccacf535410c<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. В случае указания списка со слежения будут сняты только те ПС, которые в нем указаны, а не весь запрос. Например, "54676515"<br />
<br />
|}<br />
<br />
== Пример снятия со слежения==<br />
Снять со слежения вагон 54676515 из запроса с hash ebc356dfa5beee7d3844ccacf535410c<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=ebc356dfa5beee7d3844ccacf535410c&wagons=54676515<br />
<br />
Снять со слежения '''весь''' (т.е. все перевозочные средства из запроса) запрос с hash 931700e35d7ff88a10bd5d680da50f02<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Обратите внимание, что для тестовых данных ответ на запрос снятия со слежения будет "успешно", однако фактически запросы останутся на слежении.<br />
<br />
== Получение списка запросов на слежении. Метод "track_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||track_list - список запросов, стоящих на слежении<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=track_list&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"name": "первое слежение",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c",<br />
"modify_date": "29.07.2021 21:52",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
},<br />
{<br />
"name": "первое слежение (конт)",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "931700e35d7ff88a10bd5d680da50f02",<br />
"modify_date": "03.08.2021 13:10",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу<br />
<br />
|-<br />
|vagon_count||string||Количество ПС в запросе<br />
<br />
|-<br />
|email||string||Адреса электронной почты для рассылки отчетов о дислокации, через запятую.<br />
<br />
|-<br />
|hash||string||Hash запроса.<br />
<br />
|-<br />
|modify_date||string||Дата последнего изменения/выполнения запроса.<br />
<br />
|-<br />
|on_track||string||Стоит ли запрос на слежении. 1 - стоит, 0 - снят.<br />
<br />
|-<br />
|track_type||string||Тип слежения. 1 - постоянное, 2 - рейс. Обратите внимание, нумерация в данном случае отличае от таковой при постановке на слежение./<br />
<br />
|-<br />
|track_state||string||Регион слежения. ru - только РФ, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|state||string||Государство слежения. 20 - РФ, 22 - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|status||int||Статус обработки запроса. 1 - в очереди на обработку, 2 - обрабатывается, 3,4 - обработан<br />
<br />
|}<br />
<br />
== Получение списка ПС в запросе. Метод "carr_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||carr_list - список номеров перевозочных средств в запросе<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например 931700e35d7ff88a10bd5d680da50f02<br />
<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=carr_list&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"group_id": 1519743,<br />
"carrs": [<br />
"AMFU8899067"<br />
]<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|carrs||string||Массив номеров перевозочных средств в запросе<br />
<br />
|}<br />
<br />
== Получение баланса. Метод "balance"==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||balance - остаток денежных средств или бонусов на счету <br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=balance&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
Json-ответ<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Ваш баланс: 0.00 руб. / Бонусы 0",<br />
"balans": "0.00",<br />
"bonus": 0,<br />
"sa": "sa000000"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Остаток денежных средств/бонусов в текстовом виде<br />
<br />
|-<br />
|balans||string||Остаток денежных средств в рублях<br />
<br />
|-<br />
|bonus||string||Остаток бонусов<br />
<br />
|-<br />
|sa||string||Номер договора (сервис-аккаунта)<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1222API сервиса поиска вагонов2022-06-20T11:19:50Z<p>Boluchevskikh: </p>
<hr />
<div><b style="color:red"> !!Внимание!! <br />
Данный протокол более не поддерживается. Используйте API-интерфейс по следующему описанию:<br />
<br />
REST-JSON API: [https://wiki.alta.ru/index.php/JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2]<br />
</b><br />
<br />
==Описание протокола обмена данными с системой поиска вагонов от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http, транспорт xml. Все запросы в системе – POST. </b><br />
<br />
===1) Выполнение запроса на поиск вагона или контейнера.===<br />
На адрес [https://ww.alta.ru/rail_tracking/api_v1.php https://www.alta.ru/rail_tracking/api_v1.php] нужно послать xml-строку следующего формата:<br />
<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<query><br />
<login>your_login</login><br />
<password>your_password</password><br />
<action>add</action><br />
<type>1|2</type><br />
<state>20</state><br />
<name>My query</name><br />
<vag num=”some_num_1”/><br />
<vag num=”some_num_2”/><br />
….<br />
<vag num=”some_num_n” /><br />
</query><br />
</root><br />
</syntaxhighlight><br />
Где:<br /><br />
login и password – учетные данные, выданные при регистрации личного кабинета<br /><br />
action – [add|get] – добавление запроса на поиск (add) или получение ответа по добавленному ранее запросу (get) <br /><br />
type – [1|2] 1 - запрос на поиск вагонов, 2 – запрос на поиск контейнеров<br /><br />
state – необязательный параметр, код государства запроса, для России всегда 20<br /><br />
name – необязательный параметр, произвольный идентификатор запроса, он будет отображаться в личном кабинете на alta.ru при просмотре через web-интерфейс <br /><br />
vag – список вагонов для выполнения поиска, где атрибут num – собственно номер вагона или контейнера.<br /><br />
<b>В одном запросе не допускается включать номера перевозочных средств разных типов, т.е. в запросе должны быть либо номера только вагонов, либо номера только контейнеров (в соответствии с заданным type).</b><br />
<br />
В ответ система выдаст xml следующего содержания: <br /><br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status code="result_code" descr="Result_descr">ok|error</status><br />
<hash>your_query_hash</hash><br />
</response> <br />
</root><br />
</syntaxhighlight><br />
Где:<br />
Status – [ok|error], статус запроса, ok – выполнен успешно, error – возникла ошибка. <br /><br />
При успешном завершении выполнения запроса атрибут code всегда равен нулю, при возникновении ошибки code = [50|60|70|100], в атрибуте descr – текстовое описание ошибки.<br /><br />
Коды ошибок: <br /><br />
50 – Не указан список вагонов/контейнеров<br /><br />
60, 70 – зарезервировано<br /><br />
91 – ошибка соединения с базой<br /><br />
92 – Неверный логин/пароль<br /><br />
93 – Аккаунт не активирован<br /><br />
94 – Неизвестная ошибка<br /><br />
95 – Указанное действие не поддерживается<br /><br />
96 - Дубликат запроса, действие отменено. Выполнить запрос с такими же параметрами можно через 3 минуты <br /><br />
97 - Данному пользователю разрешено размещать запросы только по РФ <br /><br />
100 – Недостаточно денег на балансе для выполнения запросов<br /><br />
Hash - в случае успеха добавляется элемент hash, содержащий уникальный идентификатор запроса, по которому можно будет получить ответ, содержащий информацию по дислокации перевозочных средств.<br /><br />
<br />
===2) Получение результата запроса.===<br />
Не ранее чем через 1 минуту после добавления запроса, по адресу http://www.alta.ru/rail_tracking/api_v1.php можно выполнить xml-запрос на получение результата. Содержание xml-строки:<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<query><br />
<login>your_login</login><br />
<password>your_password</password><br />
<action>get</action><br />
<hash>your_query_hash</hash><br />
</query><br />
</root><br />
</syntaxhighlight><br />
Где:<br />
login и password – учетные данные, выданные при регистрации личного кабинета<br /><br />
action – [get] получение ответа по добавленному ранее запросу (get)<br /><br />
hash – уникальный идентификатор, полученный при добавлении запроса на выполнение<br /><br />
<br />
В ответ система выдаст xml следующего содержания:<br /><br />
<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status code="result_code" descr="Result_descr">1|2|3|4|error</status><br />
<vag num=”some_num_1” [атрибуты, см. далее описание] /><br />
<vag num=”some_num_2” [атрибуты, см. далее описание] /><br />
….<br />
<vag num=”some_num_n” [атрибуты, см. далее описание] /><br />
</response><br />
</root><br />
</syntaxhighlight><br />
Где: <br /> <br />
Status=error – если возникла ошибка или от «1» до «4» – состояние запроса. В атрибуте code всегда ноль при успешной обработке запроса или код ошибки. Descr – текстовое описание ошибки или состояния запроса. <br /><br />
Коды состояния status:<br /><br /><br />
1 – в очереди на обработку<br /><br />
2 – обрабатывается<br /><br />
3 – частично обработан (получены данные не по всем перевозочным средствам)<br /><br />
4 – полностью обработан <br /><br /><br />
Коды ошибок code:<br /><br />
30 – запрос с указанным hash отсутствует (не формировался)<br /><br />
40 – ошибка при запросе к базе<br /><br />
91 – ошибка соединения с базой<br /><br />
92 – Неверный логин/пароль<br /><br />
93 – Аккаунт не активирован<br /><br />
94 – Неизвестная ошибка<br /><br />
95 – Указанное действие не поддерживается<br /><br />
100 – Недостаточно денег на балансе для выполнения запросов<br /><br />
<br />
При status=3 или status=4 xml-ответ дополняется элементами vag, содержащими информацию по дислокации перевозочных средств. Ниже даны описания атрибутов:<br /><br />
num – номер запрошенного вагона/контейнера<br /><br />
station – ecp-код станции<br /><br />
op_date – дата операции<br /><br />
station_name – наименование станции<br /><br />
lon и lat – широта и долгота станции (если есть в базе)<br /><br />
state – код государства станции<br /><br />
state_name – наименование государства станции<br /><br />
road_name – дорога станции<br /><br />
operation – операции, совершенная на станции с поездом<br /><br />
okpo – ОКПО собственника перевозочного средства<br /><br />
owner – наименование собственника перевозочного средства (если доступно)<br /><br />
kgro и kgrp – коды грузоотправителя и грузополучателя<br /><br />
train_index – индекс поезда<br /><br />
train_number – номер поезда<br /><br />
freight – код груза ЕТСНГ<br /><br />
freight_name – наименование груза ЕТСНГ<br /><br />
weight – масса груза в центнерах<br /><br />
vag_number – только для контейнеров, номер вагона, на котором размещен контейнер<br /><br />
rasst – расстояние, оставшееся до станции назначения<br /><br />
<br />
<b>Пример ответа:</b><br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status descr="Обработан" code="0">4</status><br />
<vag num="54922810" station="19380" station_name="Перово" lon="37.764368" lat ="55.735818" state="20" state_name="Россия" road_name="Московская" op_date="2013-10-14 21:57:00" operation="РАСФОРМИРОВАНИЕ ПОЕЗДА" okpo="87556235" owner="ООО &quot;ИМПРОМ&quot;" kgro="0" kgrp="9999" train_index="0" train_number="0" freight="42110" freight_name="Платформы железнодорожные, перевозимые на своих осях" weight="0" vag_number="" rasst="76" /><br />
<vag num="54973847" station="98380" station_name="Партизанск" lon="133.143368" lat ="43.06927" state="20" state_name="Россия" road_name="Дальневосточная" op_date="2013-10-16 13:44:00" operation="ПРОСЛ.ПОЕЗ.&quot;&quot;НАШЕЙ&quot;&quot; СТ.Б/ОСТ(БЕЗ ПР./СД. НА ДР.ДОР)" okpo="62716542" owner="ООО &quot;Репетек&quot;" kgro="6856" kgrp="0032" train_index="9859004123050" train_number="1297" freight="300" freight_name="" weight="250" vag_number="" rasst="9232" /><br />
<vag num="67770560" station="29300" station_name="Коноша I" lon="40.247064" lat ="60.974297" state="20" state_name="Россия" road_name="Северная" op_date="2013-10-15 23:18:00" operation="БРОСАНИЕ ПОЕЗДА НА СТАНЦИИ" okpo="68398528" owner="ОАО [ВГКk" kgro="5194" kgrp="2865" train_index="100016123700" train_number="2301" freight="23205" freight_name="Габбро" weight="690" vag_number="" rasst="732" /><br />
</response><br />
</root><br />
</syntaxhighlight><br />
<br />
===3) Запрос баланса===<br />
На адрес http://www.alta.ru/rail_tracking/api_v1.php выполнить xml-запрос на получение баланса. Содержание xml-строки:<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<query><br />
<login>your_login</login><br />
<password>your_password</password><br />
<action>balans</action><br />
</query><br />
</root><br />
</syntaxhighlight><br />
<br />
В ответ получите xml, содержащую баланс на момент запроса.<br /><br />
Пример ответа:<br /><br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status descr="Обработан" code="0">ok</status> <br />
<balans>[остаток на счете на момент запроса в рублях]</balans><br />
</response><br />
</root><br />
</syntaxhighlight><br />
Status=error – если возникла ошибка. В атрибуте code всегда ноль при успешной обработке запроса или код ошибки. <br /><br />
Descr – текстовое описание ошибки или состояния запроса. <br /><br /><br />
Коды ошибок code:<br /><br />
91 – ошибка соединения с базой<br /><br />
92 – Неверный логин/пароль<br /><br />
93 – Аккаунт не активирован<br /><br />
94 – Неизвестная ошибка<br /><br />
95 – Указанное действие не поддерживается<br /><br />
<br />
===Примеры запросов для языка PHP.===<br />
====1) Запрос на поиск (add_query_example.php)====<br />
<br />
<br />
<?php<br />
<br />
<syntaxhighlight lang="php"> <br />
function post_data($url, $params, $timeout = 5)<br />
{<br />
$opts = array('http' => array( 'method' => 'POST', 'header' => 'Content-type: application/x-www-form-urlencoded', 'content' => $params, 'timeout' => $timeout ) );<br />
$context = stream_context_create($opts);<br />
$result = file_get_contents($url, false, $context);<br />
return $result;<br />
}<br />
<br />
$login = 'your_login';<br />
$pass = 'your_password';<br />
$xml_str = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>";<br />
$xml_str .= "<root><query><login>$login</login><password>$pass</password>";<br />
$xml_str .= "<action>add</action>";<br />
$xml_str .= '<vag num="54532312"/>';<br />
$xml_str .= '<vag num="54563036"/>';<br />
$xml_str .= '<vag num="59616896"/>';<br />
$xml_str .= '<state>20</state>';<br />
$xml_str .= '<type>1</type>';<br />
$xml_str .= '<name>Пример запроса</name>';<br />
$xml_str .= "</query></root>";<br />
$result = post_data("http://www.alta.ru/rail_tracking/api_v1.php", $xml_str, 5);<br />
<br />
$xml = simplexml_load_string($result);<br />
<br />
$status = $xml->response->status;<br />
<br />
echo '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';<br />
<br />
if ($status == 'ok')<br />
{<br />
echo "Результат: ".$status['descr'];<br />
echo "<br/>";<br />
echo "Идентификатор запроса: ".$xml->response->hash;<br />
}<br />
else<br />
{<br />
echo "Результат: ".$status['descr'];<br />
echo "<br/>";<br />
echo "Код ошибки: ".$status['code'];<br />
} <br />
<br />
?><br />
<br />
</syntaxhighlight><br />
<br />
====2) Запрос на получение ответа (get_response_example.php)====<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
<br />
function post_data($url, $params, $timeout = 5)<br />
{<br />
$opts = array('http' => array( 'method' => 'POST', 'header' => 'Content-type: application/x-www-form-urlencoded', 'content' => $params, 'timeout' => $timeout ) );<br />
$context = stream_context_create($opts);<br />
$result = file_get_contents($url, false, $context);<br />
return $result;<br />
}<br />
<br />
$login = 'your_login';<br />
$pass = 'your_password';<br />
$xml_str = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>";<br />
$xml_str .= "<root><query><login>$login</login><password>$pass</password>";<br />
$xml_str .= "<action>get</action>";<br />
$xml_str .= '<hash>c4cf2a16090153f078ea263acab1a6d8</hash>';<br />
$xml_str .= "</query></root>";<br />
$result = post_data("http://www.alta.ru/rail_tracking/api_v1.php", $xml_str, 5);<br />
<br />
$xml = simplexml_load_string($result);<br />
<br />
$status = $xml->response->status;<br />
<br />
echo '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';<br />
<br />
if ($status != 'error')<br />
{<br />
echo "Статус запроса: ".$status['descr'];<br />
echo "<hr/>";<br />
foreach ($xml->xpath('/root/response/vag') as $vag)<br />
{<br />
echo "Станция: ".$vag['station'].' '.$vag['station_name']."<br/>";<br />
echo "Координаты станции: ".$vag['lon'].' '.$vag['lat'].'<br/>';<br />
echo "Дата: ".$vag['op_date']."<br/>";<br />
echo "Операция: ".$vag['operation']."<br/>";<br />
echo "ОКПО собственника: ".$vag['okpo'].' '.$vag['owner'].'<br/>';<br />
echo "<hr/>";<br />
}<br />
}<br />
else<br />
{<br />
echo "Результат: ".$status['descr'];<br />
echo "<br/>";<br />
echo "Код ошибки: ".$status['code'];<br />
} <br />
<br />
?><br />
<br />
</syntaxhighlight><br />
<br />
<br />
Все действия, производимые через api видны и в web-интерфейсе системы (на закладках «в обработке» и «отчеты»)<br />
<br />
===Тестирования сервиса===<br />
<br />
Для отладки взаимодействия сервиса поиска вагонов и учетной системы клиента существует возможность отправлять запросы и получать ответы, используя тестовые данные.<br /> Никаких платежей за использование тестовых данных не предусмотрено.<br /><br /><br />
<br />
Для тестирования сервиса используйте следующие данные:<br /><br />
login: test<br /><br />
password: test<br /><br />
Вы можете отправить запрос только на следующие номера перевозочных средств:<br /><br />
Вагоны: 54676515<br /><br />
Контейнеры: AMFU8899067<br />
<br />
[[Категория:Автоматизация]]<br />
[[Категория:Web-Сервисы]]</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1221API сервиса поиска вагонов2022-06-20T11:18:38Z<p>Boluchevskikh: </p>
<hr />
<div>!!Внимание!! <br />
Данный протокол более не поддерживается. Используйте API-интерфейс по следующему описанию:<br />
<br />
REST-JSON API: [https://wiki.alta.ru/index.php/JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2]<br />
<br />
==Описание протокола обмена данными с системой поиска вагонов от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http, транспорт xml. Все запросы в системе – POST. </b><br />
<br />
===1) Выполнение запроса на поиск вагона или контейнера.===<br />
На адрес [https://ww.alta.ru/rail_tracking/api_v1.php https://www.alta.ru/rail_tracking/api_v1.php] нужно послать xml-строку следующего формата:<br />
<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<query><br />
<login>your_login</login><br />
<password>your_password</password><br />
<action>add</action><br />
<type>1|2</type><br />
<state>20</state><br />
<name>My query</name><br />
<vag num=”some_num_1”/><br />
<vag num=”some_num_2”/><br />
….<br />
<vag num=”some_num_n” /><br />
</query><br />
</root><br />
</syntaxhighlight><br />
Где:<br /><br />
login и password – учетные данные, выданные при регистрации личного кабинета<br /><br />
action – [add|get] – добавление запроса на поиск (add) или получение ответа по добавленному ранее запросу (get) <br /><br />
type – [1|2] 1 - запрос на поиск вагонов, 2 – запрос на поиск контейнеров<br /><br />
state – необязательный параметр, код государства запроса, для России всегда 20<br /><br />
name – необязательный параметр, произвольный идентификатор запроса, он будет отображаться в личном кабинете на alta.ru при просмотре через web-интерфейс <br /><br />
vag – список вагонов для выполнения поиска, где атрибут num – собственно номер вагона или контейнера.<br /><br />
<b>В одном запросе не допускается включать номера перевозочных средств разных типов, т.е. в запросе должны быть либо номера только вагонов, либо номера только контейнеров (в соответствии с заданным type).</b><br />
<br />
В ответ система выдаст xml следующего содержания: <br /><br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status code="result_code" descr="Result_descr">ok|error</status><br />
<hash>your_query_hash</hash><br />
</response> <br />
</root><br />
</syntaxhighlight><br />
Где:<br />
Status – [ok|error], статус запроса, ok – выполнен успешно, error – возникла ошибка. <br /><br />
При успешном завершении выполнения запроса атрибут code всегда равен нулю, при возникновении ошибки code = [50|60|70|100], в атрибуте descr – текстовое описание ошибки.<br /><br />
Коды ошибок: <br /><br />
50 – Не указан список вагонов/контейнеров<br /><br />
60, 70 – зарезервировано<br /><br />
91 – ошибка соединения с базой<br /><br />
92 – Неверный логин/пароль<br /><br />
93 – Аккаунт не активирован<br /><br />
94 – Неизвестная ошибка<br /><br />
95 – Указанное действие не поддерживается<br /><br />
96 - Дубликат запроса, действие отменено. Выполнить запрос с такими же параметрами можно через 3 минуты <br /><br />
97 - Данному пользователю разрешено размещать запросы только по РФ <br /><br />
100 – Недостаточно денег на балансе для выполнения запросов<br /><br />
Hash - в случае успеха добавляется элемент hash, содержащий уникальный идентификатор запроса, по которому можно будет получить ответ, содержащий информацию по дислокации перевозочных средств.<br /><br />
<br />
===2) Получение результата запроса.===<br />
Не ранее чем через 1 минуту после добавления запроса, по адресу http://www.alta.ru/rail_tracking/api_v1.php можно выполнить xml-запрос на получение результата. Содержание xml-строки:<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<query><br />
<login>your_login</login><br />
<password>your_password</password><br />
<action>get</action><br />
<hash>your_query_hash</hash><br />
</query><br />
</root><br />
</syntaxhighlight><br />
Где:<br />
login и password – учетные данные, выданные при регистрации личного кабинета<br /><br />
action – [get] получение ответа по добавленному ранее запросу (get)<br /><br />
hash – уникальный идентификатор, полученный при добавлении запроса на выполнение<br /><br />
<br />
В ответ система выдаст xml следующего содержания:<br /><br />
<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status code="result_code" descr="Result_descr">1|2|3|4|error</status><br />
<vag num=”some_num_1” [атрибуты, см. далее описание] /><br />
<vag num=”some_num_2” [атрибуты, см. далее описание] /><br />
….<br />
<vag num=”some_num_n” [атрибуты, см. далее описание] /><br />
</response><br />
</root><br />
</syntaxhighlight><br />
Где: <br /> <br />
Status=error – если возникла ошибка или от «1» до «4» – состояние запроса. В атрибуте code всегда ноль при успешной обработке запроса или код ошибки. Descr – текстовое описание ошибки или состояния запроса. <br /><br />
Коды состояния status:<br /><br /><br />
1 – в очереди на обработку<br /><br />
2 – обрабатывается<br /><br />
3 – частично обработан (получены данные не по всем перевозочным средствам)<br /><br />
4 – полностью обработан <br /><br /><br />
Коды ошибок code:<br /><br />
30 – запрос с указанным hash отсутствует (не формировался)<br /><br />
40 – ошибка при запросе к базе<br /><br />
91 – ошибка соединения с базой<br /><br />
92 – Неверный логин/пароль<br /><br />
93 – Аккаунт не активирован<br /><br />
94 – Неизвестная ошибка<br /><br />
95 – Указанное действие не поддерживается<br /><br />
100 – Недостаточно денег на балансе для выполнения запросов<br /><br />
<br />
При status=3 или status=4 xml-ответ дополняется элементами vag, содержащими информацию по дислокации перевозочных средств. Ниже даны описания атрибутов:<br /><br />
num – номер запрошенного вагона/контейнера<br /><br />
station – ecp-код станции<br /><br />
op_date – дата операции<br /><br />
station_name – наименование станции<br /><br />
lon и lat – широта и долгота станции (если есть в базе)<br /><br />
state – код государства станции<br /><br />
state_name – наименование государства станции<br /><br />
road_name – дорога станции<br /><br />
operation – операции, совершенная на станции с поездом<br /><br />
okpo – ОКПО собственника перевозочного средства<br /><br />
owner – наименование собственника перевозочного средства (если доступно)<br /><br />
kgro и kgrp – коды грузоотправителя и грузополучателя<br /><br />
train_index – индекс поезда<br /><br />
train_number – номер поезда<br /><br />
freight – код груза ЕТСНГ<br /><br />
freight_name – наименование груза ЕТСНГ<br /><br />
weight – масса груза в центнерах<br /><br />
vag_number – только для контейнеров, номер вагона, на котором размещен контейнер<br /><br />
rasst – расстояние, оставшееся до станции назначения<br /><br />
<br />
<b>Пример ответа:</b><br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status descr="Обработан" code="0">4</status><br />
<vag num="54922810" station="19380" station_name="Перово" lon="37.764368" lat ="55.735818" state="20" state_name="Россия" road_name="Московская" op_date="2013-10-14 21:57:00" operation="РАСФОРМИРОВАНИЕ ПОЕЗДА" okpo="87556235" owner="ООО &quot;ИМПРОМ&quot;" kgro="0" kgrp="9999" train_index="0" train_number="0" freight="42110" freight_name="Платформы железнодорожные, перевозимые на своих осях" weight="0" vag_number="" rasst="76" /><br />
<vag num="54973847" station="98380" station_name="Партизанск" lon="133.143368" lat ="43.06927" state="20" state_name="Россия" road_name="Дальневосточная" op_date="2013-10-16 13:44:00" operation="ПРОСЛ.ПОЕЗ.&quot;&quot;НАШЕЙ&quot;&quot; СТ.Б/ОСТ(БЕЗ ПР./СД. НА ДР.ДОР)" okpo="62716542" owner="ООО &quot;Репетек&quot;" kgro="6856" kgrp="0032" train_index="9859004123050" train_number="1297" freight="300" freight_name="" weight="250" vag_number="" rasst="9232" /><br />
<vag num="67770560" station="29300" station_name="Коноша I" lon="40.247064" lat ="60.974297" state="20" state_name="Россия" road_name="Северная" op_date="2013-10-15 23:18:00" operation="БРОСАНИЕ ПОЕЗДА НА СТАНЦИИ" okpo="68398528" owner="ОАО [ВГКk" kgro="5194" kgrp="2865" train_index="100016123700" train_number="2301" freight="23205" freight_name="Габбро" weight="690" vag_number="" rasst="732" /><br />
</response><br />
</root><br />
</syntaxhighlight><br />
<br />
===3) Запрос баланса===<br />
На адрес http://www.alta.ru/rail_tracking/api_v1.php выполнить xml-запрос на получение баланса. Содержание xml-строки:<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<query><br />
<login>your_login</login><br />
<password>your_password</password><br />
<action>balans</action><br />
</query><br />
</root><br />
</syntaxhighlight><br />
<br />
В ответ получите xml, содержащую баланс на момент запроса.<br /><br />
Пример ответа:<br /><br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status descr="Обработан" code="0">ok</status> <br />
<balans>[остаток на счете на момент запроса в рублях]</balans><br />
</response><br />
</root><br />
</syntaxhighlight><br />
Status=error – если возникла ошибка. В атрибуте code всегда ноль при успешной обработке запроса или код ошибки. <br /><br />
Descr – текстовое описание ошибки или состояния запроса. <br /><br /><br />
Коды ошибок code:<br /><br />
91 – ошибка соединения с базой<br /><br />
92 – Неверный логин/пароль<br /><br />
93 – Аккаунт не активирован<br /><br />
94 – Неизвестная ошибка<br /><br />
95 – Указанное действие не поддерживается<br /><br />
<br />
===Примеры запросов для языка PHP.===<br />
====1) Запрос на поиск (add_query_example.php)====<br />
<br />
<br />
<?php<br />
<br />
<syntaxhighlight lang="php"> <br />
function post_data($url, $params, $timeout = 5)<br />
{<br />
$opts = array('http' => array( 'method' => 'POST', 'header' => 'Content-type: application/x-www-form-urlencoded', 'content' => $params, 'timeout' => $timeout ) );<br />
$context = stream_context_create($opts);<br />
$result = file_get_contents($url, false, $context);<br />
return $result;<br />
}<br />
<br />
$login = 'your_login';<br />
$pass = 'your_password';<br />
$xml_str = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>";<br />
$xml_str .= "<root><query><login>$login</login><password>$pass</password>";<br />
$xml_str .= "<action>add</action>";<br />
$xml_str .= '<vag num="54532312"/>';<br />
$xml_str .= '<vag num="54563036"/>';<br />
$xml_str .= '<vag num="59616896"/>';<br />
$xml_str .= '<state>20</state>';<br />
$xml_str .= '<type>1</type>';<br />
$xml_str .= '<name>Пример запроса</name>';<br />
$xml_str .= "</query></root>";<br />
$result = post_data("http://www.alta.ru/rail_tracking/api_v1.php", $xml_str, 5);<br />
<br />
$xml = simplexml_load_string($result);<br />
<br />
$status = $xml->response->status;<br />
<br />
echo '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';<br />
<br />
if ($status == 'ok')<br />
{<br />
echo "Результат: ".$status['descr'];<br />
echo "<br/>";<br />
echo "Идентификатор запроса: ".$xml->response->hash;<br />
}<br />
else<br />
{<br />
echo "Результат: ".$status['descr'];<br />
echo "<br/>";<br />
echo "Код ошибки: ".$status['code'];<br />
} <br />
<br />
?><br />
<br />
</syntaxhighlight><br />
<br />
====2) Запрос на получение ответа (get_response_example.php)====<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
<br />
function post_data($url, $params, $timeout = 5)<br />
{<br />
$opts = array('http' => array( 'method' => 'POST', 'header' => 'Content-type: application/x-www-form-urlencoded', 'content' => $params, 'timeout' => $timeout ) );<br />
$context = stream_context_create($opts);<br />
$result = file_get_contents($url, false, $context);<br />
return $result;<br />
}<br />
<br />
$login = 'your_login';<br />
$pass = 'your_password';<br />
$xml_str = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>";<br />
$xml_str .= "<root><query><login>$login</login><password>$pass</password>";<br />
$xml_str .= "<action>get</action>";<br />
$xml_str .= '<hash>c4cf2a16090153f078ea263acab1a6d8</hash>';<br />
$xml_str .= "</query></root>";<br />
$result = post_data("http://www.alta.ru/rail_tracking/api_v1.php", $xml_str, 5);<br />
<br />
$xml = simplexml_load_string($result);<br />
<br />
$status = $xml->response->status;<br />
<br />
echo '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';<br />
<br />
if ($status != 'error')<br />
{<br />
echo "Статус запроса: ".$status['descr'];<br />
echo "<hr/>";<br />
foreach ($xml->xpath('/root/response/vag') as $vag)<br />
{<br />
echo "Станция: ".$vag['station'].' '.$vag['station_name']."<br/>";<br />
echo "Координаты станции: ".$vag['lon'].' '.$vag['lat'].'<br/>';<br />
echo "Дата: ".$vag['op_date']."<br/>";<br />
echo "Операция: ".$vag['operation']."<br/>";<br />
echo "ОКПО собственника: ".$vag['okpo'].' '.$vag['owner'].'<br/>';<br />
echo "<hr/>";<br />
}<br />
}<br />
else<br />
{<br />
echo "Результат: ".$status['descr'];<br />
echo "<br/>";<br />
echo "Код ошибки: ".$status['code'];<br />
} <br />
<br />
?><br />
<br />
</syntaxhighlight><br />
<br />
<br />
Все действия, производимые через api видны и в web-интерфейсе системы (на закладках «в обработке» и «отчеты»)<br />
<br />
===Тестирования сервиса===<br />
<br />
Для отладки взаимодействия сервиса поиска вагонов и учетной системы клиента существует возможность отправлять запросы и получать ответы, используя тестовые данные.<br /> Никаких платежей за использование тестовых данных не предусмотрено.<br /><br /><br />
<br />
Для тестирования сервиса используйте следующие данные:<br /><br />
login: test<br /><br />
password: test<br /><br />
Вы можете отправить запрос только на следующие номера перевозочных средств:<br /><br />
Вагоны: 54676515<br /><br />
Контейнеры: AMFU8899067<br />
<br />
[[Категория:Автоматизация]]<br />
[[Категория:Web-Сервисы]]</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1220API сервиса поиска вагонов2022-06-20T11:18:07Z<p>Boluchevskikh: </p>
<hr />
<div>==!!Внимание!! <br />
Данный протокол более не поддерживается. Используйте API-интерфейс по следующему описанию:==<br />
<br />
REST-JSON API: [https://wiki.alta.ru/index.php/JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2]<br />
<br />
==Описание протокола обмена данными с системой поиска вагонов от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http, транспорт xml. Все запросы в системе – POST. </b><br />
<br />
===1) Выполнение запроса на поиск вагона или контейнера.===<br />
На адрес [https://ww.alta.ru/rail_tracking/api_v1.php https://www.alta.ru/rail_tracking/api_v1.php] нужно послать xml-строку следующего формата:<br />
<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<query><br />
<login>your_login</login><br />
<password>your_password</password><br />
<action>add</action><br />
<type>1|2</type><br />
<state>20</state><br />
<name>My query</name><br />
<vag num=”some_num_1”/><br />
<vag num=”some_num_2”/><br />
….<br />
<vag num=”some_num_n” /><br />
</query><br />
</root><br />
</syntaxhighlight><br />
Где:<br /><br />
login и password – учетные данные, выданные при регистрации личного кабинета<br /><br />
action – [add|get] – добавление запроса на поиск (add) или получение ответа по добавленному ранее запросу (get) <br /><br />
type – [1|2] 1 - запрос на поиск вагонов, 2 – запрос на поиск контейнеров<br /><br />
state – необязательный параметр, код государства запроса, для России всегда 20<br /><br />
name – необязательный параметр, произвольный идентификатор запроса, он будет отображаться в личном кабинете на alta.ru при просмотре через web-интерфейс <br /><br />
vag – список вагонов для выполнения поиска, где атрибут num – собственно номер вагона или контейнера.<br /><br />
<b>В одном запросе не допускается включать номера перевозочных средств разных типов, т.е. в запросе должны быть либо номера только вагонов, либо номера только контейнеров (в соответствии с заданным type).</b><br />
<br />
В ответ система выдаст xml следующего содержания: <br /><br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status code="result_code" descr="Result_descr">ok|error</status><br />
<hash>your_query_hash</hash><br />
</response> <br />
</root><br />
</syntaxhighlight><br />
Где:<br />
Status – [ok|error], статус запроса, ok – выполнен успешно, error – возникла ошибка. <br /><br />
При успешном завершении выполнения запроса атрибут code всегда равен нулю, при возникновении ошибки code = [50|60|70|100], в атрибуте descr – текстовое описание ошибки.<br /><br />
Коды ошибок: <br /><br />
50 – Не указан список вагонов/контейнеров<br /><br />
60, 70 – зарезервировано<br /><br />
91 – ошибка соединения с базой<br /><br />
92 – Неверный логин/пароль<br /><br />
93 – Аккаунт не активирован<br /><br />
94 – Неизвестная ошибка<br /><br />
95 – Указанное действие не поддерживается<br /><br />
96 - Дубликат запроса, действие отменено. Выполнить запрос с такими же параметрами можно через 3 минуты <br /><br />
97 - Данному пользователю разрешено размещать запросы только по РФ <br /><br />
100 – Недостаточно денег на балансе для выполнения запросов<br /><br />
Hash - в случае успеха добавляется элемент hash, содержащий уникальный идентификатор запроса, по которому можно будет получить ответ, содержащий информацию по дислокации перевозочных средств.<br /><br />
<br />
===2) Получение результата запроса.===<br />
Не ранее чем через 1 минуту после добавления запроса, по адресу http://www.alta.ru/rail_tracking/api_v1.php можно выполнить xml-запрос на получение результата. Содержание xml-строки:<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<query><br />
<login>your_login</login><br />
<password>your_password</password><br />
<action>get</action><br />
<hash>your_query_hash</hash><br />
</query><br />
</root><br />
</syntaxhighlight><br />
Где:<br />
login и password – учетные данные, выданные при регистрации личного кабинета<br /><br />
action – [get] получение ответа по добавленному ранее запросу (get)<br /><br />
hash – уникальный идентификатор, полученный при добавлении запроса на выполнение<br /><br />
<br />
В ответ система выдаст xml следующего содержания:<br /><br />
<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status code="result_code" descr="Result_descr">1|2|3|4|error</status><br />
<vag num=”some_num_1” [атрибуты, см. далее описание] /><br />
<vag num=”some_num_2” [атрибуты, см. далее описание] /><br />
….<br />
<vag num=”some_num_n” [атрибуты, см. далее описание] /><br />
</response><br />
</root><br />
</syntaxhighlight><br />
Где: <br /> <br />
Status=error – если возникла ошибка или от «1» до «4» – состояние запроса. В атрибуте code всегда ноль при успешной обработке запроса или код ошибки. Descr – текстовое описание ошибки или состояния запроса. <br /><br />
Коды состояния status:<br /><br /><br />
1 – в очереди на обработку<br /><br />
2 – обрабатывается<br /><br />
3 – частично обработан (получены данные не по всем перевозочным средствам)<br /><br />
4 – полностью обработан <br /><br /><br />
Коды ошибок code:<br /><br />
30 – запрос с указанным hash отсутствует (не формировался)<br /><br />
40 – ошибка при запросе к базе<br /><br />
91 – ошибка соединения с базой<br /><br />
92 – Неверный логин/пароль<br /><br />
93 – Аккаунт не активирован<br /><br />
94 – Неизвестная ошибка<br /><br />
95 – Указанное действие не поддерживается<br /><br />
100 – Недостаточно денег на балансе для выполнения запросов<br /><br />
<br />
При status=3 или status=4 xml-ответ дополняется элементами vag, содержащими информацию по дислокации перевозочных средств. Ниже даны описания атрибутов:<br /><br />
num – номер запрошенного вагона/контейнера<br /><br />
station – ecp-код станции<br /><br />
op_date – дата операции<br /><br />
station_name – наименование станции<br /><br />
lon и lat – широта и долгота станции (если есть в базе)<br /><br />
state – код государства станции<br /><br />
state_name – наименование государства станции<br /><br />
road_name – дорога станции<br /><br />
operation – операции, совершенная на станции с поездом<br /><br />
okpo – ОКПО собственника перевозочного средства<br /><br />
owner – наименование собственника перевозочного средства (если доступно)<br /><br />
kgro и kgrp – коды грузоотправителя и грузополучателя<br /><br />
train_index – индекс поезда<br /><br />
train_number – номер поезда<br /><br />
freight – код груза ЕТСНГ<br /><br />
freight_name – наименование груза ЕТСНГ<br /><br />
weight – масса груза в центнерах<br /><br />
vag_number – только для контейнеров, номер вагона, на котором размещен контейнер<br /><br />
rasst – расстояние, оставшееся до станции назначения<br /><br />
<br />
<b>Пример ответа:</b><br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status descr="Обработан" code="0">4</status><br />
<vag num="54922810" station="19380" station_name="Перово" lon="37.764368" lat ="55.735818" state="20" state_name="Россия" road_name="Московская" op_date="2013-10-14 21:57:00" operation="РАСФОРМИРОВАНИЕ ПОЕЗДА" okpo="87556235" owner="ООО &quot;ИМПРОМ&quot;" kgro="0" kgrp="9999" train_index="0" train_number="0" freight="42110" freight_name="Платформы железнодорожные, перевозимые на своих осях" weight="0" vag_number="" rasst="76" /><br />
<vag num="54973847" station="98380" station_name="Партизанск" lon="133.143368" lat ="43.06927" state="20" state_name="Россия" road_name="Дальневосточная" op_date="2013-10-16 13:44:00" operation="ПРОСЛ.ПОЕЗ.&quot;&quot;НАШЕЙ&quot;&quot; СТ.Б/ОСТ(БЕЗ ПР./СД. НА ДР.ДОР)" okpo="62716542" owner="ООО &quot;Репетек&quot;" kgro="6856" kgrp="0032" train_index="9859004123050" train_number="1297" freight="300" freight_name="" weight="250" vag_number="" rasst="9232" /><br />
<vag num="67770560" station="29300" station_name="Коноша I" lon="40.247064" lat ="60.974297" state="20" state_name="Россия" road_name="Северная" op_date="2013-10-15 23:18:00" operation="БРОСАНИЕ ПОЕЗДА НА СТАНЦИИ" okpo="68398528" owner="ОАО [ВГКk" kgro="5194" kgrp="2865" train_index="100016123700" train_number="2301" freight="23205" freight_name="Габбро" weight="690" vag_number="" rasst="732" /><br />
</response><br />
</root><br />
</syntaxhighlight><br />
<br />
===3) Запрос баланса===<br />
На адрес http://www.alta.ru/rail_tracking/api_v1.php выполнить xml-запрос на получение баланса. Содержание xml-строки:<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<query><br />
<login>your_login</login><br />
<password>your_password</password><br />
<action>balans</action><br />
</query><br />
</root><br />
</syntaxhighlight><br />
<br />
В ответ получите xml, содержащую баланс на момент запроса.<br /><br />
Пример ответа:<br /><br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status descr="Обработан" code="0">ok</status> <br />
<balans>[остаток на счете на момент запроса в рублях]</balans><br />
</response><br />
</root><br />
</syntaxhighlight><br />
Status=error – если возникла ошибка. В атрибуте code всегда ноль при успешной обработке запроса или код ошибки. <br /><br />
Descr – текстовое описание ошибки или состояния запроса. <br /><br /><br />
Коды ошибок code:<br /><br />
91 – ошибка соединения с базой<br /><br />
92 – Неверный логин/пароль<br /><br />
93 – Аккаунт не активирован<br /><br />
94 – Неизвестная ошибка<br /><br />
95 – Указанное действие не поддерживается<br /><br />
<br />
===Примеры запросов для языка PHP.===<br />
====1) Запрос на поиск (add_query_example.php)====<br />
<br />
<br />
<?php<br />
<br />
<syntaxhighlight lang="php"> <br />
function post_data($url, $params, $timeout = 5)<br />
{<br />
$opts = array('http' => array( 'method' => 'POST', 'header' => 'Content-type: application/x-www-form-urlencoded', 'content' => $params, 'timeout' => $timeout ) );<br />
$context = stream_context_create($opts);<br />
$result = file_get_contents($url, false, $context);<br />
return $result;<br />
}<br />
<br />
$login = 'your_login';<br />
$pass = 'your_password';<br />
$xml_str = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>";<br />
$xml_str .= "<root><query><login>$login</login><password>$pass</password>";<br />
$xml_str .= "<action>add</action>";<br />
$xml_str .= '<vag num="54532312"/>';<br />
$xml_str .= '<vag num="54563036"/>';<br />
$xml_str .= '<vag num="59616896"/>';<br />
$xml_str .= '<state>20</state>';<br />
$xml_str .= '<type>1</type>';<br />
$xml_str .= '<name>Пример запроса</name>';<br />
$xml_str .= "</query></root>";<br />
$result = post_data("http://www.alta.ru/rail_tracking/api_v1.php", $xml_str, 5);<br />
<br />
$xml = simplexml_load_string($result);<br />
<br />
$status = $xml->response->status;<br />
<br />
echo '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';<br />
<br />
if ($status == 'ok')<br />
{<br />
echo "Результат: ".$status['descr'];<br />
echo "<br/>";<br />
echo "Идентификатор запроса: ".$xml->response->hash;<br />
}<br />
else<br />
{<br />
echo "Результат: ".$status['descr'];<br />
echo "<br/>";<br />
echo "Код ошибки: ".$status['code'];<br />
} <br />
<br />
?><br />
<br />
</syntaxhighlight><br />
<br />
====2) Запрос на получение ответа (get_response_example.php)====<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
<br />
function post_data($url, $params, $timeout = 5)<br />
{<br />
$opts = array('http' => array( 'method' => 'POST', 'header' => 'Content-type: application/x-www-form-urlencoded', 'content' => $params, 'timeout' => $timeout ) );<br />
$context = stream_context_create($opts);<br />
$result = file_get_contents($url, false, $context);<br />
return $result;<br />
}<br />
<br />
$login = 'your_login';<br />
$pass = 'your_password';<br />
$xml_str = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>";<br />
$xml_str .= "<root><query><login>$login</login><password>$pass</password>";<br />
$xml_str .= "<action>get</action>";<br />
$xml_str .= '<hash>c4cf2a16090153f078ea263acab1a6d8</hash>';<br />
$xml_str .= "</query></root>";<br />
$result = post_data("http://www.alta.ru/rail_tracking/api_v1.php", $xml_str, 5);<br />
<br />
$xml = simplexml_load_string($result);<br />
<br />
$status = $xml->response->status;<br />
<br />
echo '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';<br />
<br />
if ($status != 'error')<br />
{<br />
echo "Статус запроса: ".$status['descr'];<br />
echo "<hr/>";<br />
foreach ($xml->xpath('/root/response/vag') as $vag)<br />
{<br />
echo "Станция: ".$vag['station'].' '.$vag['station_name']."<br/>";<br />
echo "Координаты станции: ".$vag['lon'].' '.$vag['lat'].'<br/>';<br />
echo "Дата: ".$vag['op_date']."<br/>";<br />
echo "Операция: ".$vag['operation']."<br/>";<br />
echo "ОКПО собственника: ".$vag['okpo'].' '.$vag['owner'].'<br/>';<br />
echo "<hr/>";<br />
}<br />
}<br />
else<br />
{<br />
echo "Результат: ".$status['descr'];<br />
echo "<br/>";<br />
echo "Код ошибки: ".$status['code'];<br />
} <br />
<br />
?><br />
<br />
</syntaxhighlight><br />
<br />
<br />
Все действия, производимые через api видны и в web-интерфейсе системы (на закладках «в обработке» и «отчеты»)<br />
<br />
===Тестирования сервиса===<br />
<br />
Для отладки взаимодействия сервиса поиска вагонов и учетной системы клиента существует возможность отправлять запросы и получать ответы, используя тестовые данные.<br /> Никаких платежей за использование тестовых данных не предусмотрено.<br /><br /><br />
<br />
Для тестирования сервиса используйте следующие данные:<br /><br />
login: test<br /><br />
password: test<br /><br />
Вы можете отправить запрос только на следующие номера перевозочных средств:<br /><br />
Вагоны: 54676515<br /><br />
Контейнеры: AMFU8899067<br />
<br />
[[Категория:Автоматизация]]<br />
[[Категория:Web-Сервисы]]</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1219API сервиса поиска вагонов2022-06-20T11:17:41Z<p>Boluchevskikh: </p>
<hr />
<div>==Внимание, данный протокол более не поддерживается. Используйте API-интерфейс по следующему описанию:==<br />
<br />
REST-JSON API: [https://wiki.alta.ru/index.php/JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2]<br />
<br />
==Описание протокола обмена данными с системой поиска вагонов от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http, транспорт xml. Все запросы в системе – POST. </b><br />
<br />
===1) Выполнение запроса на поиск вагона или контейнера.===<br />
На адрес [https://ww.alta.ru/rail_tracking/api_v1.php https://www.alta.ru/rail_tracking/api_v1.php] нужно послать xml-строку следующего формата:<br />
<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<query><br />
<login>your_login</login><br />
<password>your_password</password><br />
<action>add</action><br />
<type>1|2</type><br />
<state>20</state><br />
<name>My query</name><br />
<vag num=”some_num_1”/><br />
<vag num=”some_num_2”/><br />
….<br />
<vag num=”some_num_n” /><br />
</query><br />
</root><br />
</syntaxhighlight><br />
Где:<br /><br />
login и password – учетные данные, выданные при регистрации личного кабинета<br /><br />
action – [add|get] – добавление запроса на поиск (add) или получение ответа по добавленному ранее запросу (get) <br /><br />
type – [1|2] 1 - запрос на поиск вагонов, 2 – запрос на поиск контейнеров<br /><br />
state – необязательный параметр, код государства запроса, для России всегда 20<br /><br />
name – необязательный параметр, произвольный идентификатор запроса, он будет отображаться в личном кабинете на alta.ru при просмотре через web-интерфейс <br /><br />
vag – список вагонов для выполнения поиска, где атрибут num – собственно номер вагона или контейнера.<br /><br />
<b>В одном запросе не допускается включать номера перевозочных средств разных типов, т.е. в запросе должны быть либо номера только вагонов, либо номера только контейнеров (в соответствии с заданным type).</b><br />
<br />
В ответ система выдаст xml следующего содержания: <br /><br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status code="result_code" descr="Result_descr">ok|error</status><br />
<hash>your_query_hash</hash><br />
</response> <br />
</root><br />
</syntaxhighlight><br />
Где:<br />
Status – [ok|error], статус запроса, ok – выполнен успешно, error – возникла ошибка. <br /><br />
При успешном завершении выполнения запроса атрибут code всегда равен нулю, при возникновении ошибки code = [50|60|70|100], в атрибуте descr – текстовое описание ошибки.<br /><br />
Коды ошибок: <br /><br />
50 – Не указан список вагонов/контейнеров<br /><br />
60, 70 – зарезервировано<br /><br />
91 – ошибка соединения с базой<br /><br />
92 – Неверный логин/пароль<br /><br />
93 – Аккаунт не активирован<br /><br />
94 – Неизвестная ошибка<br /><br />
95 – Указанное действие не поддерживается<br /><br />
96 - Дубликат запроса, действие отменено. Выполнить запрос с такими же параметрами можно через 3 минуты <br /><br />
97 - Данному пользователю разрешено размещать запросы только по РФ <br /><br />
100 – Недостаточно денег на балансе для выполнения запросов<br /><br />
Hash - в случае успеха добавляется элемент hash, содержащий уникальный идентификатор запроса, по которому можно будет получить ответ, содержащий информацию по дислокации перевозочных средств.<br /><br />
<br />
===2) Получение результата запроса.===<br />
Не ранее чем через 1 минуту после добавления запроса, по адресу http://www.alta.ru/rail_tracking/api_v1.php можно выполнить xml-запрос на получение результата. Содержание xml-строки:<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<query><br />
<login>your_login</login><br />
<password>your_password</password><br />
<action>get</action><br />
<hash>your_query_hash</hash><br />
</query><br />
</root><br />
</syntaxhighlight><br />
Где:<br />
login и password – учетные данные, выданные при регистрации личного кабинета<br /><br />
action – [get] получение ответа по добавленному ранее запросу (get)<br /><br />
hash – уникальный идентификатор, полученный при добавлении запроса на выполнение<br /><br />
<br />
В ответ система выдаст xml следующего содержания:<br /><br />
<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status code="result_code" descr="Result_descr">1|2|3|4|error</status><br />
<vag num=”some_num_1” [атрибуты, см. далее описание] /><br />
<vag num=”some_num_2” [атрибуты, см. далее описание] /><br />
….<br />
<vag num=”some_num_n” [атрибуты, см. далее описание] /><br />
</response><br />
</root><br />
</syntaxhighlight><br />
Где: <br /> <br />
Status=error – если возникла ошибка или от «1» до «4» – состояние запроса. В атрибуте code всегда ноль при успешной обработке запроса или код ошибки. Descr – текстовое описание ошибки или состояния запроса. <br /><br />
Коды состояния status:<br /><br /><br />
1 – в очереди на обработку<br /><br />
2 – обрабатывается<br /><br />
3 – частично обработан (получены данные не по всем перевозочным средствам)<br /><br />
4 – полностью обработан <br /><br /><br />
Коды ошибок code:<br /><br />
30 – запрос с указанным hash отсутствует (не формировался)<br /><br />
40 – ошибка при запросе к базе<br /><br />
91 – ошибка соединения с базой<br /><br />
92 – Неверный логин/пароль<br /><br />
93 – Аккаунт не активирован<br /><br />
94 – Неизвестная ошибка<br /><br />
95 – Указанное действие не поддерживается<br /><br />
100 – Недостаточно денег на балансе для выполнения запросов<br /><br />
<br />
При status=3 или status=4 xml-ответ дополняется элементами vag, содержащими информацию по дислокации перевозочных средств. Ниже даны описания атрибутов:<br /><br />
num – номер запрошенного вагона/контейнера<br /><br />
station – ecp-код станции<br /><br />
op_date – дата операции<br /><br />
station_name – наименование станции<br /><br />
lon и lat – широта и долгота станции (если есть в базе)<br /><br />
state – код государства станции<br /><br />
state_name – наименование государства станции<br /><br />
road_name – дорога станции<br /><br />
operation – операции, совершенная на станции с поездом<br /><br />
okpo – ОКПО собственника перевозочного средства<br /><br />
owner – наименование собственника перевозочного средства (если доступно)<br /><br />
kgro и kgrp – коды грузоотправителя и грузополучателя<br /><br />
train_index – индекс поезда<br /><br />
train_number – номер поезда<br /><br />
freight – код груза ЕТСНГ<br /><br />
freight_name – наименование груза ЕТСНГ<br /><br />
weight – масса груза в центнерах<br /><br />
vag_number – только для контейнеров, номер вагона, на котором размещен контейнер<br /><br />
rasst – расстояние, оставшееся до станции назначения<br /><br />
<br />
<b>Пример ответа:</b><br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status descr="Обработан" code="0">4</status><br />
<vag num="54922810" station="19380" station_name="Перово" lon="37.764368" lat ="55.735818" state="20" state_name="Россия" road_name="Московская" op_date="2013-10-14 21:57:00" operation="РАСФОРМИРОВАНИЕ ПОЕЗДА" okpo="87556235" owner="ООО &quot;ИМПРОМ&quot;" kgro="0" kgrp="9999" train_index="0" train_number="0" freight="42110" freight_name="Платформы железнодорожные, перевозимые на своих осях" weight="0" vag_number="" rasst="76" /><br />
<vag num="54973847" station="98380" station_name="Партизанск" lon="133.143368" lat ="43.06927" state="20" state_name="Россия" road_name="Дальневосточная" op_date="2013-10-16 13:44:00" operation="ПРОСЛ.ПОЕЗ.&quot;&quot;НАШЕЙ&quot;&quot; СТ.Б/ОСТ(БЕЗ ПР./СД. НА ДР.ДОР)" okpo="62716542" owner="ООО &quot;Репетек&quot;" kgro="6856" kgrp="0032" train_index="9859004123050" train_number="1297" freight="300" freight_name="" weight="250" vag_number="" rasst="9232" /><br />
<vag num="67770560" station="29300" station_name="Коноша I" lon="40.247064" lat ="60.974297" state="20" state_name="Россия" road_name="Северная" op_date="2013-10-15 23:18:00" operation="БРОСАНИЕ ПОЕЗДА НА СТАНЦИИ" okpo="68398528" owner="ОАО [ВГКk" kgro="5194" kgrp="2865" train_index="100016123700" train_number="2301" freight="23205" freight_name="Габбро" weight="690" vag_number="" rasst="732" /><br />
</response><br />
</root><br />
</syntaxhighlight><br />
<br />
===3) Запрос баланса===<br />
На адрес http://www.alta.ru/rail_tracking/api_v1.php выполнить xml-запрос на получение баланса. Содержание xml-строки:<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<query><br />
<login>your_login</login><br />
<password>your_password</password><br />
<action>balans</action><br />
</query><br />
</root><br />
</syntaxhighlight><br />
<br />
В ответ получите xml, содержащую баланс на момент запроса.<br /><br />
Пример ответа:<br /><br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status descr="Обработан" code="0">ok</status> <br />
<balans>[остаток на счете на момент запроса в рублях]</balans><br />
</response><br />
</root><br />
</syntaxhighlight><br />
Status=error – если возникла ошибка. В атрибуте code всегда ноль при успешной обработке запроса или код ошибки. <br /><br />
Descr – текстовое описание ошибки или состояния запроса. <br /><br /><br />
Коды ошибок code:<br /><br />
91 – ошибка соединения с базой<br /><br />
92 – Неверный логин/пароль<br /><br />
93 – Аккаунт не активирован<br /><br />
94 – Неизвестная ошибка<br /><br />
95 – Указанное действие не поддерживается<br /><br />
<br />
===Примеры запросов для языка PHP.===<br />
====1) Запрос на поиск (add_query_example.php)====<br />
<br />
<br />
<?php<br />
<br />
<syntaxhighlight lang="php"> <br />
function post_data($url, $params, $timeout = 5)<br />
{<br />
$opts = array('http' => array( 'method' => 'POST', 'header' => 'Content-type: application/x-www-form-urlencoded', 'content' => $params, 'timeout' => $timeout ) );<br />
$context = stream_context_create($opts);<br />
$result = file_get_contents($url, false, $context);<br />
return $result;<br />
}<br />
<br />
$login = 'your_login';<br />
$pass = 'your_password';<br />
$xml_str = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>";<br />
$xml_str .= "<root><query><login>$login</login><password>$pass</password>";<br />
$xml_str .= "<action>add</action>";<br />
$xml_str .= '<vag num="54532312"/>';<br />
$xml_str .= '<vag num="54563036"/>';<br />
$xml_str .= '<vag num="59616896"/>';<br />
$xml_str .= '<state>20</state>';<br />
$xml_str .= '<type>1</type>';<br />
$xml_str .= '<name>Пример запроса</name>';<br />
$xml_str .= "</query></root>";<br />
$result = post_data("http://www.alta.ru/rail_tracking/api_v1.php", $xml_str, 5);<br />
<br />
$xml = simplexml_load_string($result);<br />
<br />
$status = $xml->response->status;<br />
<br />
echo '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';<br />
<br />
if ($status == 'ok')<br />
{<br />
echo "Результат: ".$status['descr'];<br />
echo "<br/>";<br />
echo "Идентификатор запроса: ".$xml->response->hash;<br />
}<br />
else<br />
{<br />
echo "Результат: ".$status['descr'];<br />
echo "<br/>";<br />
echo "Код ошибки: ".$status['code'];<br />
} <br />
<br />
?><br />
<br />
</syntaxhighlight><br />
<br />
====2) Запрос на получение ответа (get_response_example.php)====<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
<br />
function post_data($url, $params, $timeout = 5)<br />
{<br />
$opts = array('http' => array( 'method' => 'POST', 'header' => 'Content-type: application/x-www-form-urlencoded', 'content' => $params, 'timeout' => $timeout ) );<br />
$context = stream_context_create($opts);<br />
$result = file_get_contents($url, false, $context);<br />
return $result;<br />
}<br />
<br />
$login = 'your_login';<br />
$pass = 'your_password';<br />
$xml_str = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>";<br />
$xml_str .= "<root><query><login>$login</login><password>$pass</password>";<br />
$xml_str .= "<action>get</action>";<br />
$xml_str .= '<hash>c4cf2a16090153f078ea263acab1a6d8</hash>';<br />
$xml_str .= "</query></root>";<br />
$result = post_data("http://www.alta.ru/rail_tracking/api_v1.php", $xml_str, 5);<br />
<br />
$xml = simplexml_load_string($result);<br />
<br />
$status = $xml->response->status;<br />
<br />
echo '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';<br />
<br />
if ($status != 'error')<br />
{<br />
echo "Статус запроса: ".$status['descr'];<br />
echo "<hr/>";<br />
foreach ($xml->xpath('/root/response/vag') as $vag)<br />
{<br />
echo "Станция: ".$vag['station'].' '.$vag['station_name']."<br/>";<br />
echo "Координаты станции: ".$vag['lon'].' '.$vag['lat'].'<br/>';<br />
echo "Дата: ".$vag['op_date']."<br/>";<br />
echo "Операция: ".$vag['operation']."<br/>";<br />
echo "ОКПО собственника: ".$vag['okpo'].' '.$vag['owner'].'<br/>';<br />
echo "<hr/>";<br />
}<br />
}<br />
else<br />
{<br />
echo "Результат: ".$status['descr'];<br />
echo "<br/>";<br />
echo "Код ошибки: ".$status['code'];<br />
} <br />
<br />
?><br />
<br />
</syntaxhighlight><br />
<br />
<br />
Все действия, производимые через api видны и в web-интерфейсе системы (на закладках «в обработке» и «отчеты»)<br />
<br />
===Тестирования сервиса===<br />
<br />
Для отладки взаимодействия сервиса поиска вагонов и учетной системы клиента существует возможность отправлять запросы и получать ответы, используя тестовые данные.<br /> Никаких платежей за использование тестовых данных не предусмотрено.<br /><br /><br />
<br />
Для тестирования сервиса используйте следующие данные:<br /><br />
login: test<br /><br />
password: test<br /><br />
Вы можете отправить запрос только на следующие номера перевозочных средств:<br /><br />
Вагоны: 54676515<br /><br />
Контейнеры: AMFU8899067<br />
<br />
[[Категория:Автоматизация]]<br />
[[Категория:Web-Сервисы]]</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1218API сервиса поиска вагонов2022-06-20T11:10:41Z<p>Boluchevskikh: </p>
<hr />
<div>==Внимание, данный протокол более не поддерживается. Используйте API-интерфес по следующему описанию:==<br />
<br />
REST-JSON API: [https://wiki.alta.ru/index.php/JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2]<br />
<br />
==Описание протокола обмена данными с системой поиска вагонов от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http, транспорт xml. Все запросы в системе – POST. </b><br />
<br />
===1) Выполнение запроса на поиск вагона или контейнера.===<br />
На адрес [https://ww.alta.ru/rail_tracking/api_v1.php https://www.alta.ru/rail_tracking/api_v1.php] нужно послать xml-строку следующего формата:<br />
<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<query><br />
<login>your_login</login><br />
<password>your_password</password><br />
<action>add</action><br />
<type>1|2</type><br />
<state>20</state><br />
<name>My query</name><br />
<vag num=”some_num_1”/><br />
<vag num=”some_num_2”/><br />
….<br />
<vag num=”some_num_n” /><br />
</query><br />
</root><br />
</syntaxhighlight><br />
Где:<br /><br />
login и password – учетные данные, выданные при регистрации личного кабинета<br /><br />
action – [add|get] – добавление запроса на поиск (add) или получение ответа по добавленному ранее запросу (get) <br /><br />
type – [1|2] 1 - запрос на поиск вагонов, 2 – запрос на поиск контейнеров<br /><br />
state – необязательный параметр, код государства запроса, для России всегда 20<br /><br />
name – необязательный параметр, произвольный идентификатор запроса, он будет отображаться в личном кабинете на alta.ru при просмотре через web-интерфейс <br /><br />
vag – список вагонов для выполнения поиска, где атрибут num – собственно номер вагона или контейнера.<br /><br />
<b>В одном запросе не допускается включать номера перевозочных средств разных типов, т.е. в запросе должны быть либо номера только вагонов, либо номера только контейнеров (в соответствии с заданным type).</b><br />
<br />
В ответ система выдаст xml следующего содержания: <br /><br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status code="result_code" descr="Result_descr">ok|error</status><br />
<hash>your_query_hash</hash><br />
</response> <br />
</root><br />
</syntaxhighlight><br />
Где:<br />
Status – [ok|error], статус запроса, ok – выполнен успешно, error – возникла ошибка. <br /><br />
При успешном завершении выполнения запроса атрибут code всегда равен нулю, при возникновении ошибки code = [50|60|70|100], в атрибуте descr – текстовое описание ошибки.<br /><br />
Коды ошибок: <br /><br />
50 – Не указан список вагонов/контейнеров<br /><br />
60, 70 – зарезервировано<br /><br />
91 – ошибка соединения с базой<br /><br />
92 – Неверный логин/пароль<br /><br />
93 – Аккаунт не активирован<br /><br />
94 – Неизвестная ошибка<br /><br />
95 – Указанное действие не поддерживается<br /><br />
96 - Дубликат запроса, действие отменено. Выполнить запрос с такими же параметрами можно через 3 минуты <br /><br />
97 - Данному пользователю разрешено размещать запросы только по РФ <br /><br />
100 – Недостаточно денег на балансе для выполнения запросов<br /><br />
Hash - в случае успеха добавляется элемент hash, содержащий уникальный идентификатор запроса, по которому можно будет получить ответ, содержащий информацию по дислокации перевозочных средств.<br /><br />
<br />
===2) Получение результата запроса.===<br />
Не ранее чем через 1 минуту после добавления запроса, по адресу http://www.alta.ru/rail_tracking/api_v1.php можно выполнить xml-запрос на получение результата. Содержание xml-строки:<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<query><br />
<login>your_login</login><br />
<password>your_password</password><br />
<action>get</action><br />
<hash>your_query_hash</hash><br />
</query><br />
</root><br />
</syntaxhighlight><br />
Где:<br />
login и password – учетные данные, выданные при регистрации личного кабинета<br /><br />
action – [get] получение ответа по добавленному ранее запросу (get)<br /><br />
hash – уникальный идентификатор, полученный при добавлении запроса на выполнение<br /><br />
<br />
В ответ система выдаст xml следующего содержания:<br /><br />
<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status code="result_code" descr="Result_descr">1|2|3|4|error</status><br />
<vag num=”some_num_1” [атрибуты, см. далее описание] /><br />
<vag num=”some_num_2” [атрибуты, см. далее описание] /><br />
….<br />
<vag num=”some_num_n” [атрибуты, см. далее описание] /><br />
</response><br />
</root><br />
</syntaxhighlight><br />
Где: <br /> <br />
Status=error – если возникла ошибка или от «1» до «4» – состояние запроса. В атрибуте code всегда ноль при успешной обработке запроса или код ошибки. Descr – текстовое описание ошибки или состояния запроса. <br /><br />
Коды состояния status:<br /><br /><br />
1 – в очереди на обработку<br /><br />
2 – обрабатывается<br /><br />
3 – частично обработан (получены данные не по всем перевозочным средствам)<br /><br />
4 – полностью обработан <br /><br /><br />
Коды ошибок code:<br /><br />
30 – запрос с указанным hash отсутствует (не формировался)<br /><br />
40 – ошибка при запросе к базе<br /><br />
91 – ошибка соединения с базой<br /><br />
92 – Неверный логин/пароль<br /><br />
93 – Аккаунт не активирован<br /><br />
94 – Неизвестная ошибка<br /><br />
95 – Указанное действие не поддерживается<br /><br />
100 – Недостаточно денег на балансе для выполнения запросов<br /><br />
<br />
При status=3 или status=4 xml-ответ дополняется элементами vag, содержащими информацию по дислокации перевозочных средств. Ниже даны описания атрибутов:<br /><br />
num – номер запрошенного вагона/контейнера<br /><br />
station – ecp-код станции<br /><br />
op_date – дата операции<br /><br />
station_name – наименование станции<br /><br />
lon и lat – широта и долгота станции (если есть в базе)<br /><br />
state – код государства станции<br /><br />
state_name – наименование государства станции<br /><br />
road_name – дорога станции<br /><br />
operation – операции, совершенная на станции с поездом<br /><br />
okpo – ОКПО собственника перевозочного средства<br /><br />
owner – наименование собственника перевозочного средства (если доступно)<br /><br />
kgro и kgrp – коды грузоотправителя и грузополучателя<br /><br />
train_index – индекс поезда<br /><br />
train_number – номер поезда<br /><br />
freight – код груза ЕТСНГ<br /><br />
freight_name – наименование груза ЕТСНГ<br /><br />
weight – масса груза в центнерах<br /><br />
vag_number – только для контейнеров, номер вагона, на котором размещен контейнер<br /><br />
rasst – расстояние, оставшееся до станции назначения<br /><br />
<br />
<b>Пример ответа:</b><br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status descr="Обработан" code="0">4</status><br />
<vag num="54922810" station="19380" station_name="Перово" lon="37.764368" lat ="55.735818" state="20" state_name="Россия" road_name="Московская" op_date="2013-10-14 21:57:00" operation="РАСФОРМИРОВАНИЕ ПОЕЗДА" okpo="87556235" owner="ООО &quot;ИМПРОМ&quot;" kgro="0" kgrp="9999" train_index="0" train_number="0" freight="42110" freight_name="Платформы железнодорожные, перевозимые на своих осях" weight="0" vag_number="" rasst="76" /><br />
<vag num="54973847" station="98380" station_name="Партизанск" lon="133.143368" lat ="43.06927" state="20" state_name="Россия" road_name="Дальневосточная" op_date="2013-10-16 13:44:00" operation="ПРОСЛ.ПОЕЗ.&quot;&quot;НАШЕЙ&quot;&quot; СТ.Б/ОСТ(БЕЗ ПР./СД. НА ДР.ДОР)" okpo="62716542" owner="ООО &quot;Репетек&quot;" kgro="6856" kgrp="0032" train_index="9859004123050" train_number="1297" freight="300" freight_name="" weight="250" vag_number="" rasst="9232" /><br />
<vag num="67770560" station="29300" station_name="Коноша I" lon="40.247064" lat ="60.974297" state="20" state_name="Россия" road_name="Северная" op_date="2013-10-15 23:18:00" operation="БРОСАНИЕ ПОЕЗДА НА СТАНЦИИ" okpo="68398528" owner="ОАО [ВГКk" kgro="5194" kgrp="2865" train_index="100016123700" train_number="2301" freight="23205" freight_name="Габбро" weight="690" vag_number="" rasst="732" /><br />
</response><br />
</root><br />
</syntaxhighlight><br />
<br />
===3) Запрос баланса===<br />
На адрес http://www.alta.ru/rail_tracking/api_v1.php выполнить xml-запрос на получение баланса. Содержание xml-строки:<br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<query><br />
<login>your_login</login><br />
<password>your_password</password><br />
<action>balans</action><br />
</query><br />
</root><br />
</syntaxhighlight><br />
<br />
В ответ получите xml, содержащую баланс на момент запроса.<br /><br />
Пример ответа:<br /><br />
<syntaxhighlight lang="xml"><br />
<?xml version="1.0" encoding="utf-8" standalone="yes"?><br />
<root><br />
<response><br />
<status descr="Обработан" code="0">ok</status> <br />
<balans>[остаток на счете на момент запроса в рублях]</balans><br />
</response><br />
</root><br />
</syntaxhighlight><br />
Status=error – если возникла ошибка. В атрибуте code всегда ноль при успешной обработке запроса или код ошибки. <br /><br />
Descr – текстовое описание ошибки или состояния запроса. <br /><br /><br />
Коды ошибок code:<br /><br />
91 – ошибка соединения с базой<br /><br />
92 – Неверный логин/пароль<br /><br />
93 – Аккаунт не активирован<br /><br />
94 – Неизвестная ошибка<br /><br />
95 – Указанное действие не поддерживается<br /><br />
<br />
===Примеры запросов для языка PHP.===<br />
====1) Запрос на поиск (add_query_example.php)====<br />
<br />
<br />
<?php<br />
<br />
<syntaxhighlight lang="php"> <br />
function post_data($url, $params, $timeout = 5)<br />
{<br />
$opts = array('http' => array( 'method' => 'POST', 'header' => 'Content-type: application/x-www-form-urlencoded', 'content' => $params, 'timeout' => $timeout ) );<br />
$context = stream_context_create($opts);<br />
$result = file_get_contents($url, false, $context);<br />
return $result;<br />
}<br />
<br />
$login = 'your_login';<br />
$pass = 'your_password';<br />
$xml_str = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>";<br />
$xml_str .= "<root><query><login>$login</login><password>$pass</password>";<br />
$xml_str .= "<action>add</action>";<br />
$xml_str .= '<vag num="54532312"/>';<br />
$xml_str .= '<vag num="54563036"/>';<br />
$xml_str .= '<vag num="59616896"/>';<br />
$xml_str .= '<state>20</state>';<br />
$xml_str .= '<type>1</type>';<br />
$xml_str .= '<name>Пример запроса</name>';<br />
$xml_str .= "</query></root>";<br />
$result = post_data("http://www.alta.ru/rail_tracking/api_v1.php", $xml_str, 5);<br />
<br />
$xml = simplexml_load_string($result);<br />
<br />
$status = $xml->response->status;<br />
<br />
echo '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';<br />
<br />
if ($status == 'ok')<br />
{<br />
echo "Результат: ".$status['descr'];<br />
echo "<br/>";<br />
echo "Идентификатор запроса: ".$xml->response->hash;<br />
}<br />
else<br />
{<br />
echo "Результат: ".$status['descr'];<br />
echo "<br/>";<br />
echo "Код ошибки: ".$status['code'];<br />
} <br />
<br />
?><br />
<br />
</syntaxhighlight><br />
<br />
====2) Запрос на получение ответа (get_response_example.php)====<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
<br />
function post_data($url, $params, $timeout = 5)<br />
{<br />
$opts = array('http' => array( 'method' => 'POST', 'header' => 'Content-type: application/x-www-form-urlencoded', 'content' => $params, 'timeout' => $timeout ) );<br />
$context = stream_context_create($opts);<br />
$result = file_get_contents($url, false, $context);<br />
return $result;<br />
}<br />
<br />
$login = 'your_login';<br />
$pass = 'your_password';<br />
$xml_str = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>";<br />
$xml_str .= "<root><query><login>$login</login><password>$pass</password>";<br />
$xml_str .= "<action>get</action>";<br />
$xml_str .= '<hash>c4cf2a16090153f078ea263acab1a6d8</hash>';<br />
$xml_str .= "</query></root>";<br />
$result = post_data("http://www.alta.ru/rail_tracking/api_v1.php", $xml_str, 5);<br />
<br />
$xml = simplexml_load_string($result);<br />
<br />
$status = $xml->response->status;<br />
<br />
echo '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';<br />
<br />
if ($status != 'error')<br />
{<br />
echo "Статус запроса: ".$status['descr'];<br />
echo "<hr/>";<br />
foreach ($xml->xpath('/root/response/vag') as $vag)<br />
{<br />
echo "Станция: ".$vag['station'].' '.$vag['station_name']."<br/>";<br />
echo "Координаты станции: ".$vag['lon'].' '.$vag['lat'].'<br/>';<br />
echo "Дата: ".$vag['op_date']."<br/>";<br />
echo "Операция: ".$vag['operation']."<br/>";<br />
echo "ОКПО собственника: ".$vag['okpo'].' '.$vag['owner'].'<br/>';<br />
echo "<hr/>";<br />
}<br />
}<br />
else<br />
{<br />
echo "Результат: ".$status['descr'];<br />
echo "<br/>";<br />
echo "Код ошибки: ".$status['code'];<br />
} <br />
<br />
?><br />
<br />
</syntaxhighlight><br />
<br />
<br />
Все действия, производимые через api видны и в web-интерфейсе системы (на закладках «в обработке» и «отчеты»)<br />
<br />
===Тестирования сервиса===<br />
<br />
Для отладки взаимодействия сервиса поиска вагонов и учетной системы клиента существует возможность отправлять запросы и получать ответы, используя тестовые данные.<br /> Никаких платежей за использование тестовых данных не предусмотрено.<br /><br /><br />
<br />
Для тестирования сервиса используйте следующие данные:<br /><br />
login: test<br /><br />
password: test<br /><br />
Вы можете отправить запрос только на следующие номера перевозочных средств:<br /><br />
Вагоны: 54676515<br /><br />
Контейнеры: AMFU8899067<br />
<br />
[[Категория:Автоматизация]]<br />
[[Категория:Web-Сервисы]]</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1217API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2022-05-04T07:07:23Z<p>Boluchevskikh: </p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования] <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута и расстояний между станциями==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления (необязательный). Если не указан код страны отправления, то автоматически будет установлена РФ.</li><br />
<li>tstate - код страны назначения (необязательный). Если не указан код страны назначения, то автоматически будет установлена РФ.</li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.<br /><br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=API_%D0%96%D0%94_%D0%A2%D0%B0%D1%80%D0%B8%D1%84_-_%D0%9E%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5_%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D0%B0_%D0%BE%D0%B1%D0%BC%D0%B5%D0%BD%D0%B0_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D0%BC%D0%B8_%D1%81_%D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%BE%D0%B9_%D1%80%D0%B0%D1%81%D1%87%D0%B5%D1%82%D0%B0_%D0%BF%D1%80%D0%BE%D0%B2%D0%BE%D0%B7%D0%BD%D0%BE%D0%B9_%D0%BF%D0%BB%D0%B0%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B6%D0%B4_%D0%BE%D1%82_%D0%90%D0%BB%D1%8C%D1%82%D0%B0-%D0%A1%D0%BE%D1%84%D1%82&diff=1216API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт2022-04-18T16:10:28Z<p>Boluchevskikh: </p>
<hr />
<div>==Описание протокола обмена данными (API) с системой расчета провозной платы на жд (жд тарифа) от Альта-Софт==<br />
<br />
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http(s), транспорт xml. <br /><br />
Все запросы в системе – GET или POST. </b><br />
<br /><br />
<b style="color:red"><br />
Для всех запросов необходимо указывать обязательный параметр - api_key. <br /><br />
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).<br />
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.<br />
</b><br />
<br /><br />
<br />
===Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) -запрос на адрес https://www.www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /><br />
index = [код или первые символы кода груза или наименование или часть наименования] <br />
<br /><br />
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fre&amp;index=011&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на &quot;011&quot; и соответствующих им грузов ГНГ)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=frg&amp;index=пшен&amp;encoding=utf-8&amp;corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит &quot;пшен&quot;. НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника станций===<br />
<br />
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.<br />
<br /><br />
Для запроса необходимо выполнить GET (POST) - запрос на адрес https://www.alta.ru/rail_tracking/rail_trf/<br />
<br />
<strong>Возможные значения type:</strong><br />
<ol><br />
<li><strong>type&nbsp;= [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /><br />
index = [код или первые символы кода станции или наименование или часть наименования], <br /><br />
<strong>&nbsp; Пример 1:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=tst&amp;index=104&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на &quot;104&quot;)<br /><br />
<strong>&nbsp; Пример 2:</strong> https://www.alta.ru/rail_tracking/rail_trf/?type=fst&amp;index=моск&amp;encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит &quot;моск&quot;. НЕ чуствителен к регистру) <br /><br />
<br /><br />
</li><br />
</ol><br />
<br />
===Выполнение запроса на выбор из справочника государств===<br />
<br />
Послать запрос вида: <br /><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=states<br />
<br />
===Выполнение запроса на получение дерева отправок и перевозочных средств=== <br />
<br />
<ol><br />
<li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств.<br />
<ul><br />
<li>kind = xml (дерево пс в виде xml, по умолчанию)</li><br />
<li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /><br />
<strong>Пример</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=van_tree&amp;kind=ul&amp;encoding=utf-8<br /><br />
<br /><br />
</li><br />
</ul><br />
</li><br />
</ol> <br />
<br />
==Расчет нитки маршрута==<br />
<br />
<ul><br />
<li>fst (обязательный) - 5-и значный код станции отправления</li><br />
<li>tst (обязательный) -5-и значный код станции назначения</li><br />
<li>route_only=1 (обязательный)<br />
<li><br />
<strong>Пример расчета нитки маршрута Нур-Султан I (КЗХ) - Силикатная (РФ)</strong><br/><br />
https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=69000&amp;tst=19100&amp;route_only=1&amp;api_key=[вставьте ваш api_key]</li><br />
</li><br />
</ul><br />
<br />
==Расчет ЖД Тарифа==<br />
<br />
<ul><br />
<li>fst- 5-и значный код станции отправления</li><br />
<li>tst -5-и значный код станции назначения</li><br />
<li>fre - 5-и значный код груза ЕТСНГ</li><br />
<li>frg - 6-и значный код груза ГНГ</li><br />
<li>fstate - код страны отправления (необязательный). Если не указан код страны отправления, то автоматически будет установлена РФ.</li><br />
<li>tstate - код страны назначения (необязательный). Если не указан код страны назначения, то автоматически будет установлена РФ.</li><br />
<li>num_vagons - количество вагонов в отправке (не обязателен). По умолчанию num_vagons=1</li><br />
<li>modular - признак сборной отправки (не обязателен). По умолчанию modular=0</li><br />
<li>w - вес груза в килограммах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры w1,w2...wN для указания веса в конкретном вагоне (см. пример ниже)</li><br />
<li>gp - грузоподъемность в тоннах. Это параметр будет установлен у всех вагонов в отправке (если num_vagons больше одного)<br /> <br />
Дополнительно допускается использовать параметры gp1,gp2...gpN для указания грузоподъемности конкретного вагона (см. пример ниже)</li><br />
<li>empt - [0|1], default - 0. Порожняя отправка - 1, груженая - 0.</li><br />
<li>return - [0|1], default - 0. Рассчитывать возврат - 1, не рассчитывать - 0.</li><br />
<li>van - код вагона из дерева перевозочных средств</li><br />
<li>owner - [0|1] default - 0. Принадлежность перевозочного средства, 0 - общего парка, 1 - собств. (арендованный)</li><br />
<li>route - [0|1], default = 1. Включить нитку маршрута в отчет - 1, не включать - 0.<br /><br />
<strong>Пример расчета отправки из 1 вагона</strong>: https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&api_key=[вставьте ваш api_key]</li><br />
<strong>Пример расчета отправки из 6 вагонов</strong>, где у всех вагонов, кроме 2-ого и 4-ого вес груза составляет 60000 кг (параметр w), у 2-ого вагона 65000 кг (параметр w2), у 4-ого вагона - 68000 кг (параметр w4). Грузоподъемность у всех вагонов равна 66 тоннам (параметр gp), кроме 6-ого вагона - 70 тонн (параметр gp6): https://www.alta.ru/rail_tracking/rail_trf/?type=calc&amp;fst=01100&amp;tst=22022&amp;fre=01100&amp;frg=10019000&amp;fstate=20&amp;tstate=20&amp;van=200&amp;w=60000&amp;gp=66&amp;owner=0&amp;return=0&amp;empt=0&num_vagons=6&w2=65000&w4=68000&gp6=70&api_key=[вставьте ваш api_key]<br />
<br /><br />
<br />
<strong>Пример расчета сборной отправки</strong>:<br />
https://www.alta.ru/rail_tracking/rail_trf/?&type=calc&fst=19350&tst=97040&fre=&frg=&fstate=20&tstate=20&num_vagons=1&van=200&w=0&gp=65&owner=0&return=0&empt=0&route=0&modular=1&fre1=12701&w1=4850&fre2=12101&w2=1500&fre3=12501&w3=32000&fre4=37101&w4=900&api_key=[вставьте ваш api_key]. Параметр modular=1, список грузов описывается параметрами: <br /><br />
fre1...freN, frg1...frgN, w1...wN, где N - кол-во грузов в сборной отправке, <br /><br />
fre1, fre2...freN - коды грузов по ЕТСНГ, <br /><br />
frg1, frg2.... frgN - коды грузов по ГНГ (необязательно, если не указаны - будет подобрано соответствие ЕТСНГ-ГНГ), <br /><br />
w1, w2...wN - соответствующие массы грузов в килограммах<br />
</ul><br />
<br />
<br />
==Получение информации о ключе (срок действия, оставшийся объем запросов)==<br />
https://www.alta.ru/rail_tracking/rail_trf/?type=key_info&api_key=[вставьте ваш api_key]<br />
<br />
==Ссылки на примеры== <br />
<br />
Протестировать все вышеописанные примеры можно на странице:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/example.php<br />
<br />
<br /><br />
Пример работы полнофункциональной страницы по выбору из справочников и расчету жд тарифа:<br /><br />
http://www.alta.ru/rail_tracking/rail_trf/demo.php</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1204JSON-API сервиса поиска вагонов2021-10-12T15:44:21Z<p>Boluchevskikh: /* Получение ответа на оперативный запрос. Метод "show". */</p>
<hr />
<div>==О сервисе==<br />
JSON-API сервиса «Поиск вагонов» позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно выполнять оперативные запросы на поиск вагонов и контейнеров по жд сетям, ставить и снимать вагоны и контейнеры на слежение по СНГ, странам Балтии, Монголии и Китаю, а также запрашивать справки ГВЦ.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET или POST. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса для поиска вагонов - всегда '''rail_tracking'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5('alta_test')") = 5ec1514f1b5a383fc5ad3f04bb9ac0e3 <br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих номеров: <br><br />
вагоны - 54676515 <br><br />
контейнеры - AMFU8899067 <br><br />
<br />
Hash для получения ответов по вагонам:<br />
- оперативный запрос 7e1019777173ff342ef500e31719572c <br><br />
- слежение ebc356dfa5beee7d3844ccacf535410c <br><br />
Cont_hash для получения ответов по контейнерам:<br />
- оперативный запрос fece39d1523836d03c3c2da73a6f1275 <br><br />
- слежение 931700e35d7ff88a10bd5d680da50f02 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом эелементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о дислокации, справки ГВЦ, список вагонов и проч.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
==Выполнение оперативного (разового) запроса. Метод "add".==<br />
Оперативный запрос выполняется единожды. Запрос в среднем обрабатывается в течение минуты. Тарифицируются только те запросы, по которым пришел ответ. Например, в запросе указано 6 вагонов, а ответ пришел только на 5. Значит с баланса спишется сумма за 5 вагонов.<br><br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||add - добавление оперативного запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067"<br />
<br />
|-<br />
|state||string||Код страны, по которой осуществляется запрос. На данный момент оперативные запросы поддерживаются только по РФ. Код=20.<br />
<br />
|-<br />
|track_type||int||Тип слежения. Для оперативного запроса track_type=1<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу в urlencode<br />
<br />
|-<br />
|emails||string||Список email-адресов, куда отправить отчет о дислокации после выполнения, через запятую.<br />
<br />
|-<br />
|email_report_type||int||Всегда 2<br />
<br />
|-<br />
|attach_excel||int||Вкладывать ли в письма копию отчета в Excel. 1 - вкладывать, 0 - не вкладывать. По умолчанию 0.<br />
<br />
|}<br />
<br />
JSON-ответ включает в себя отчет о состоянии запроса (принят/не принят в обработку) и hash, по которому можно получить ответ.<br><br />
Например, на запрос вагона 54676515 и контейнера AMFU8899067 получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "7e1019777173ff342ef500e31719572c",<br />
"group_id": 322,<br />
"cont_hash": "fece39d1523836d03c3c2da73a6f1275"<br />
}<br />
]<br />
</source><br />
<br />
Следует учитывать, что в силу особенностей обработки запросов вагоны и контейнеры обрабатываются отдельно (обычно ответ на вагоны приходит быстрее). Поэтому в ответе может быть 2 хэша.<br><br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}<br />
<br />
==Пример оперативного запроса==<br />
Запрос дислокации вагона 54676515:<br> <br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&wagons=54676515&state=20&track_type=1&comment=%D0%BA%D0%B0%D0%BA%D0%BE%D0%B9-%D1%82%D0%BE%20%D0%BA%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9<br><br />
В запросе можно комбинировать номера вагонов и контейнеров. <br><br />
Запрос дислокации вагона 54676515 и контейнера AMFU8899067: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&wagons=54676515,AMFU8899067&state=20&track_type=1&comment=%D0%BA%D0%B0%D0%BA%D0%BE%D0%B9-%D1%82%D0%BE%20%D0%BA%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9<br />
<br />
==Получение ответа на оперативный запрос. Метод "show". ==<br />
После размещения запроса он встает в очередь на обработку. Обычно обработка занимает около 1 минуты. В случае повышенной нагрузки на сервер обработка может занимать до 5 минут и более.<br />
Оптимальный период опроса сервера - 1 минута. В случае частых запросов ООО "Альта-Софт" оставляет за собой право заблокировать такие запросы и отказать в обслуживании.<br />
<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||show - просмотр дислокации по заданному hash<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например, 7e1019777173ff342ef500e31719572c<br />
<br />
|}<br />
<br />
JSON-ответ включает в себя отчет о состоянии запроса (в очереди/обрабатывается/обработан) в первом элементе массива, в последующих элементах - отчет о дислокации перевозочных средств.<br />
Например, на запрос AMFU8899067 получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Обработан",<br />
"query_status": "4",<br />
"hash": "fece39d1523836d03c3c2da73a6f1275",<br />
"type": "2",<br />
"count": 1<br />
},<br />
{<br />
"num": "AMFU8899067",<br />
"on_track": 0,<br />
"station": "24160",<br />
"station_name": "Вековка",<br />
"state": "20",<br />
"state_name": "Россия",<br />
"lon": "40.764762",<br />
"lat": "55.498762",<br />
"road_name": "Горьковская",<br />
"op_date": "2017-12-05 20:03:00",<br />
"departure_date": "2017-12-03 14:06:00",<br />
"route_start_date": "",<br />
"delivery_date": "2017-12-15 00:00:00",<br />
"etd_date": "2017-12-20:00:00",<br />
"operation": "ПРИБЫТИЕ С ПОЕЗДОМ НА СТАНЦИЮ",<br />
"nakl_nom": "",<br />
"okpo": "94421386",<br />
"owner": null,<br />
"kgro": "1386",<br />
"kgrp": "7575",<br />
"train_index": "18290-853-98130",<br />
"train_number": "1282",<br />
"fraight": "51403",<br />
"fraight_name": "Изделия кондитерские сахаристые, н.п.",<br />
"weight": "13000",<br />
"wagon_number": "94785045",<br />
"station_from": "18290",<br />
"is_loaded": 1,<br />
"hash": "ea7a000c4649388f68af14051f0827a04f11a2ee",<br />
"station_to": "98130",<br />
"station_from_name": "Тучково",<br />
"station_to_name": "Первая Речка",<br />
"route": "8928"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|-<br />
|type||string||Тип запроса. 1- вагоны, 2 - контейнеры<br />
<br />
|-<br />
|query_status||string||Состояние запроса. 1 - в очереди, 2 - обрабатывается, 3 или 4 - обработан<br />
<br />
|-<br />
|count||int||Количество перевозочных средств в отчете<br />
<br />
|-<br />
|hash||string||Хэш запроса.<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы''' (при query_status больше 2)<br />
<br />
|-<br />
|num||string||Номер перевозочного средства<br />
<br />
|-<br />
|station||string||Код станции, где была зафиксирована последняя операция с перевозочным средством. 5 символов(или 6 символов, 6-й - контрольный знак). В случае отсутствия данных по дислокации ПС значение будет "no_data".<br />
|-<br />
|station_name||string||Название станции, где была зафиксирована последняя операция с перевозочным средством. <br />
<br />
|-<br />
|op_date||string||Дата фиксирования последней операции. В формате "Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|operation||string||Наименование последней операции<br />
<br />
|-<br />
|route||string||Оставшееся до станции назначения расстояние, км<br />
<br />
|-<br />
|on_track||int||Стоит ли перевозочное средство на слежении. 1 - стоит, 0 - снят или оперативный запрос<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|state||string||Код государства станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|state_name||string||Название государства станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|lon||string||Долгота станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|lat||string||Широта станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|road_name||string||Дорога, где была зафиксирована последняя операция<br />
<br />
|-<br />
|departure_date||string||Дата отправки. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|route_start_date||string||Дата начала рейса. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|delivery_date||string||Ожидаемая дата прибытия на ст. назначения. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|etd_date||string||Ожидаемая дата доставки контейнера грузополучателю после раскредитовки. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|nakl_nom||string||Номер накладной<br />
<br />
|-<br />
|okpo||string||ОКПО отправителя<br />
<br />
|-<br />
|owner||string||Собственник перевозочного средства<br />
<br />
|-<br />
|kgro||string||Номер грузоотправителя<br />
|-<br />
<br />
|kgrp||string||Номер грузополучателя<br />
|-<br />
<br />
|train_index||string||Индекс поезда<br />
|-<br />
<br />
|train_number||string||Номер поезда<br />
|-<br />
<br />
|fraight||string||Код груза по номенклатуре ЕТСНГ<br />
|-<br />
<br />
|fraight_name||string||Наименование груза<br />
|-<br />
<br />
|weight||string||Вес груза (чаще всего в килограммах, но может быть в центнерах или тоннах)<br />
|-<br />
<br />
|wagon_number||string||Номер вагона (платформы), на котором закреплен контейнер (только для контейнерных запросов)<br />
|-<br />
<br />
|station_from||string||Код станции отправления<br />
|-<br />
<br />
|station_from_name||string||Название станции отправления<br />
|-<br />
<br />
|station_to||string||Код станции назначения<br />
|-<br />
<br />
|station_to_name||string||Название станции назначения<br />
|-<br />
<br />
|is_loaded||int||1 - груженый, 0 - порожний<br />
|-<br />
<br />
|}<br />
<br />
==Пример получения отчета на оперативный запрос.==<br />
<br />
Получить отчет по вагону 54676515 по hash=7e1019777173ff342ef500e31719572c:<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=show&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=7e1019777173ff342ef500e31719572c<br />
<br />
==Постановка вагонов/контейнеров на слежение. Метод "add" с доп. параметрами.==<br />
Постановка на слежение аналогично оперативному запросу, т.е. выполняется с помощью метода "add". Существенное различие в дополнительных параметрах, их значениях и поведении системы при слежении.<br><br />
Существует несколько регионов слежения: РФ, СНГ и Балтия, СНГ и Балтия + Китай + Монголия. Ниже описаны основные отличия и особенности:<br><br />
- Основное отличие от оперативного запроса - во времени отклика системы. Если выполнив оперативный запрос ответ будет получен в течение минуты (в среднем), то при слежении ответ может формироваться довольно продолжительное время: от 10 минут по РФ до нескольких часов по странам Средней Азии и Китаю. <br />
- В течение суток можно получить до 3-х обновлений дислокации за одну цену, в то время как <b>каждый</b> оперативный запрос тарифицируется.<br />
- Стоимость слежения по РФ значительно ниже слежения по другим регионам. Однако, в случае пересечения перевозочного средства границы нет никаких гарантий, что свежая информация продолжит поступать.<br />
- Слежение по СНГ и Балтии, Китаю и Монголии позволяет получать дислокацию по всем перечисленным регионам, независимо от того, где находится ПС<br />
- При постановке ПС на слежение задается регламент получения отчетов - в какой день недели и какое время удобно получать свежую информацию, а также способ снятия со слежения (ручной или автоматический)<br />
- Существуют 2 типа слежения: посуточное и рейс. Единственное отличие между ними - в способе тарификации. Посуточное слежение - это такой тип слежения, когда денежные средства списываются со счета клиента при очередном формировании отчета (т.е. первом отчете за сутки согласно расписанию). Рейс тарифицируется сразу за весь маршрут при постановке на слежение и нет необходимости следить за состоянием баланса.<br />
- По hash оперативного запроса не идет обновление информации, т.е. информация о дислокации актуальна только на момент получения ответа. Для слежения информация по hash будет постоянно обновляться до окончания слежения. <br />
Ниже приводится полный список входных параметров. Жирным шрифтом отмечены те из них, которых или нет в оперативном запросе, или их значению следует уделить внимание при постановке на слежение:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||add - добавление оперативного запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067"<br />
<br />
|-<br />
|<b>state</b>||string||Код страны, по которой осуществляется запрос. Для РФ - 20. По странам СНГ и Балтии, Монголии, Китаю - 22.<br />
<br />
|-<br />
|<b>track_state</b>||string||Регион слежения. ru - только Россия, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|<b>track_type</b>||int||Тип слежения. Для посуточного слежения запроса track_type=2, для рейса - track_type=3<br />
<br />
|-<br />
|<b>stop_station</b>||string||Снимать ли со слежения по прибытию на станцию назначения. "yes" - снимать, "no" - не снимать. Если указать <код ЕСР> - снимать по прибытию на станцию с кодом <код ЕСР>. Код ЕСР - 5-и значный код станции согласно Единой Сетевой Разметке (ЕСР). <br />
<br />
|-<br />
|<b>times</b>||string||Время обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Формат: "H:i", через запятую. Например: "09:00,13:00,18:00". Время московское. <br />
<br />
|-<br />
|<b>times_per_day</b>||string||Количество обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Если указано, что times меньше times_per_day, то times имеет больший приоритет. Например, times_per_day="2", a times="09:00,13:00,18:00", то отчет будет сформирован только в первое время и второе время, т.е. в 09:00 и в 13:00.<br />
<br />
|-<br />
|<b>days</b>||string||Дни недели, по которым необходимо получать отчет, через запятую. Номера начинаются с нуля (Воскресенье) до 6 (Суббота). Например, если отчеты необходимы по будням, то days="1,2,3,4,5". <br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу в urlencode<br />
<br />
|-<br />
|emails||string||Список email-адресов, куда отправить отчет о дислокации после выполнения, через запятую.<br />
<br />
|-<br />
|email_report_type||int||Всегда 2<br />
<br />
|-<br />
|attach_excel||int||Вкладывать ли в письма копию отчета в Excel. 1 - вкладывать, 0 - не вкладывать. По умолчанию 0.<br />
<br />
|}<br />
<br />
==Пример постановки на слежение==<br />
Контейнер AMFU8899067, получение инфорамции по будням дням (days=1,2,3,4,5) в 09:00 и 13:00 по московскому времени (times=09:00,13:00 и times_per_day=2), регион - только РФ (track_state=ru, state=20) без снятия со слежения по прибытии на станцию назначения (stop_station=no, т.е. ручное снятие), адреса для рассылки отчетов alta@alta.ru,mymail@mymail.com (emails=alta@alta.ru,mymail@mymail.com):<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&wagons=AMFU8899067&state=20&track_type=2&comment=%D0%BF%D0%B5%D1%80%D0%B2%D0%BE%D0%B5+%D1%81%D0%BB%D0%B5%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5+%28%D0%BA%D0%BE%D0%BD%D1%82%29&days=1,2,3,4,5&times_per_day=2&times=09:00,13:00&track_state=ru&stop_station=no&emails=alta@alta.ru,mymail@mymail.com<br />
<br><br />
JSON-ответ включает в себя отчет о состоянии запроса на слежение (поставлен/не поставлен на слежение) и hash, по которому можно получить ответ.<br><br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"cont_hash": "931700e35d7ff88a10bd5d680da50f02"<br />
}<br />
]<br />
</source><br />
<br />
При постановке вагона на слежение получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c"<br />
}<br />
]<br />
</source><br />
<br />
Поля hash и cont_hash аналогичны таковым для оперативного запроса. Однако, их можно использовать для получения <b>текущей</b> дислокации (согласно расписанию).<br />
<br />
==Получение ответа на ПС, стоящих на слежении. Метод "show". ==<br />
После размещения запроса он встает в очередь на обработку. В обозначенный момент времени (по расписанию) запрос выполняется. Обычно обработка запроса на слежение занимает около 1 минуты. В случае повышенной нагрузки на сервер обработка может занимать до 5 минут и более. <br><br />
Оптимальный период опроса сервера - 1 минута. В случае частых запросов ООО "Альта-Софт" оставляет за собой право заблокировать такие запросы и отказать в обслуживании. <br><br />
Для получение последней дислокации необходимо вызвать метод "show", полностью аналогичный таковому для оперативного запроса. <br><br><br />
Например, для получения дислокации контейнера AMFU8899067: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=show&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
==Снятие со слежения. Метод cancel_track.==<br />
<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||cancel_track - снятие со слежения запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например, ebc356dfa5beee7d3844ccacf535410c<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. В случае указания списка со слежения будут сняты только те ПС, которые в нем указаны, а не весь запрос. Например, "54676515"<br />
<br />
|}<br />
<br />
== Пример снятия со слежения==<br />
Снять со слежения вагон 54676515 из запроса с hash ebc356dfa5beee7d3844ccacf535410c<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=ebc356dfa5beee7d3844ccacf535410c&wagons=54676515<br />
<br />
Снять со слежения '''весь''' (т.е. все перевозочные средства из запроса) запрос с hash 931700e35d7ff88a10bd5d680da50f02<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Обратите внимание, что для тестовых данных ответ на запрос снятия со слежения будет "успешно", однако фактически запросы останутся на слежении.<br />
<br />
== Получение списка запросов на слежении. Метод "track_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||track_list - список запросов, стоящих на слежении<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=track_list&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"name": "первое слежение",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c",<br />
"modify_date": "29.07.2021 21:52",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
},<br />
{<br />
"name": "первое слежение (конт)",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "931700e35d7ff88a10bd5d680da50f02",<br />
"modify_date": "03.08.2021 13:10",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу<br />
<br />
|-<br />
|vagon_count||string||Количество ПС в запросе<br />
<br />
|-<br />
|email||string||Адреса электронной почты для рассылки отчетов о дислокации, через запятую.<br />
<br />
|-<br />
|hash||string||Hash запроса.<br />
<br />
|-<br />
|modify_date||string||Дата последнего изменения/выполнения запроса.<br />
<br />
|-<br />
|on_track||string||Стоит ли запрос на слежении. 1 - стоит, 0 - снят.<br />
<br />
|-<br />
|track_type||string||Тип слежения. 1 - постоянное, 2 - рейс. Обратите внимание, нумерация в данном случае отличае от таковой при постановке на слежение./<br />
<br />
|-<br />
|track_state||string||Регион слежения. ru - только РФ, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|state||string||Государство слежения. 20 - РФ, 22 - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|status||int||Статус обработки запроса. 1 - в очереди на обработку, 2 - обрабатывается, 3,4 - обработан<br />
<br />
|}<br />
<br />
== Получение списка ПС в запросе. Метод "carr_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||carr_list - список номеров перевозочных средств в запросе<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например 931700e35d7ff88a10bd5d680da50f02<br />
<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=carr_list&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"group_id": 1519743,<br />
"carrs": [<br />
"AMFU8899067"<br />
]<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|carrs||string||Массив номеров перевозочных средств в запросе<br />
<br />
|}<br />
<br />
== Получение баланса. Метод "balance"==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||balance - остаток денежных средств или бонусов на счету <br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=balance&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
Json-ответ<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Ваш баланс: 0.00 руб. / Бонусы 0",<br />
"balans": "0.00",<br />
"bonus": 0,<br />
"sa": "sa000000"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Остаток денежных средств/бонусов в текстовом виде<br />
<br />
|-<br />
|balans||string||Остаток денежных средств в рублях<br />
<br />
|-<br />
|bonus||string||Остаток бонусов<br />
<br />
|-<br />
|sa||string||Номер договора (сервис-аккаунта)<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1200JSON-API сервиса поиска вагонов2021-08-06T12:54:12Z<p>Boluchevskikh: </p>
<hr />
<div>==О сервисе==<br />
JSON-API сервиса «Поиск вагонов» позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно выполнять оперативные запросы на поиск вагонов и контейнеров по жд сетям, ставить и снимать вагоны и контейнеры на слежение по СНГ, странам Балтии, Монголии и Китаю, а также запрашивать справки ГВЦ.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET или POST. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса для поиска вагонов - всегда '''rail_tracking'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5('alta_test')") = 5ec1514f1b5a383fc5ad3f04bb9ac0e3 <br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих номеров: <br><br />
вагоны - 54676515 <br><br />
контейнеры - AMFU8899067 <br><br />
<br />
Hash для получения ответов по вагонам:<br />
- оперативный запрос 7e1019777173ff342ef500e31719572c <br><br />
- слежение ebc356dfa5beee7d3844ccacf535410c <br><br />
Cont_hash для получения ответов по контейнерам:<br />
- оперативный запрос fece39d1523836d03c3c2da73a6f1275 <br><br />
- слежение 931700e35d7ff88a10bd5d680da50f02 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки. В первом эелементе также может содержаться набор дополнительных необязательных полей в зависимости от вызываемого метода.<br><br />
Последующие элементы - тело ответа, содержащие информацию о дислокации, справки ГВЦ, список вагонов и проч.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
==Выполнение оперативного (разового) запроса. Метод "add".==<br />
Оперативный запрос выполняется единожды. Запрос в среднем обрабатывается в течение минуты. Тарифицируются только те запросы, по которым пришел ответ. Например, в запросе указано 6 вагонов, а ответ пришел только на 5. Значит с баланса спишется сумма за 5 вагонов.<br><br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||add - добавление оперативного запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067"<br />
<br />
|-<br />
|state||string||Код страны, по которой осуществляется запрос. На данный момент оперативные запросы поддерживаются только по РФ. Код=20.<br />
<br />
|-<br />
|track_type||int||Тип слежения. Для оперативного запроса track_type=1<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу в urlencode<br />
<br />
|-<br />
|emails||string||Список email-адресов, куда отправить отчет о дислокации после выполнения, через запятую.<br />
<br />
|-<br />
|email_report_type||int||Всегда 2<br />
<br />
|-<br />
|attach_excel||int||Вкладывать ли в письма копию отчета в Excel. 1 - вкладывать, 0 - не вкладывать. По умолчанию 0.<br />
<br />
|}<br />
<br />
JSON-ответ включает в себя отчет о состоянии запроса (принят/не принят в обработку) и hash, по которому можно получить ответ.<br><br />
Например, на запрос вагона 54676515 и контейнера AMFU8899067 получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "7e1019777173ff342ef500e31719572c",<br />
"group_id": 322,<br />
"cont_hash": "fece39d1523836d03c3c2da73a6f1275"<br />
}<br />
]<br />
</source><br />
<br />
Следует учитывать, что в силу особенностей обработки запросов вагоны и контейнеры обрабатываются отдельно (обычно ответ на вагоны приходит быстрее). Поэтому в ответе может быть 2 хэша.<br><br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}<br />
<br />
==Пример оперативного запроса==<br />
Запрос дислокации вагона 54676515:<br> <br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&wagons=54676515&state=20&track_type=1&comment=%D0%BA%D0%B0%D0%BA%D0%BE%D0%B9-%D1%82%D0%BE%20%D0%BA%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9<br><br />
В запросе можно комбинировать номера вагонов и контейнеров. <br><br />
Запрос дислокации вагона 54676515 и контейнера AMFU8899067: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&wagons=54676515,AMFU8899067&state=20&track_type=1&comment=%D0%BA%D0%B0%D0%BA%D0%BE%D0%B9-%D1%82%D0%BE%20%D0%BA%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9<br />
<br />
==Получение ответа на оперативный запрос. Метод "show". ==<br />
После размещения запроса он встает в очередь на обработку. Обычно обработка занимает около 1 минуты. В случае повышенной нагрузки на сервер обработка может занимать до 5 минут и более.<br />
Оптимальный период опроса сервера - 1 минута. В случае частых запросов ООО "Альта-Софт" оставляет за собой право заблокировать такие запросы и отказать в обслуживании.<br />
<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||show - просмотр дислокации по заданному hash<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например, 7e1019777173ff342ef500e31719572c<br />
<br />
|}<br />
<br />
JSON-ответ включает в себя отчет о состоянии запроса (в очереди/обрабатывается/обработан) в первом элементе массива, в последующих элементах - отчет о дислокации перевозочных средств.<br />
Например, на запрос AMFU8899067 получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Обработан",<br />
"query_status": "4",<br />
"hash": "fece39d1523836d03c3c2da73a6f1275",<br />
"type": "2",<br />
"count": 1<br />
},<br />
{<br />
"num": "AMFU8899067",<br />
"on_track": 0,<br />
"station": "24160",<br />
"station_name": "Вековка",<br />
"state": "20",<br />
"state_name": "Россия",<br />
"lon": "40.764762",<br />
"lat": "55.498762",<br />
"road_name": "Горьковская",<br />
"op_date": "2017-12-05 20:03:00",<br />
"departure_date": "2017-12-03 14:06:00",<br />
"route_start_date": "",<br />
"operation": "ПРИБЫТИЕ С ПОЕЗДОМ НА СТАНЦИЮ",<br />
"nakl_nom": "",<br />
"okpo": "94421386",<br />
"owner": null,<br />
"kgro": "1386",<br />
"kgrp": "7575",<br />
"train_index": "18290-853-98130",<br />
"train_number": "1282",<br />
"fraight": "51403",<br />
"fraight_name": "Изделия кондитерские сахаристые, н.п.",<br />
"weight": "13000",<br />
"wagon_number": "94785045",<br />
"station_from": "18290",<br />
"is_loaded": 1,<br />
"hash": "ea7a000c4649388f68af14051f0827a04f11a2ee",<br />
"station_to": "98130",<br />
"station_from_name": "Тучково",<br />
"station_to_name": "Первая Речка",<br />
"route": "8928"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|-<br />
|type||string||Тип запроса. 1- вагоны, 2 - контейнеры<br />
<br />
|-<br />
|query_status||string||Состояние запроса. 1 - в очереди, 2 - обрабатывается, 3 или 4 - обработан<br />
<br />
|-<br />
|count||int||Количество перевозочных средств в отчете<br />
<br />
|-<br />
|hash||string||Хэш запроса.<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы''' (при query_status больше 2)<br />
<br />
|-<br />
|num||string||Номер перевозочного средства<br />
<br />
|-<br />
|station||string||Код станции, где была зафиксирована последняя операция с перевозочным средством. 5 символов(или 6 символов, 6-й - контрольный знак). В случае отсутствия данных по дислокации ПС значение будет "no_data".<br />
|-<br />
|station_name||string||Название станции, где была зафиксирована последняя операция с перевозочным средством. <br />
<br />
|-<br />
|op_date||string||Дата фиксирования последней операции. В формате "Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|operation||string||Наименование последней операции<br />
<br />
|-<br />
|route||string||Оставшееся до станции назначения расстояние, км<br />
<br />
|-<br />
|on_track||int||Стоит ли перевозочное средство на слежении. 1 - стоит, 0 - снят или оперативный запрос<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|state||string||Код государства станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|state_name||string||Название государства станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|lon||string||Долгота станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|lat||string||Широта станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|road_name||string||Дорога, где была зафиксирована последняя операция<br />
<br />
|-<br />
|departure_date||string||Дата отправки. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|route_start_date||string||Дата начала рейса. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|nakl_nom||string||Номер накладной<br />
<br />
|-<br />
|okpo||string||ОКПО отправителя<br />
<br />
|-<br />
|owner||string||Собственник перевозочного средства<br />
<br />
|-<br />
|kgro||string||Номер грузоотправителя<br />
|-<br />
<br />
|kgrp||string||Номер грузополучателя<br />
|-<br />
<br />
|train_index||string||Индекс поезда<br />
|-<br />
<br />
|train_number||string||Номер поезда<br />
|-<br />
<br />
|fraight||string||Код груза по номенклатуре ЕТСНГ<br />
|-<br />
<br />
|fraight_name||string||Наименование груза<br />
|-<br />
<br />
|weight||string||Вес груза (чаще всего в килограммах, но может быть в центнерах или тоннах)<br />
|-<br />
<br />
|wagon_number||string||Номер вагона (платформы), на котором закреплен контейнер (только для контейнерных запросов)<br />
|-<br />
<br />
|station_from||string||Код станции отправления<br />
|-<br />
<br />
|station_from_name||string||Название станции отправления<br />
|-<br />
<br />
|station_to||string||Код станции назначения<br />
|-<br />
<br />
|station_to_name||string||Название станции назначения<br />
|-<br />
<br />
|is_loaded||int||1 - груженый, 0 - порожний<br />
|-<br />
<br />
|}<br />
<br />
==Пример получения отчета на оперативный запрос.==<br />
<br />
Получить отчет по вагону 54676515 по hash=7e1019777173ff342ef500e31719572c:<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=show&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=7e1019777173ff342ef500e31719572c<br />
<br />
==Постановка вагонов/контейнеров на слежение. Метод "add" с доп. параметрами.==<br />
Постановка на слежение аналогично оперативному запросу, т.е. выполняется с помощью метода "add". Существенное различие в дополнительных параметрах, их значениях и поведении системы при слежении.<br><br />
Существует несколько регионов слежения: РФ, СНГ и Балтия, СНГ и Балтия + Китай + Монголия. Ниже описаны основные отличия и особенности:<br><br />
- Основное отличие от оперативного запроса - во времени отклика системы. Если выполнив оперативный запрос ответ будет получен в течение минуты (в среднем), то при слежении ответ может формироваться довольно продолжительное время: от 10 минут по РФ до нескольких часов по странам Средней Азии и Китаю. <br />
- В течение суток можно получить до 3-х обновлений дислокации за одну цену, в то время как <b>каждый</b> оперативный запрос тарифицируется.<br />
- Стоимость слежения по РФ значительно ниже слежения по другим регионам. Однако, в случае пересечения перевозочного средства границы нет никаких гарантий, что свежая информация продолжит поступать.<br />
- Слежение по СНГ и Балтии, Китаю и Монголии позволяет получать дислокацию по всем перечисленным регионам, независимо от того, где находится ПС<br />
- При постановке ПС на слежение задается регламент получения отчетов - в какой день недели и какое время удобно получать свежую информацию, а также способ снятия со слежения (ручной или автоматический)<br />
- Существуют 2 типа слежения: посуточное и рейс. Единственное отличие между ними - в способе тарификации. Посуточное слежение - это такой тип слежения, когда денежные средства списываются со счета клиента при очередном формировании отчета (т.е. первом отчете за сутки согласно расписанию). Рейс тарифицируется сразу за весь маршрут при постановке на слежение и нет необходимости следить за состоянием баланса.<br />
- По hash оперативного запроса не идет обновление информации, т.е. информация о дислокации актуальна только на момент получения ответа. Для слежения информация по hash будет постоянно обновляться до окончания слежения. <br />
Ниже приводится полный список входных параметров. Жирным шрифтом отмечены те из них, которых или нет в оперативном запросе, или их значению следует уделить внимание при постановке на слежение:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||add - добавление оперативного запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067"<br />
<br />
|-<br />
|<b>state</b>||string||Код страны, по которой осуществляется запрос. Для РФ - 20. По странам СНГ и Балтии, Монголии, Китаю - 22.<br />
<br />
|-<br />
|<b>track_state</b>||string||Регион слежения. ru - только Россия, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|<b>track_type</b>||int||Тип слежения. Для посуточного слежения запроса track_type=2, для рейса - track_type=3<br />
<br />
|-<br />
|<b>stop_station</b>||string||Снимать ли со слежения по прибытию на станцию назначения. "yes" - снимать, "no" - не снимать. Если указать <код ЕСР> - снимать по прибытию на станцию с кодом <код ЕСР>. Код ЕСР - 5-и значный код станции согласно Единой Сетевой Разметке (ЕСР). <br />
<br />
|-<br />
|<b>times</b>||string||Время обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Формат: "H:i", через запятую. Например: "09:00,13:00,18:00". Время московское. <br />
<br />
|-<br />
|<b>times_per_day</b>||string||Количество обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Если указано, что times меньше times_per_day, то times имеет больший приоритет. Например, times_per_day="2", a times="09:00,13:00,18:00", то отчет будет сформирован только в первое время и второе время, т.е. в 09:00 и в 13:00.<br />
<br />
|-<br />
|<b>days</b>||string||Дни недели, по которым необходимо получать отчет, через запятую. Номера начинаются с нуля (Воскресенье) до 6 (Суббота). Например, если отчеты необходимы по будням, то days="1,2,3,4,5". <br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу в urlencode<br />
<br />
|-<br />
|emails||string||Список email-адресов, куда отправить отчет о дислокации после выполнения, через запятую.<br />
<br />
|-<br />
|email_report_type||int||Всегда 2<br />
<br />
|-<br />
|attach_excel||int||Вкладывать ли в письма копию отчета в Excel. 1 - вкладывать, 0 - не вкладывать. По умолчанию 0.<br />
<br />
|}<br />
<br />
==Пример постановки на слежение==<br />
Контейнер AMFU8899067, получение инфорамции по будням дням (days=1,2,3,4,5) в 09:00 и 13:00 по московскому времени (times=09:00,13:00 и times_per_day=2), регион - только РФ (track_state=ru, state=20) без снятия со слежения по прибытии на станцию назначения (stop_station=no, т.е. ручное снятие), адреса для рассылки отчетов alta@alta.ru,mymail@mymail.com (emails=alta@alta.ru,mymail@mymail.com):<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&wagons=AMFU8899067&state=20&track_type=2&comment=%D0%BF%D0%B5%D1%80%D0%B2%D0%BE%D0%B5+%D1%81%D0%BB%D0%B5%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5+%28%D0%BA%D0%BE%D0%BD%D1%82%29&days=1,2,3,4,5&times_per_day=2&times=09:00,13:00&track_state=ru&stop_station=no&emails=alta@alta.ru,mymail@mymail.com<br />
<br><br />
JSON-ответ включает в себя отчет о состоянии запроса на слежение (поставлен/не поставлен на слежение) и hash, по которому можно получить ответ.<br><br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"cont_hash": "931700e35d7ff88a10bd5d680da50f02"<br />
}<br />
]<br />
</source><br />
<br />
При постановке вагона на слежение получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c"<br />
}<br />
]<br />
</source><br />
<br />
Поля hash и cont_hash аналогичны таковым для оперативного запроса. Однако, их можно использовать для получения <b>текущей</b> дислокации (согласно расписанию).<br />
<br />
==Получение ответа на ПС, стоящих на слежении. Метод "show". ==<br />
После размещения запроса он встает в очередь на обработку. В обозначенный момент времени (по расписанию) запрос выполняется. Обычно обработка запроса на слежение занимает около 1 минуты. В случае повышенной нагрузки на сервер обработка может занимать до 5 минут и более. <br><br />
Оптимальный период опроса сервера - 1 минута. В случае частых запросов ООО "Альта-Софт" оставляет за собой право заблокировать такие запросы и отказать в обслуживании. <br><br />
Для получение последней дислокации необходимо вызвать метод "show", полностью аналогичный таковому для оперативного запроса. <br><br><br />
Например, для получения дислокации контейнера AMFU8899067: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=show&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
==Снятие со слежения. Метод cancel_track.==<br />
<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||cancel_track - снятие со слежения запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например, ebc356dfa5beee7d3844ccacf535410c<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. В случае указания списка со слежения будут сняты только те ПС, которые в нем указаны, а не весь запрос. Например, "54676515"<br />
<br />
|}<br />
<br />
== Пример снятия со слежения==<br />
Снять со слежения вагон 54676515 из запроса с hash ebc356dfa5beee7d3844ccacf535410c<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=ebc356dfa5beee7d3844ccacf535410c&wagons=54676515<br />
<br />
Снять со слежения '''весь''' (т.е. все перевозочные средства из запроса) запрос с hash 931700e35d7ff88a10bd5d680da50f02<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Обратите внимание, что для тестовых данных ответ на запрос снятия со слежения будет "успешно", однако фактически запросы останутся на слежении.<br />
<br />
== Получение списка запросов на слежении. Метод "track_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||track_list - список запросов, стоящих на слежении<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=track_list&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"name": "первое слежение",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c",<br />
"modify_date": "29.07.2021 21:52",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
},<br />
{<br />
"name": "первое слежение (конт)",<br />
"comment": null,<br />
"vagon_count": "1",<br />
"email": "",<br />
"phone": "",<br />
"hash": "931700e35d7ff88a10bd5d680da50f02",<br />
"modify_date": "03.08.2021 13:10",<br />
"on_track": "1",<br />
"track_type": "1",<br />
"state": "20",<br />
"track_state": "ru",<br />
"status": 4,<br />
"type": "group"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу<br />
<br />
|-<br />
|vagon_count||string||Количество ПС в запросе<br />
<br />
|-<br />
|email||string||Адреса электронной почты для рассылки отчетов о дислокации, через запятую.<br />
<br />
|-<br />
|hash||string||Hash запроса.<br />
<br />
|-<br />
|modify_date||string||Дата последнего изменения/выполнения запроса.<br />
<br />
|-<br />
|on_track||string||Стоит ли запрос на слежении. 1 - стоит, 0 - снят.<br />
<br />
|-<br />
|track_type||string||Тип слежения. 1 - постоянное, 2 - рейс. Обратите внимание, нумерация в данном случае отличае от таковой при постановке на слежение./<br />
<br />
|-<br />
|track_state||string||Регион слежения. ru - только РФ, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|state||string||Государство слежения. 20 - РФ, 22 - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|status||int||Статус обработки запроса. 1 - в очереди на обработку, 2 - обрабатывается, 3,4 - обработан<br />
<br />
|}<br />
<br />
== Получение списка ПС в запросе. Метод "carr_list". ==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||carr_list - список номеров перевозочных средств в запросе<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например 931700e35d7ff88a10bd5d680da50f02<br />
<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=carr_list&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Json-ответ:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok"<br />
},<br />
{<br />
"group_id": 1519743,<br />
"carrs": [<br />
"AMFU8899067"<br />
]<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы'''<br />
<br />
|-<br />
|carrs||string||Массив номеров перевозочных средств в запросе<br />
<br />
|}<br />
<br />
== Получение баланса. Метод "balance"==<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||balance - остаток денежных средств или бонусов на счету <br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|}<br />
Например: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=balance&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
Json-ответ<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Ваш баланс: 0.00 руб. / Бонусы 0",<br />
"balans": "0.00",<br />
"bonus": 0,<br />
"sa": "sa000000"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Остаток денежных средств/бонусов в текстовом виде<br />
<br />
|-<br />
|balans||string||Остаток денежных средств в рублях<br />
<br />
|-<br />
|bonus||string||Остаток бонусов<br />
<br />
|-<br />
|sa||string||Номер договора (сервис-аккаунта)<br />
<br />
|}</div>Boluchevskikhhttps://wiki.alta.ru/index.php?title=JSON-API_%D1%81%D0%B5%D1%80%D0%B2%D0%B8%D1%81%D0%B0_%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0_%D0%B2%D0%B0%D0%B3%D0%BE%D0%BD%D0%BE%D0%B2&diff=1199JSON-API сервиса поиска вагонов2021-08-03T12:10:18Z<p>Boluchevskikh: /* Пример постановки на слежение */</p>
<hr />
<div>==О сервисе==<br />
JSON-API сервиса «Поиск вагонов» позволяет интегрировать возможности сервиса в сторонние программы и сайты.<br />
Посредством данного API можно выполнять оперативные запросы на поиск вагонов и контейнеров по жд сетям, ставить и снимать вагоны и контейнеры на слежение по СНГ, странам Балтии, Монголии и Китаю, а также запрашивать справки ГВЦ.<br />
Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".<br />
<br />
==API. Авторизация. Метод "test_secret". ==<br />
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET или POST. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.<br />
<br />
'''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + технический пароль''', разделенный знаком двоеточия «:». <br><br />
Символьное обозначение сервиса для поиска вагонов - всегда '''rail_tracking'''.<br><br />
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'<br><br />
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br><br />
Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5('alta_test')") = 5ec1514f1b5a383fc5ad3f04bb9ac0e3 <br><br />
<br />
Для выполнения любого запроса необходимо указать название метода (action) и авторизационные данные.<br><br />
Например, для проверки корректности генерации секрета необходимо выполнить запрос:<br />
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
В json-ответе будет <code>{"status":"ok"}</code> в случае корректного секрета, в противном случае <code>{"status":"error"}</code><br />
<br />
==Тестирование JSON-API==<br />
Для тестирования сервиса используйте следующие авторизационные данные:<br><br />
Логин: alta@alta.ru <br><br />
Технический пароль: alta_test <br><br />
Сервис-аккаунт (договор): sa000000<br />
<br />
Выполнение тестовых запросов возможно только для следующих номеров: <br><br />
вагоны - 54676515 <br><br />
контейнеры - AMFU8899067 <br><br />
<br />
Hash для получения ответов по вагонам:<br />
- оперативный запрос 7e1019777173ff342ef500e31719572c <br><br />
- слежение ebc356dfa5beee7d3844ccacf535410c <br><br />
Cont_hash для получения ответов по контейнерам:<br />
- оперативный запрос fece39d1523836d03c3c2da73a6f1275 <br><br />
- слежение 931700e35d7ff88a10bd5d680da50f02 <br><br />
<br />
==Структура ответа и статус запроса==<br />
Ответ на запроса для всех методов, за исключением test_secret, представляет из себя json-массив. Первый элемент массива - всегда статус запроса с текстовым описанием состояния или ошибки.<br><br />
Последующие элементы - тело ответа, содержащие информацию о дислокации, справки ГВЦ, список вагонов и проч.<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен"<br />
}<br />
]<br />
</source><br />
<br />
или в случае ошибки ответ будет дополнен кодом ошибки Code (коды ошибок см. ниже)<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "error",<br />
"descr": "Указан неподдерживаемый метод",<br />
"code": 15<br />
}<br />
]<br />
</source><br />
<br />
==Выполнение оперативного (разового) запроса. Метод "add".==<br />
Оперативный запрос выполняется единожды. Запрос в среднем обрабатывается в течение минуты. Тарифицируются только те запросы, по которым пришел ответ. Например, в запросе указано 6 вагонов, а ответ пришел только на 5. Значит с баланса спишется сумма за 5 вагонов.<br><br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||add - добавление оперативного запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067"<br />
<br />
|-<br />
|state||string||Код страны, по которой осуществляется запрос. На данный момент оперативные запросы поддерживаются только по РФ. Код=20.<br />
<br />
|-<br />
|track_type||int||Тип слежения. Для оперативного запроса track_type=1<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу в urlencode<br />
<br />
|-<br />
|emails||string||Список email-адресов, куда отправить отчет о дислокации после выполнения, через запятую.<br />
<br />
|-<br />
|email_report_type||int||Всегда 2<br />
<br />
|-<br />
|attach_excel||int||Вкладывать ли в письма копию отчета в Excel. 1 - вкладывать, 0 - не вкладывать. По умолчанию 0.<br />
<br />
|}<br />
<br />
JSON-ответ включает в себя отчет о состоянии запроса (принят/не принят в обработку) и hash, по которому можно получить ответ.<br><br />
Например, на запрос вагона 54676515 и контейнера AMFU8899067 получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "7e1019777173ff342ef500e31719572c",<br />
"group_id": 322,<br />
"cont_hash": "fece39d1523836d03c3c2da73a6f1275"<br />
}<br />
]<br />
</source><br />
<br />
Следует учитывать, что в силу особенностей обработки запросов вагоны и контейнеры обрабатываются отдельно (обычно ответ на вагоны приходит быстрее). Поэтому в ответе может быть 2 хэша.<br><br />
<br />
Выходные параметры json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|status||string||ok - при успешном размещении запроса, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|hash||string||Хэш запроса по вагонам (если они были в запросе)<br />
<br />
|-<br />
|cont_hash||string||Хэш запроса по контейнерам (если они были в запросе)<br />
<br />
|}<br />
<br />
==Пример оперативного запроса==<br />
Запрос дислокации вагона 54676515:<br> <br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&wagons=54676515&state=20&track_type=1&comment=%D0%BA%D0%B0%D0%BA%D0%BE%D0%B9-%D1%82%D0%BE%20%D0%BA%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9<br><br />
В запросе можно комбинировать номера вагонов и контейнеров. <br><br />
Запрос дислокации вагона 54676515 и контейнера AMFU8899067: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&wagons=54676515,AMFU8899067&state=20&track_type=1&comment=%D0%BA%D0%B0%D0%BA%D0%BE%D0%B9-%D1%82%D0%BE%20%D0%BA%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B9<br />
<br />
==Получение ответа на оперативный запрос. Метод "show". ==<br />
После размещения запроса он встает в очередь на обработку. Обычно обработка занимает около 1 минуты. В случае повышенной нагрузки на сервер обработка может занимать до 5 минут и более.<br />
Оптимальный период опроса сервера - 1 минута. В случае частых запросов ООО "Альта-Софт" оставляет за собой право заблокировать такие запросы и отказать в обслуживании.<br />
<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||show - просмотр дислокации по заданному hash<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например, 7e1019777173ff342ef500e31719572c<br />
<br />
|}<br />
<br />
JSON-ответ включает в себя отчет о состоянии запроса (в очереди/обрабатывается/обработан) в первом элементе массива, в последующих элементах - отчет о дислокации перевозочных средств.<br />
Например, на запрос AMFU8899067 получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Обработан",<br />
"query_status": "4",<br />
"hash": "fece39d1523836d03c3c2da73a6f1275",<br />
"type": "2",<br />
"count": 1<br />
},<br />
{<br />
"num": "AMFU8899067",<br />
"on_track": 0,<br />
"station": "24160",<br />
"station_name": "Вековка",<br />
"state": "20",<br />
"state_name": "Россия",<br />
"lon": "40.764762",<br />
"lat": "55.498762",<br />
"road_name": "Горьковская",<br />
"op_date": "2017-12-05 20:03:00",<br />
"departure_date": "2017-12-03 14:06:00",<br />
"route_start_date": "",<br />
"operation": "ПРИБЫТИЕ С ПОЕЗДОМ НА СТАНЦИЮ",<br />
"nakl_nom": "",<br />
"okpo": "94421386",<br />
"owner": null,<br />
"kgro": "1386",<br />
"kgrp": "7575",<br />
"train_index": "18290-853-98130",<br />
"train_number": "1282",<br />
"fraight": "51403",<br />
"fraight_name": "Изделия кондитерские сахаристые, н.п.",<br />
"weight": "13000",<br />
"wagon_number": "94785045",<br />
"station_from": "18290",<br />
"is_loaded": 1,<br />
"hash": "ea7a000c4649388f68af14051f0827a04f11a2ee",<br />
"station_to": "98130",<br />
"station_from_name": "Тучково",<br />
"station_to_name": "Первая Речка",<br />
"route": "8928"<br />
}<br />
]<br />
</source><br />
<br />
Выходные поля json-массива:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Поле !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|- highlight<br />
|colspan=3 |'''1-й элемент'''<br />
<br />
|-<br />
|status||string||ok - при успешном получении данных, error или fail - при ошибке. Список кодов ошибок см. ниже.<br />
<br />
|-<br />
|descr||string||Текстовое описание состояния или ошибки<br />
<br />
|-<br />
|type||string||Тип запроса. 1- вагоны, 2 - контейнеры<br />
<br />
|-<br />
|query_status||string||Состояние запроса. 1 - в очереди, 2 - обрабатывается, 3 или 4 - обработан<br />
<br />
|-<br />
|count||int||Количество перевозочных средств в отчете<br />
<br />
|-<br />
|hash||string||Хэш запроса.<br />
<br />
|- highlight<br />
|colspan=3 |'''Последующие эелементы''' (при query_status больше 2)<br />
<br />
|-<br />
|num||string||Номер перевозочного средства<br />
<br />
|-<br />
|station||string||Код станции, где была зафиксирована последняя операция с перевозочным средством. 5 символов(или 6 символов, 6-й - контрольный знак). В случае отсутствия данных по дислокации ПС значение будет "no_data".<br />
|-<br />
|station_name||string||Название станции, где была зафиксирована последняя операция с перевозочным средством. <br />
<br />
|-<br />
|op_date||string||Дата фиксирования последней операции. В формате "Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|operation||string||Наименование последней операции<br />
<br />
|-<br />
|route||string||Оставшееся до станции назначения расстояние, км<br />
<br />
|-<br />
|on_track||int||Стоит ли перевозочное средство на слежении. 1 - стоит, 0 - снят или оперативный запрос<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|state||string||Код государства станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|state_name||string||Название государства станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|lon||string||Долгота станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|lat||string||Широта станции, где была зафиксирована последняя операция<br />
<br />
|-<br />
|road_name||string||Дорога, где была зафиксирована последняя операция<br />
<br />
|-<br />
|departure_date||string||Дата отправки. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|route_start_date||string||Дата начала рейса. Формат Y-m-d H:i:s". Время московское.<br />
<br />
|-<br />
|nakl_nom||string||Номер накладной<br />
<br />
|-<br />
|okpo||string||ОКПО отправителя<br />
<br />
|-<br />
|owner||string||Собственник перевозочного средства<br />
<br />
|-<br />
|kgro||string||Номер грузоотправителя<br />
|-<br />
<br />
|kgrp||string||Номер грузополучателя<br />
|-<br />
<br />
|train_index||string||Индекс поезда<br />
|-<br />
<br />
|train_number||string||Номер поезда<br />
|-<br />
<br />
|fraight||string||Код груза по номенклатуре ЕТСНГ<br />
|-<br />
<br />
|fraight_name||string||Наименование груза<br />
|-<br />
<br />
|weight||string||Вес груза (чаще всего в килограммах, но может быть в центнерах или тоннах)<br />
|-<br />
<br />
|wagon_number||string||Номер вагона (платформы), на котором закреплен контейнер (только для контейнерных запросов)<br />
|-<br />
<br />
|station_from||string||Код станции отправления<br />
|-<br />
<br />
|station_from_name||string||Название станции отправления<br />
|-<br />
<br />
|station_to||string||Код станции назначения<br />
|-<br />
<br />
|station_to_name||string||Название станции назначения<br />
|-<br />
<br />
|is_loaded||int||1 - груженый, 0 - порожний<br />
|-<br />
<br />
|}<br />
<br />
==Пример получения отчета на оперативный запрос.==<br />
<br />
Получить отчет по вагону 54676515 по hash=7e1019777173ff342ef500e31719572c:<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=show&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=7e1019777173ff342ef500e31719572c<br />
<br />
==Постановка вагонов/контейнеров на слежение. Метод "add" с доп. параметрами.==<br />
Постановка на слежение аналогично оперативному запросу, т.е. выполняется с помощью метода "add". Существенное различие в дополнительных параметрах, их значениях и поведении системы при слежении.<br><br />
Существует несколько регионов слежения: РФ, СНГ и Балтия, СНГ и Балтия + Китай + Монголия. Ниже описаны основные отличия и особенности:<br><br />
- Основное отличие от оперативного запроса - во времени отклика системы. Если выполнив оперативный запрос ответ будет получен в течение минуты (в среднем), то при слежении ответ может формироваться довольно продолжительное время: от 10 минут по РФ до нескольких часов по странам Средней Азии и Китаю. <br />
- В течение суток можно получить до 3-х обновлений дислокации за одну цену, в то время как <b>каждый</b> оперативный запрос тарифицируется.<br />
- Стоимость слежения по РФ значительно ниже слежения по другим регионам. Однако, в случае пересечения перевозочного средства границы нет никаких гарантий, что свежая информация продолжит поступать.<br />
- Слежение по СНГ и Балтии, Китаю и Монголии позволяет получать дислокацию по всем перечисленным регионам, независимо от того, где находится ПС<br />
- При постановке ПС на слежение задается регламент получения отчетов - в какой день недели и какое время удобно получать свежую информацию, а также способ снятия со слежения (ручной или автоматический)<br />
- Существуют 2 типа слежения: посуточное и рейс. Единственное отличие между ними - в способе тарификации. Посуточное слежение - это такой тип слежения, когда денежные средства списываются со счета клиента при очередном формировании отчета (т.е. первом отчете за сутки согласно расписанию). Рейс тарифицируется сразу за весь маршрут при постановке на слежение и нет необходимости следить за состоянием баланса.<br />
- По hash оперативного запроса не идет обновление информации, т.е. информация о дислокации актуальна только на момент получения ответа. Для слежения информация по hash будет постоянно обновляться до окончания слежения. <br />
Ниже приводится полный список входных параметров. Жирным шрифтом отмечены те из них, которых или нет в оперативном запросе, или их значению следует уделить внимание при постановке на слежение:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||add - добавление оперативного запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067"<br />
<br />
|-<br />
|<b>state</b>||string||Код страны, по которой осуществляется запрос. Для РФ - 20. По странам СНГ и Балтии, Монголии, Китаю - 22.<br />
<br />
|-<br />
|<b>track_state</b>||string||Регион слежения. ru - только Россия, sng - страны СНГ, Балтии, Монголия, Китай.<br />
<br />
|-<br />
|<b>track_type</b>||int||Тип слежения. Для посуточного слежения запроса track_type=2, для рейса - track_type=3<br />
<br />
|-<br />
|<b>stop_station</b>||string||Снимать ли со слежения по прибытию на станцию назначения. "yes" - снимать, "no" - не снимать. Если указать <код ЕСР> - снимать по прибытию на станцию с кодом <код ЕСР>. Код ЕСР - 5-и значный код станции согласно Единой Сетевой Разметке (ЕСР). <br />
<br />
|-<br />
|<b>times</b>||string||Время обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Формат: "H:i", через запятую. Например: "09:00,13:00,18:00". Время московское. <br />
<br />
|-<br />
|<b>times_per_day</b>||string||Количество обновлений информации в сутки в рамках одной стоимости вагоно(контейнеро)/суток. Можно указать до 3-х раз. Если указано, что times меньше times_per_day, то times имеет больший приоритет. Например, times_per_day="2", a times="09:00,13:00,18:00", то отчет будет сформирован только в первое время и второе время, т.е. в 09:00 и в 13:00.<br />
<br />
|-<br />
|<b>days</b>||string||Дни недели, по которым необходимо получать отчет, через запятую. Номера начинаются с нуля (Воскресенье) до 6 (Суббота). Например, если отчеты необходимы по будням, то days="1,2,3,4,5". <br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|comment||string||Комментарий к запросу в urlencode<br />
<br />
|-<br />
|emails||string||Список email-адресов, куда отправить отчет о дислокации после выполнения, через запятую.<br />
<br />
|-<br />
|email_report_type||int||Всегда 2<br />
<br />
|-<br />
|attach_excel||int||Вкладывать ли в письма копию отчета в Excel. 1 - вкладывать, 0 - не вкладывать. По умолчанию 0.<br />
<br />
|}<br />
<br />
==Пример постановки на слежение==<br />
Контейнер AMFU8899067, получение инфорамции по будням дням (days=1,2,3,4,5) в 09:00 и 13:00 по московскому времени (times=09:00,13:00 и times_per_day=2), регион - только РФ (track_state=ru, state=20) без снятия со слежения по прибытии на станцию назначения (stop_station=no, т.е. ручное снятие), адреса для рассылки отчетов alta@alta.ru,mymail@mymail.com (emails=alta@alta.ru,mymail@mymail.com):<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=add&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&wagons=AMFU8899067&state=20&track_type=2&comment=%D0%BF%D0%B5%D1%80%D0%B2%D0%BE%D0%B5+%D1%81%D0%BB%D0%B5%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5+%28%D0%BA%D0%BE%D0%BD%D1%82%29&days=1,2,3,4,5&times_per_day=2&times=09:00,13:00&track_state=ru&stop_station=no&emails=alta@alta.ru,mymail@mymail.com<br />
<br><br />
JSON-ответ включает в себя отчет о состоянии запроса на слежение (поставлен/не поставлен на слежение) и hash, по которому можно получить ответ.<br><br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"cont_hash": "931700e35d7ff88a10bd5d680da50f02"<br />
}<br />
]<br />
</source><br />
<br />
При постановке вагона на слежение получим json-массив:<br />
<br />
<source lang="json"><br />
[<br />
{<br />
"status": "ok",<br />
"descr": "Запрос успешно сохранен",<br />
"hash": "ebc356dfa5beee7d3844ccacf535410c"<br />
}<br />
]<br />
</source><br />
<br />
Поля hash и cont_hash аналогичны таковым для оперативного запроса. Однако, их можно использовать для получения <b>текущей</b> дислокации (согласно расписанию).<br />
<br />
==Получение ответа на ПС, стоящих на слежении. Метод "show". ==<br />
После размещения запроса он встает в очередь на обработку. В обозначенный момент времени (по расписанию) запрос выполняется. Обычно обработка запроса на слежение занимает около 1 минуты. В случае повышенной нагрузки на сервер обработка может занимать до 5 минут и более. <br><br />
Оптимальный период опроса сервера - 1 минута. В случае частых запросов ООО "Альта-Софт" оставляет за собой право заблокировать такие запросы и отказать в обслуживании. <br><br />
Для получение последней дислокации необходимо вызвать метод "show", полностью аналогичный таковому для оперативного запроса. <br><br><br />
Например, для получения дислокации контейнера AMFU8899067: <br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=show&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
==Снятие со слежения. Метод cancel_track.==<br />
<br />
Ниже приводится полный список входных параметров:<br />
<br />
{| class="wikitable" width="75%"<br />
|+<br />
!Параметр !!Тип !!Описание<br />
<br />
|- highlight<br />
|colspan=3 |'''Обязательные'''<br />
<br />
|-<br />
|action||string||cancel_track - снятие со слежения запроса<br />
<br />
|-<br />
|login||string||Логин в сервисе. Например, alta@alta.ru<br />
<br />
|-<br />
|sa||string||Сервис-аккаунт (договор). Например, sa000000<br />
<br />
|-<br />
|secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3<br />
<br />
|-<br />
|hash||string||Хэш запроса. Например, ebc356dfa5beee7d3844ccacf535410c<br />
<br />
|- highlight<br />
|colspan=3 |'''Необязательные'''<br />
<br />
|-<br />
|wagons||string||Список номеров вагонов/контейнеров через запятую. В случае указания списка со слежения будут сняты только те ПС, которые в нем указаны, а не весь запрос. Например, "54676515"<br />
<br />
|}<br />
<br />
== Пример снятия со слежения==<br />
Снять со слежения вагон 54676515 из запроса с hash ebc356dfa5beee7d3844ccacf535410c<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=ebc356dfa5beee7d3844ccacf535410c&wagons=54676515<br />
<br />
Снять со слежения '''весь''' (т.е. все перевозочные средства из запроса) запрос с hash 931700e35d7ff88a10bd5d680da50f02<br><br />
https://www.alta.ru/rail_tracking/api_v2.php?action=cancel_track&login=alta@alta.ru&sa=sa000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3&hash=931700e35d7ff88a10bd5d680da50f02<br />
<br />
Обратите внимание, что для тестовых данных ответ на запрос снятия со слежения будет "успешно", однако фактически запросы останутся на слежении.</div>Boluchevskikh