EMS Web Services API. Аутентификация по ключу активации

EMS Web Services API. Аутентификация по ключу активации


При аутентификации в Sentinel EMS посредством ключа активации (Product Key), создаётся сессия, в рамках которой пользователю предоставляется доступ к Sentinel EMS Customer Portal, где он сможет выполнить онлайн или оффлайн активацию своего ключа и/или загрузить лицензии (*.V2C файлы), ранее уже активированные по этому ключу активации, а также он сможет загрузить из Sentinel EMS утилиту RUS.exe 
(Remote Update System - утилита для удалённого обновления лицензий в ключах).
Для выполнения аутентификации по ключу активации, необходимо выполнить POST запрос 
loginByProductKey.ws 
из EMS Web Service API, и в качестве параметра в запросе, передать сам ключ активации:

Пример запроса аутентификации по ключу активации:
https://localhost:8443/ems/v710/ws/loginByProductKey.ws
Request Body:
productKey=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
При успешной аутентификации будет возвращён ответ, содержащий XML структуру вида:
//
<?xml version="1.0" encoding="UTF-8"?>
<EMSResponse>
<regRequired>1</regRequired>
<sessionId>xxxxxxxxxxxxxxxxxxxxx</sessionId>
<stat>ok</stat>
</EMSResponse>
//
После успешной аутентификации можно выполнять остальные запросы к Sentinel EMS. Также, важно помнить, что некоторые запросы EMS Web Service API не требуют предварительной аутентификации, например запрос Fetch Pending Updates (V2C) Using C2V  - используемый для запроса и получения доступных обновлений для уже имеющегося у клиента ключа защиты.

Для простоты работы с EMS Web Service API и упрощения процесса его интеграции в своё решение, существует специальный пример-сервис по работе с EMS Web Service API,
называется он emsWSDemo:

emsWSDemo предназначен, в первую очередь, для наглядной демонстрации возможностей EMS Web Service API, а также для быстрого и простого тестирования запросов EMS Web Service API. Кроме того, emsWSDemo способен генерировать примеры кода вызова для запросов EMS Web Service API на Java. С помощью emsWSDemo можно “на ходу” выполнить любой запрос EMS Web Service API и посмотреть что он возвращает в ответ.
Для того чтобы использовать emsWSDemo необходимо его развернуть на ПК с установленным Sentinel EMS. Выполняется это следующим образом:
1. Необходимо на ПК с установленным Sentinel EMS скопировать файл emsWSDemo.war из директории: %EMS_HOME%\samples\EmsWSDemo\bin в директорию: %EMS_HOME%\EMSServer\webapps
2. Подождать от нескольких секунд до ~2 минут, пока Tomcat развернёт сервис emsWSDemo из *.war файла
3. При необходимости отредактируйте настройки сервиса emsWSDemo в файле: %EMS_HOME%\EMSServer\webapps\emsWSDemo\WEB-INF\classes\emsWSDemo.properties
Возможна настройка следующих параметров сервиса:
● useSSL - если Sentinel EMS настроен на работу через HTTPS (SSL), установите значение = true (по умолчанию используется значение: false);
● Server - укажите настройки адреса и порта, на котором работает Sentinel EMS (по умолчанию используется значение: localhost:80, - требует настройки в случае, когда сервис emsWSDemo разворачивается на ПК,
отличном от того, где установлен и настроен сам Sentinel EMS); 
● trustStore - указывается путь до файла-хранилища сертификатов (certificate keystore file). Настраивается в случае работы через HTTPS (SSL);
● trustStorePass - указывается пароль для файла-хранилища сертификатов (trust store password). Значение по умолчанию: changeit. Настраивается в случае работы через HTTPS (SSL).
4. Перезапустите службу Sentinel EMS service (или перезагрузите ПК с установленным Sentinel EMS).

После того как сервис emsWSDemo развёрнут и настроен, доступ к нему можно получить через браузер, открыв страницу с адресом: http://host:port/emsWSDemo , - с любого ПК, расположенного в той же сети что и ПК с emsWSDemo. Где:
● host - IP адрес или имя ПК, где развёрнут сервис emsWSDemo;
● port - порт на котором работает Sentinel EMS Server.
Пример: http://localhost:8080/emsWSDemo - если emsWSDemo развёрнут и запускается на ПК с установленным Sentinel EMS.