API ЖД Тариф - Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт

Материал из Alta-Soft Wikipedia
Перейти к навигации Перейти к поиску

Описание протокола обмена данными с системой расчета провозной платы на жд от Альта-Софт

Обмен данными между сервисом Альта-Софт и сторонними ресурсами осуществляется по протоколу http, транспорт xml.
Все запросы в системе – GET.
Для всех запросов необходимо указывать обязательный параметр - api_key.
Api_key выдается клиенту после оплаты доступа к api-функционалу и имеет ограниченный период действия (6 мес или год). По окончании срока действия ключа (если не было оплачено продление) доступ к функционалу приостанавливается.

1) Выполнение запроса на выбор из справочника грузов ЕТСНГ и ГНГ

Запрос на расчет и выбор из справочников состоит из обязательного параметра type и других параметров, завясящих от type. Для запроса необходимо выполнить GET-запрос на адрес http://tax.alta.ru:81/rail.xml

Возможные значения type:

  1. type = fre Получить список грузов ЕТСНГ (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] (получить список грузов ГНГ наименование который содержит "пшен". НЕ чуствителен к регистру. НЕ будет выводить соответствующие грузы из справочника ЕТСНГ)