Для использования компонента потребуется указать пользователя с правами администратора с системе Indeed AM для групп прав:
|
Indeed AM Phone Management Server - это Web-приложение, которое работает на базе IIS. Данный компонент предоставляет облегченное API для регистрации, изменения и удаления номеров в базе данных SQL.
Для для регистрации, изменения и удаления номеров в базе данных SQL требуется установка Indeed AM Storage SMS OTP Provider. |
Файлы для EAPhone Management Server расположены: indeed AM\Indeed AM Phone Management Server\Distrib\
|
Запустите установку компонента через вызов команды:
EA.PhoneManagementServer.deploy.cmd /Y |
Данную настройку рекомендуется выполнить в целях обеспечения безопасного доступа к компоненту EAPhoneServer. |
Откройте "Правила авторизации". Измените существующее правило или добавьте новое. В настройках укажите пользователя или группу пользователей, которым будет доступен вызов методов API.
При указании группы пользователей указывается значение атрибута name данной группы. При указании пользователя указывается значение атрибута sAMAccountName или userPrincipalName. |
Для сохранения изменений в конфигурационном файле приложения, требуется запустить редактор с правами администратора. |
В теге appSettings выполните следующие настройки:
От имени указанного пользователя будут выполняться запросы к API. |
В строке с параметром key, со значением username, задайте значение для параметра value. В значении укажите имя пользователя в формате UPN, созданного для работы с компонентом.
<add key="username" value="Admin-API@new.loc" /> |
В строке с параметром key, со значением password, задайте значение для параметра value. В значении укажите пароль пользователя.
<add key="password" value="Q1q2E3e4" /> |
В строке с параметром key, со значением lognames, задайте формат логирования имен пользователей. Поддерживаемые форматы :
Если необходимо указать несколько форматов, то требуется указать значения через запятую. |
Phone - Значение атрибута telephoneNumber из Active Directory или значение указанное в конфигурационном файле сервера.
<add key="lognames" value="PrincipalName,Sid" /> |
CertificateFilePassword - пароль от pfx.
<logServer Url="http://dc2.new.loc/ils/api/" CertificateThumbprint="" CertificateFilePath="" CertificateFilePassword="" /> |
Создайте папка для хранения локального кэша событий. По умолчанию задан путь: D:\Temp\IndeedIdServerEventLog\EaPhoneEventCache. Создайте указанную по умолчанию папку, либо укажите любой другой локальный путь. Выдайте полный доступ для пользователя IIS_IUSRS на конечную папку.
<logServerClient AppId="ea" Component="server" EventCacheDirectory="C:\inetpub\wwwroot\EAPhoneServer\EventCache" LogServerTargetConfigFile="" /> |
Для значения параметра connectionString укажите полный URL доступного сервера Indeed AM или балансировщика в формате:
http/https://<Полное DNS имя сервера Indeed AM или балансировщика>/easerver/ |
<add name="EAWebAPIURL" connectionString="http://dc2.new.loc/easerver/" /> |
Шифрование и расшифровка параметров в теге appSettings.
Настройка рекомендована в целях обеспечения безопасности. |
Для шифрования выполните следующую команду в командной строке с правами администратора:
C:\Windows\Microsoft.NET\Framework64\v4.0.30319\aspnet_regiis.exe -pe "appSettings" -app "/EAPhoneServer" -prov "DataProtectionConfigurationProvider" |
Для расшифровки выполните следующую команду в командной строке с правами администратора:
C:\Windows\Microsoft.NET\Framework64\v4.0.30319\aspnet_regiis.exe -pd "appSettings" -app "/EAPhoneServer" |
Входные данные передаются в формате JSON. Для вызова метода API используется URL в формате:
|
Скрипт по работе с данным методом API доступен по ссылке. |
Для регистрации номера телефона используется POST запрос к методу API: /api/IID/CreatePhone
Генерируемые события
В качестве примера используется формат имени: PrincipalName, Sid |
Успешная регистрация
При успешной регистрации провайдера генерируется событие с уникальным Id - 1088. Тело события содержит:
Ошибка при регистрации
При возникновении ошибки, во время регистрации провайдера, генерируется событие с уникальным Id - 2073. Тело события содержит:
Инициатор ошибки - В данном параметре указывается пользователь, по причине которого возникла ошибка.
В случае возникновения ошибки при логоне в систему или возникновения ошибки доступа(403), в данном параметре будут отображаться данные Сервисного пользователя. |
Скрипт по работе с данным методом API доступен по ссылке. |
Для изменения номера телефона используется POST запрос к методу API: /api/IID/UpdatePhone
Генерируемые события
В качестве примера используется формат имени: id, Name, PrincipalName. |
Успешное изменение
При успешном изменении провайдера генерируется событие с уникальным Id - 1089. Тело события содержит:
Ошибка при изменении
При возникновении ошибки, во время изменения провайдера, генерируется событие с уникальным Id - 2074. Тело события содержит:
Инициатор ошибки - В данном параметре указывается пользователь, по причине которого возникла ошибка.
В случае возникновения ошибки при логоне в систему или возникновения ошибки доступа(403), в данном параметре будут отображаться данные Сервисного пользователя. |
Скрипт по работе с данным методом API доступен по ссылке. |
Для удаления номера телефона используется POST запрос к методу API: /api/IID/DeletePhone
Генерируемые события
В качестве примера используется формат имени: DistinguishedName, SamCompatibleName. |
Успешное изменение
При успешном удалении провайдера генерируется событие с уникальным Id - 1090. Тело события содержит:
Ошибка при изменении
При возникновении ошибки, во время удаления провайдера, генерируется событие с уникальным Id - 2075. Тело события содержит:
Инициатор ошибки - В данном параметре указывается пользователь, по причине которого возникла ошибка.
В случае возникновения ошибки при логоне в систему или возникновения ошибки доступа(403), в данном параметре будут отображаться данные Сервисного пользователя. |