JSON-API сервиса поиска вагонов: различия между версиями
(Метка: визуальный редактор отключён) |
|||
Строка 7: | Строка 7: | ||
Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET или POST. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля. | Доступ к API предоставляется по URL https://www.alta.ru/rail_tracking/api_v2.php. Входные параметры передаются с помощью запроса HTTP GET или POST. Для использования сервиса необходима авторизация с помощью сервисного логина и пароля. | ||
− | '''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + пароль''', разделенный знаком двоеточия «:».<br> | + | '''Для авторизации''' необходимо в любой запрос добавить логин в открытом виде, сервис-аккаунт (номер договора для тарификации) и MD5-хеш от сгенерированной строки '''символьное обозначения сервиса + сервис-аккаунт + пароль''', разделенный знаком двоеточия «:». <br/> |
− | Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и паролем alta_test:<br> | + | Символьное обозначение сервиса для поиска вагонов - всегда '''rail_tracking'''.<br> |
− | Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5(alta_test)")<br> | + | Например, для пользователя с логином alta@alta.ru, сервис-аккаунтом sa000000 и техническим паролем alta_test:<br> |
+ | Вычисляем секрет: secret = md5("rail_tracking:sa000000:md5('alta_test')") = 5ec1514f1b5a383fc5ad3f04bb9ac0e3 <br> | ||
+ | |||
+ | Для выполнения любого запроса необходимо указать название действия (action) и авторизационные данные. | ||
+ | Например, для проверки корректности генерации секрета необходимо выполнить запрос: | ||
+ | https://www.alta.ru/rail_tracking/api_v2.php?action=test_secret&login=alta@alta.ru&sa=sa0000000&secret=5ec1514f1b5a383fc5ad3f04bb9ac0e3 | ||
+ | |||
+ | ==Выполнение оперативного (разового) запроса== | ||
Ниже приводится полный список входных параметров: | Ниже приводится полный список входных параметров: |
Версия 13:04, 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
Выполнение оперативного (разового) запроса
Ниже приводится полный список входных параметров: