JSON-API сервиса поиска вагонов: различия между версиями
(Метка: визуальный редактор отключён) |
(Метка: визуальный редактор отключён) |
||
Строка 34: | Строка 34: | ||
|- | |- | ||
− | |login||string|| | + | |login||string||Логин в сервисе. Например, alta@alta.ru |
+ | |||
+ | |- | ||
+ | |secret||string||Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3 | ||
+ | |||
+ | |- | ||
+ | |wagons||string||Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067" | ||
+ | |||
+ | |- | ||
+ | |state||string||Код страны, по которой осуществляется запрос. На данный момент оперативные запросы поддерживаются только по РФ. Код=20. | ||
+ | |||
+ | |- | ||
+ | |track_type||int||Тип слежения. Для оперативного запроса track_type=1 | ||
|- highlight | |- highlight | ||
Строка 40: | Строка 52: | ||
|- | |- | ||
− | | | + | |comment||string||Комментарий к запросу в urlencode |
|- | |- |
Версия 14:55, 29 июля 2021
О сервисе
JSON-API сервиса «Поиск вагонов» позволяет интегрировать возможности сервиса в сторонние программы и сайты. Посредством данного API можно выполнять оперативные запросы на поиск вагонов и контейнеров по жд сетям, ставить и снимать вагоны и контейнеры на слежение по СНГ, странам Балтии, Монголии и Китаю, а также запрашивать справки ГВЦ. Сам интерфейс предоставляется бесплатно, тарифицируются только запросы, выполненные с его помощью согласно расценкам, опубликованным на сайте "Альта-Софт".
API
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET или POST. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля.
Для авторизации необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки символьное обозначения сервиса + сервис-аккаунт + технический пароль, разделенный знаком двоеточия «:».
Символьное обозначение сервиса для поиска вагонов - всегда rail_tracking.
Технический пароль можно получить в личном кабинете, в разделе управления договором, в пункте 'Технические настройки'
Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:
Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5('alta_test')") = 5ec1514f1b5a383fc5ad3f04bb9ac0e3
Для выполнения любого запроса необходимо указать название действия (action) и авторизационные данные.
Например, для проверки корректности генерации секрета необходимо выполнить запрос:
https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa0000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3
В json-ответе будет {"status":"ok"}
в случае корректного секрета, в противном случае {"status":"error"}
Выполнение оперативного (разового) запроса
Оперативный запрос выполняется единожды. Запрос в среднем обрабатывается в течение минуты. Тарифицируются только те запросы, по которым пришел ответ. Например, в запросе указано 6 вагонов, а ответ пришел только на 5. Значит с баланса спишется сумма за 5 вагонов.
Ниже приводится полный список входных параметров:
Параметр | Тип | Описание |
---|---|---|
Обязательные | ||
action | string | add - добавление оперативного запроса |
login | string | Логин в сервисе. Например, alta@alta.ru |
secret | string | Сгенерированный секрет. Например 5ec1514f1b5a383fc5ad3f04bb9ac0e3 |
wagons | string | Список номеров вагонов/контейнеров через запятую. Например, "54676515,AMFU8899067" |
state | string | Код страны, по которой осуществляется запрос. На данный момент оперативные запросы поддерживаются только по РФ. Код=20. |
track_type | int | Тип слежения. Для оперативного запроса track_type=1 |
Необязательные | ||
comment | string | Комментарий к запросу в urlencode |
secret | string | MD5-секрет для данного запроса |
tncode | string | Код ТН ВЭД; от 2 до 10 цифр для ограничения поиска по подразделам, группам, подгруппам и т.п. |
page | int | Номер страницы при дополнительном запросе данных по определенному коду; от 2 |