Методы веб-сервиса Docsvision

Взаимодействие с сервером Docsvision, помимо использования базового API, может быть организовано через SOAP.

Адрес сервера для подключения SOAP-клиента указан в настройках сервера Docsvision и обычно соответствует виду: http://DOCSVISION_SERVER.COM/DocsVision/StorageServer/StorageServerService.asmx.

Описание методов веб-сервиса доступно по адресу: http://DOCSVISION_SERVER.COM/DocsVision/StorageServer/StorageServerService.asmx?WSDL.

Для передачи данных в формате SOAP на адрес сервера Docsvision используется метод HTTP POST.

Описание протокола SOAP доступно по ссылке.

Конкретный способ подключения к серверу Docsvision и отправка сообщения зависят от языка программирования и используемой библиотеки: suds (Python), SOAPClient (PHP), SOAP::Lite for Perl и пр.

Для параметров всех методов справедливо: если текст передается в формате .xml, то спецсимволы, содержащиеся в нем, должны быть экранированы. Это применимо и к SOAP-ответу.

В данном подразделе, помимо описания методов веб-сервиса, приведены примеры использования данных методов на языке Python (версии 3); SOAP-клиент не используется.

Во всех примерах, приведенных далее, для подключения к веб-сервису Docsvision используется общий шаблон:

import xml.etree.ElementTree as ElementTree
import requests
from requests_ntlm import HttpNtlmAuth
import base64

url = 'http://DOCSVISION_SERVER.COM/DocsVision/StorageServer/StorageServerService.asmx' (1)

username = 'Domain\User.Name'
password = 'User.Password' (2)

session = requests.Session()
session.auth = HttpNtlmAuth(username, password, session)
session.headers['Content-Type'] =  'text/xml; charset=utf-8'
1 Адрес веб-сервиса.
2 Учетные данные пользователя Docsvision.

Модуль python-ntlm может быть получен по ссылке.