API Просмотр таможенного XML - История изменений

Krashennikova в 01:27, 8 августа 2019

2019-08-08T01:27:37Z

Krashennikova в 01:27, 8 августа 2019

2019-08-08T01:27:13Z

Krashennikova в 15:20, 11 октября 2018

2018-10-11T15:20:38Z

Krashennikova: /* API */

2018-10-11T15:16:47Z

‎API

Krashennikova: Новая страница: «==О сервисе== Сервис «Просмотр таможенного XML» предоставляет разработчикам возможность а…»

2018-10-11T15:16:16Z

Новая страница: «==О сервисе== Сервис «Просмотр таможенного XML» предоставляет разработчикам возможность а…»

Новая страница

==О сервисе==
Сервис «Просмотр таможенного 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)") = 8a4ba8b265e827b14e46ba394e99653b

Таким образом итоговый URL, на который совершается POST-запрос:
https://www.alta.ru/xml-preview/api/?login=testlogin&secret=8a4ba8b265e827b14e46ba394e99653b

Файл формата XML отправляется вложением "multipart/form-data" с произвольным именем файла (например можно использовать file), или POST данными "application/xml" (на выбор разработчика).

----
<code>
Для тестового подключения и предварительной настройки используйте: 
логин: '''testlogin''' 
пароль: '''testpassword''' 
В качестве файла можно передавать только тестовый файл (во вложении)
</code>
----

Ниже приводится полный список входных параметров:
{| class="wikitable" width="75%"
|+
!Параметр !!Тип !!Описание

|-
|login||GET string||Логин к сервису

|-
|secret||GET string||MD5-секрет для данного запроса

|-
|file||POST Xml||Вложенный xml файл с любым именем (например file), или post data application/xml

|}

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

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

[[Категория:Автоматизация]]
[[Категория:Web-Сервисы]]

@@ Строка 21: / Строка 21: @@
 логин: '''testlogin'''<br>
 пароль: '''testpassword'''<br>
-В качестве файла можно передавать только тестовый файл (во вложении)
+В качестве файла можно передавать только тестовый файл [[Файл:Api-test-file.xml]]
 </code>
 ----

@@ Строка 27: / Строка 27: @@
 Ниже приводится полный список входных параметров:
-{|  class="wikitable" width="75%"
+{| class="wikitable" width="75%"
 |+
-!Параметр	!!Тип	!!Описание
+!Параметр!!Тип!!Описание
 |-
@@ Строка 48: / Строка 48: @@
 Для получения результата необходимо сформировать запрос с использованием указанного 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>
 При возникновении ошибок возвращается код ответа сервера 401, а также код ошибки в JSON-массиве.
 [[Категория:Автоматизация]]
 [[Категория:Web-Сервисы]]

@@ Строка 42: / Строка 42: @@
 |}
-В случае успешной обработки данных в ответ возвращается файл в формате PDF, код ответа сервера – 200.
+При размере файла менее 100 kB в случае успешной обработки данных в ответ возвращается файл в формате PDF, код ответа сервера – 200.
 При возникновении ошибок возвращается код ответа сервера 401, а также код ошибки в JSON-массиве.

@@ Строка 9: / Строка 9: @@
 '''секрет''' - MD5-хеш от сгенерированной строки '''размер_файла в байтах + логин + md5-хэш от пароля''', разделенный знаком двоеточия «:».<br>
 Например, для пользователя с логином testlogin и паролем testpassword вычисляем секрет для тестового файла:
-secret = md5("28129:testlogin:md5(testpassword)") = 8a4ba8b265e827b14e46ba394e99653b
+secret = md5("28129:testlogin:md5(testpassword)") = 598043dc8a52b9a97c48b946361c93e0
 Таким образом итоговый URL, на который совершается POST-запрос:
-https://www.alta.ru/xml-preview/api/?login=testlogin&secret=8a4ba8b265e827b14e46ba394e99653b
+https://www.alta.ru/xml-preview/api/?login=testlogin&secret=598043dc8a52b9a97c48b946361c93e0
 Файл формата XML отправляется вложением "multipart/form-data" с произвольным именем файла (например можно использовать file), или POST данными "application/xml" (на выбор разработчика).