Перейти в режим автора

XML Интерфейсы сервиса Exchanger

В данном разделе представлены интерфейсы для автоматизации работы с секцией WM Exchanger, основанные на обращениях (запросах) к специальному Web-серверу системы по протоколу https в формате XML с использованием специального модуля аутентификации для ключей WM Keeper WinPro или стандартных сертификатов x.509 (сертификаты WM Keeper WebPro).

Все интерфейсы, использующие аутентификацию с ключами WM Keeper WinPro имеют адрес вида https://wm.exchanger.ru/asp/XML_название_.asp для XML запросов и https://wm.exchanger.ru/asp/JSON_название_.asp для JSON запросов. Интерфейсы использующие аутентификацию со стандартными сертификатами (сертификаты WM Keeper WebPro) - https://wmeng.exchanger.ru/asp/XML_название_.asp для XML запросов и https://wmeng.exchanger.ru/asp/JSON_название_.asp для JSON запросов.

В случае аутентификации с использованием ключей WM Keeper WinPro в запросе передается подпись, сформированная модулем WMSigner. Сформированная подпись передается в параметре <signstr>...</signstr>.

В случае аутентификации с использованием сертификатов WM Keeper WebPro, сертификат должен использоваться при установлении соединения с сервером https://wmeng.exchanger.ru. Параметры <signstr>...</signstr> и <wmid>...</wmid> в этом случае в запросе не используется.

Вне зависимости от типа используемой аутентификации, формат запросов одинаков и отличается только способом формирования и передачи подписи запроса. Ниже приведены примеры структуры запросов с различными типами аутентификации:

Структура запроса с аутентификацией по ключам WM Keeper WinPro (подпись запроса формируется с помощью модуля WMSigner)

<wm.exchanger.request>
    <wmid></wmid> - WM идентификатор подписавшего запрос
    <signstr></signstr> - подпись запроса сформированная с помощью модуля WMSigner
    <тип_запроса>
        ... - параметры запроса
    </тип_запроса>
</wm.exchanger.request>

Структура запроса с аутентификацией по стандартным сертификатам WM Keeper WebPro (параметры wmid и signstr не используются; сертификат WMID, который вызывает интерфейс должен использоваться при установлении соединения с сервером). Более подробную информацию об использовании сертификатов смотрите на http://msdn.microsoft.com
или https://technet.microsoft.com/en-us/library/ee690451.aspx 

<wm.exchanger.request>

    <тип_запроса>
        ... - параметры запроса
    </тип_запроса>
</wm.exchanger.request>

Формат ответа системы не зависит от способа аутентификации запроса. Ниже приведен пример структуры ответа сервера:

<wm.exchanger.response>
    <retval></retval> - код ошибки выполнения запроса: 0 - выполнен успешно 
    <retdesc></retdesc> - описание ошибки если retval != 0
</wm.exchanger.response>

Обращаем внимание, что при использовании данных интерфейсов (или в принципе любых страниц сайта wm.exchanger.ru) в случае автоматизированного обращения к ним с одними и теми же параметрами бессмысленно часто, в течение продолжительного времени (чаще 1 раза в минуту) мы оставляем за собой право ограничить или прекратить вообще, как использование интерфейсов, такими лицами, так и использование ими всего сайта в целом.

Имена файлов интерфейсов и перечень параметров запросов и ответов приведены в описании каждого интерфейса: