API Просмотр таможенного XML: различия между версиями
(Новая страница: «==О сервисе== Сервис «Просмотр таможенного XML» предоставляет разработчикам возможность а…») |
(→API) |
||
Строка 9: | Строка 9: | ||
'''секрет''' - MD5-хеш от сгенерированной строки '''размер_файла в байтах + логин + md5-хэш от пароля''', разделенный знаком двоеточия «:».<br> | '''секрет''' - MD5-хеш от сгенерированной строки '''размер_файла в байтах + логин + md5-хэш от пароля''', разделенный знаком двоеточия «:».<br> | ||
Например, для пользователя с логином testlogin и паролем testpassword вычисляем секрет для тестового файла: | Например, для пользователя с логином testlogin и паролем testpassword вычисляем секрет для тестового файла: | ||
− | secret = md5("28129:testlogin:md5(testpassword)") = | + | secret = md5("28129:testlogin:md5(testpassword)") = 598043dc8a52b9a97c48b946361c93e0 |
Таким образом итоговый URL, на который совершается POST-запрос: | Таким образом итоговый URL, на который совершается POST-запрос: | ||
− | https://www.alta.ru/xml-preview/api/?login=testlogin&secret= | + | https://www.alta.ru/xml-preview/api/?login=testlogin&secret=598043dc8a52b9a97c48b946361c93e0 |
Файл формата XML отправляется вложением "multipart/form-data" с произвольным именем файла (например можно использовать file), или POST данными "application/xml" (на выбор разработчика). | Файл формата XML отправляется вложением "multipart/form-data" с произвольным именем файла (например можно использовать file), или POST данными "application/xml" (на выбор разработчика). |
Версия 18:16, 11 октября 2018
О сервисе
Сервис «Просмотр таможенного XML» предоставляет разработчикам возможность автоматической конвертации файлов в XML-формате в их печатную форму в формате PDF из внешних программ и сайтов. С помощью данного сервиса возможно визуализировать все типы файлов, пересылаемых по системе ЭД-2 или передаваемых в таможенные органы на электронном носителе информации.
API
Доступ к API предоставляется по URL https://www.alta.ru/xml-preview/api/. Для использования сервиса необходима авторизация с помощью логина и пароля.
Для авторизации с помощью пары логин/пароль необходимо отправлять POST-запрос по URL, содержащий следующие GET-параметры:
логин в открытом виде,
секрет - MD5-хеш от сгенерированной строки размер_файла в байтах + логин + md5-хэш от пароля, разделенный знаком двоеточия «:».
Например, для пользователя с логином testlogin и паролем testpassword вычисляем секрет для тестового файла:
secret = md5("28129:testlogin:md5(testpassword)") = 598043dc8a52b9a97c48b946361c93e0
Таким образом итоговый URL, на который совершается POST-запрос: https://www.alta.ru/xml-preview/api/?login=testlogin&secret=598043dc8a52b9a97c48b946361c93e0
Файл формата XML отправляется вложением "multipart/form-data" с произвольным именем файла (например можно использовать file), или POST данными "application/xml" (на выбор разработчика).
Для тестового подключения и предварительной настройки используйте:
логин: testlogin
пароль: testpassword
В качестве файла можно передавать только тестовый файл (во вложении)
Ниже приводится полный список входных параметров:
Параметр | Тип | Описание |
---|---|---|
login | GET string | Логин к сервису |
secret | GET string | MD5-секрет для данного запроса |
file | POST Xml | Вложенный xml файл с любым именем (например file), или post data application/xml |
В случае успешной обработки данных в ответ возвращается файл в формате PDF, код ответа сервера – 200.
При возникновении ошибок возвращается код ответа сервера 401, а также код ошибки в JSON-массиве.