API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт: различия между версиями
Перейти к навигации
Перейти к поиску
| Строка 3: | Строка 3: | ||
<b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http, транспорт xml. <br/> | <b>Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http, транспорт xml. <br/> | ||
Все запросы в системе – GET. </b> | Все запросы в системе – GET. </b> | ||
| + | <br/> | ||
<b style="color:red"> | <b style="color:red"> | ||
Для всех запросов необходимо указывать обязательный параметр - api_key. <br/> | Для всех запросов необходимо указывать обязательный параметр - api_key. <br/> | ||
| Строка 9: | Строка 10: | ||
</b> | </b> | ||
| − | === | + | === Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ === |
| − | Запрос | + | Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type. |
| + | <br/> | ||
Для запроса необходимо выполнить GET-запрос на адрес http://tax.alta.ru:81/rail.xml | Для запроса необходимо выполнить GET-запрос на адрес http://tax.alta.ru:81/rail.xml | ||
| − | + | <strong>Возможные значения type:</strong> | |
<ol> | <ol> | ||
| − | <li><strong>type = fre</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /> | + | <li><strong>type = [fre|frg]</strong> Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML<br /> |
index = [код или первые символы кода груза или наименование или часть наименования] | index = [код или первые символы кода груза или наименование или часть наименования] | ||
<br /> | <br /> | ||
| − | corr = [yes | + | corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.<br /> |
| − | |||
<strong> Пример 1:</strong> http://tax.alta.ru:81/rail.xml?type=fre&index=011&encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на "011" и соответствующих им грузов ГНГ)<br /> | <strong> Пример 1:</strong> http://tax.alta.ru:81/rail.xml?type=fre&index=011&encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на "011" и соответствующих им грузов ГНГ)<br /> | ||
<strong> Пример 2:</strong> http://tax.alta.ru:81/rail.xml?type=frg&index=пшен&encoding=utf-8&corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит "пшен". НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /> | <strong> Пример 2:</strong> http://tax.alta.ru:81/rail.xml?type=frg&index=пшен&encoding=utf-8&corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит "пшен". НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ) <br /> | ||
<br /> | <br /> | ||
| + | </li> | ||
| + | </ol> | ||
| + | |||
| + | === Выполнение запроса на выбор из справочника станций === | ||
| + | |||
| + | Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type. | ||
| + | <br/> | ||
| + | Для запроса необходимо выполнить GET-запрос на адрес http://tax.alta.ru:81/rail.xml | ||
| + | |||
| + | <strong>Возможные значения type:</strong> | ||
| + | <ol> | ||
| + | <li><strong>type = [fst|tst]</strong> Получить список станций назначения (fst) или отправления (tst) в формате XML<br /> | ||
| + | index = [код или первые символы кода станции или наименование или часть наименования], <br /> | ||
| + | <strong> Пример 1:</strong> http://tax.alta.ru:81/rail.xml?type=tst&index=104&encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на "104")<br /> | ||
| + | <strong> Пример 2:</strong> http://tax.alta.ru:81/rail.xml?type=fst&index=моск&encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит "моск". НЕ чуствителен к регистру) <br /> | ||
| + | <br /> | ||
| + | </li> | ||
| + | </ol> | ||
| + | |||
| + | === Выполнение запроса на выбор из справочника государств === | ||
| + | |||
| + | Послать запрос вида: <br/> | ||
| + | http://tax.alta.ru:81/rail.xml?type=states | ||
| + | |||
| + | === Выполнение запроса на получение дерева отправок и перевозочных средств === | ||
| + | |||
| + | <ol> | ||
| + | <li><strong>type = [van_tree]</strong> Получить дерево перевозочных средств. | ||
| + | <ul> | ||
| + | <li>kind = xml (дерево пс в виде xml, по умолчанию)</li> | ||
| + | <li>kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)<br /> | ||
| + | <strong>Пример</strong>: http://tax.alta.ru:81/rail.xml?type=van_tree&kind=ul&encoding=utf-8<br /> | ||
| + | <br /> | ||
| + | </li> | ||
| + | </ul> | ||
</li> | </li> | ||
</ol> | </ol> | ||
Версия 21:02, 11 сентября 2017
Содержание
Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт
Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http, транспорт xml.
Все запросы в системе – GET.
Для всех запросов необходимо указывать обязательный параметр - api_key.
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год).
По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.
Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.
Для запроса необходимо выполнить GET-запрос на адрес http://tax.alta.ru:81/rail.xml
Возможные значения type:
- type = [fre|frg] Получить список грузов ЕТСНГ (fre) или грузов ГНГ (frg) в формате XML
index = [код или первые символы кода груза или наименование или часть наименования]
corr = [yes|no] Указывет серверу, надо ли искать соответствие ЕТСНГ-ГНГ. По умолчанию yes.
Пример 1: http://tax.alta.ru:81/rail.xml?type=fre&index=011&encoding=utf-8&api_key=[вставьте ваш api_key] (получить список грузов ЕТСНГ код которых начинается на "011" и соответствующих им грузов ГНГ)
Пример 2: http://tax.alta.ru:81/rail.xml?type=frg&index=пшен&encoding=utf-8&corr=no&api_key[вставьте ваш api_key] (получить список грузов ГНГ наименование который содержит "пшен". НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ)
Выполнение запроса на выбор из справочника станций
Запрос выбор из справочников грузов состоит из обязательного параметра type и других параметров, завясящих от type.
Для запроса необходимо выполнить GET-запрос на адрес http://tax.alta.ru:81/rail.xml
Возможные значения type:
- type = [fst|tst] Получить список станций назначения (fst) или отправления (tst) в формате XML
index = [код или первые символы кода станции или наименование или часть наименования],
Пример 1: http://tax.alta.ru:81/rail.xml?type=tst&index=104&encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций назначения код которых начинается на "104")
Пример 2: http://tax.alta.ru:81/rail.xml?type=fst&index=моск&encoding=utf-8&api_key=[вставьте ваш api_key] (получить список станций отправления наименование который содержит "моск". НЕ чуствителен к регистру)
Выполнение запроса на выбор из справочника государств
Послать запрос вида:
http://tax.alta.ru:81/rail.xml?type=states
Выполнение запроса на получение дерева отправок и перевозочных средств
- type = [van_tree] Получить дерево перевозочных средств.
- kind = xml (дерево пс в виде xml, по умолчанию)
- kind = html (дерево пс в виде html-тегов ul-li для удобного отображения с использованием плагина jQuery - Treeview)
Пример: http://tax.alta.ru:81/rail.xml?type=van_tree&kind=ul&encoding=utf-8
