Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Note | ||
---|---|---|
| ||
Для использования компонента потребуется указать пользователя с правами администратора с системе Indeed AM для групп прав:
|
Indeed AM Phone Management Server - это Web-приложение, которое работает на базе IIS. Данный компонент предоставляет облегченное API для регистрации, изменения и удаления номеров в базе данных SQL.
Info | ||
---|---|---|
| ||
Для для регистрации, изменения и удаления номеров в базе данных SQL требуется установка Indeed AM Storage SMS OTP Provider. |
Info | ||
---|---|---|
| ||
Файлы для EAPhone Management Server расположены: indeed AM\Indeed AM Phone Management Server\Distrib\
|
Установка компонента
- Откройте командную строку с правами администратора.
- Перейдите в папку Distrib компонента EAPhoneServer.
Запустите установку компонента через вызов команды:
Code Block language bash EA.PhoneManagementServer.deploy.cmd /Y
- После успешной установки в IIS Manager отобразится отдельное Web приложение EAPhoneServer.
Настройка компонента
- Откройте компонент EAPhoneServer в IIS Manager.
- Откройте "Проверка подлинности" и включите параметр "Обычная проверка подлинности". Все остальные методы проверки подлинности требуется отключить.
Настройка конфигурационного файла
Info | ||
---|---|---|
| ||
Для сохранения изменений в конфигурационном файле приложения требуется запустить редактор с правами администратора. |
- Откройте конфигурационный файл компонента Web.config (C:\inetpub\wwwroot\EAPhoneServer\Web.config).
- В теге appSettings выполните следующие настройки:
В строке с параметром key, со значением username, задайте значение для параметра value. В значении укажите имя пользователя в формате UPN, созданного для работы с компонентом.
Code Block language yml title Пример <add key="username" value="Admin-API@new.loc" />
В строке с параметром key, со значением password, задайте значение для параметра value. В значении укажите пароль пользователя.
Code Block language yml title Пример <add key="password" value="Q1q2E3e4" />
Для значения параметра connectionString укажите полный URL доступного сервера Indeed AM или балансировщика в формате:
Code Block http/https://<Полное DNS имя сервера Indeed AM или балансировщика>/easerver/
Code Block language yml title Пример <add name="EAWebAPIURL" connectionString="http://dc2.new.loc/easerver/" />
Шифрование и расшифровка параметров в теге appSettings.
Info title Информация Данная настройка не обязательна.
Для шифрования выполните следующую команду в командной строке с правами администратора:
Code Block language bash C:\Windows\Microsoft.NET\Framework64\v4.0.30319\aspnet_regiis.exe -pe "appSettings" -app "/EAPhoneServer" -prov "DataProtectionConfigurationProvider"
Для расшифровки выполните следующую команду в командной строке с правами администратора:
Code Block language bash C:\Windows\Microsoft.NET\Framework64\v4.0.30319\aspnet_regiis.exe -pd "appSettings" -app "/EAPhoneServer"
Описание методов API компонента
Info | |||||
---|---|---|---|---|---|
| |||||
Входные данные передаются в формате JSON. Для вызова метода API используется URL в формате:
|
Регистрация
Для регистрации номера телефона используется POST запрос к методу API: /api/IID/CreatePhone
- Входные данные:
- Username - Имя пользователя в формате UPN для которого следует зарегистрировать номер телефона.
- Phone - Номер телефона пользователя, который следует зарегистрировать в системе.
- Выходные данные: HTTP ответ с кодом состояния HTTP.
- Пример запроса:
- URL - http://AmIndeed.demo.local/EAPhoneServer/api/IID/CreatePhone
- Данные - ‘{ "Username": "User@demo.local", "Phone": "123456"}’
Изменение
Для изменения номера телефона используется POST запрос к методу API: /api/IID/UpdatePhone
- Входные данные :
- Phone - Номер телефона пользователя, который следует зарегистрировать в системе.
- Username - Имя пользователя в формате UPN для которого следует изменить номер телефона.
- Выходные данные: HTTP ответ с кодом состояния HTTP.
- Пример запроса:
- URL - http://AmIndeed.demo.local/EAPhoneServer/api/IID/UpdatePhone
- Данные - ‘{ "Username": "User@demo.local", "Phone": "654321"}’Пример запроса:
Удаление
Для удаления номера телефона используется POST запрос к методу API: /api/IID/DeletePhone
- Входные данные:
- Username - Имя пользователя в формате UPN для которого следует удалить номер телефона.
- Выходные данные: HTTP ответ с кодом состояния HTTP.
- Пример запроса:
- URL - http://AmIndeed.demo.local/EAPhoneServer/api/IID/DeletePhone
- Данные - ‘{ "Username": "User@demo.local"}’
Backtotop