API Просмотр таможенного XML: различия между версиями

Материал из Alta-Soft Wikipedia
Перейти к навигации Перейти к поиску
 
Строка 27: Строка 27:
  
 
Ниже приводится полный список входных параметров:
 
Ниже приводится полный список входных параметров:
{| class="wikitable" width="75%"
+
{| class="wikitable" width="75%"
 
|+
 
|+
!Параметр !!Тип !!Описание
+
!Параметр!!Тип!!Описание
  
 
|-
 
|-
Строка 48: Строка 48:
  
 
Для получения результата необходимо сформировать запрос с использованием указанного ID<br>
 
Для получения результата необходимо сформировать запрос с использованием указанного ID<br>
https://www.alta.ru/xml-preview/api/?login='''{login}'''&secret='''{secret}'''&id='''{ID}'''<br>
+
<nowiki>https://www.alta.ru/xml-preview/api/?login=</nowiki>'''{login}'''&secret='''{secret}'''&id='''{ID}'''<br>
 
где '''secret''' - MD5-хеш от сгенерированной строки '''ID + логин + md5-хэш от пароля''', разделенный знаком двоеточия «:».<br>
 
где '''secret''' - MD5-хеш от сгенерированной строки '''ID + логин + md5-хэш от пароля''', разделенный знаком двоеточия «:».<br>
  
 
При возникновении ошибок возвращается код ответа сервера 401, а также код ошибки в JSON-массиве.
 
При возникновении ошибок возвращается код ответа сервера 401, а также код ошибки в JSON-массиве.
 
  
 
[[Категория:Автоматизация]]
 
[[Категория:Автоматизация]]
 
[[Категория:Web-Сервисы]]
 
[[Категория:Web-Сервисы]]

Текущая версия на 04:27, 8 августа 2019

О сервисе

Сервис «Просмотр таможенного 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
В качестве файла можно передавать только тестовый файл Файл:Api-test-file.xml



Ниже приводится полный список входных параметров:

Параметр Тип Описание
login GET string Логин к сервису
secret GET string MD5-секрет для данного запроса
file POST Xml Вложенный xml файл с любым именем (например file), или post data application/xml

При размере файла менее 100 kB в случае успешной обработки данных в ответ возвращается файл в формате PDF, код ответа сервера – 200.

Для файлов размером свыше 100 kB в ответ в JSON-массиве возвращается идентефикатор очереди (ID)
{"status":"new","text":"Добавили файл в очередь обработки","id":"xxxxxx"}

Для получения результата необходимо сформировать запрос с использованием указанного ID
https://www.alta.ru/xml-preview/api/?login={login}&secret={secret}&id={ID}
где secret - MD5-хеш от сгенерированной строки ID + логин + md5-хэш от пароля, разделенный знаком двоеточия «:».

При возникновении ошибок возвращается код ответа сервера 401, а также код ошибки в JSON-массиве.