You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Next »

Информация

Для использования компонента потребуется указать пользователя с правами администратора с системе 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\

  • Distrib\EA.PhoneManagementServer.deploy.cmd - Cmd файл необходимый для установки компонента.
  • Scripts\ - Power Shell скрипты с примером вызова каждого метода API.

Установка компонента 

  1. Откройте командную строку с правами администратора.
  2. Перейдите в папку Distrib компонента EAPhoneServer.
  3. Запустите установку компонента через вызов команды: 

    EA.PhoneManagementServer.deploy.cmd /Y
  4. После успешной установки в IIS Manager отобразится отдельное Web приложение EAPhoneServer.

Настройка компонента 

  1. Откройте компонент EAPhoneServer в IIS Manager.
  2. Откройте "Проверка подлинности" и включите параметр "Обычная проверка подлинности". Все остальные методы проверки подлинности требуется отключить.

Настройка конфигурационного файла

Информация

Для сохранения изменений в конфигурационном файле приложения требуется запустить редактор с правами администратора. 

  1. Откройте конфигурационный файл компонента Web.config (C:\inetpub\wwwroot\EAPhoneServer\Web.config).
  2. В теге appSettings выполните следующие настройки:
    1. В строке с параметром key, со значением username, задайте значение для параметра value. В значении укажите имя пользователя в формате UPN, созданного для работы с компонентом. 

      Пример
      <add key="username" value="Admin-API@new.loc" />
    2. В строке с параметром key, со значением password, задайте значение для параметра value. В значении укажите пароль пользователя.

      Пример
      <add key="password" value="Q1q2E3e4" />
  3. Для значения параметра connectionString укажите полный URL доступного сервера Indeed AM или балансировщика в формате:

    http/https://<Полное DNS имя сервера Indeed AM или балансировщика>/easerver/
    Пример
    <add name="EAWebAPIURL" connectionString="http://dc2.new.loc/easerver/" />
  4. Шифрование и расшифровка параметров в теге appSettings.

    Информация

    Данная настройка не обязательна.

    1. Для шифрования выполните следующую команду в командной строке с правами администратора:

      C:\Windows\Microsoft.NET\Framework64\v4.0.30319\aspnet_regiis.exe -pe "appSettings" -app "/EAPhoneServer" -prov "DataProtectionConfigurationProvider"

    2. Для расшифровки выполните следующую команду в командной строке с правами администратора:

      C:\Windows\Microsoft.NET\Framework64\v4.0.30319\aspnet_regiis.exe -pd "appSettings" -app "/EAPhoneServer"

Описание методов API компонента

Информация

Входные данные передаются в формате JSON. Для вызова метода API используется URL в формате: 

http/https://<Полное DNS имя сервера с компонентом EAPhoneServer>/EAPhoneServer/<метод API>

Регистрация 

Для регистрации номера телефона используется POST запрос к методу API: /api/IID/CreatePhone

  1. Входные данные: 
    1. Username - Имя пользователя в формате UPN для которого следует зарегистрировать номер телефона. 
    2. Phone - Номер телефона пользователя, который следует зарегистрировать в системе.
  2. Выходные данные: HTTP ответ с кодом состояния HTTP.
  3. Пример запроса:
    1. URL - http://AmIndeed.demo.local/EAPhoneServer/api/IID/CreatePhone
    2. Данные - ‘{ "Username": "User@demo.local",  "Phone": "123456"}’

Изменение

Для изменения номера телефона используется POST запрос к методу API: /api/IID/UpdatePhone

  1. Входные данные :
    1. Phone - Номер телефона пользователя, который следует зарегистрировать в системе.
    2. Username - Имя пользователя в формате UPN для которого следует изменить номер телефона.
  2. Выходные данные: HTTP ответ с кодом состояния HTTP.
  3. Пример запроса: 
    1. URL - http://AmIndeed.demo.local/EAPhoneServer/api/IID/UpdatePhone
    2. Данные - ‘{ "Username": "User@demo.local",  "Phone": "654321"}’Пример запроса:

Удаление

Для удаления номера телефона используется POST запрос к методу API:  /api/IID/DeletePhone

  1. Входные данные:
    1. Username - Имя пользователя в формате UPN для которого следует удалить номер телефона.
  2. Выходные данные: HTTP ответ с кодом состояния HTTP.
  3. Пример запроса:
    1. URL - http://AmIndeed.demo.local/EAPhoneServer/api/IID/DeletePhone
    2. Данные - ‘{ "Username": "User@demo.local"}’



  • No labels