Page History

Indeed AM Phone Management Server - это Web-приложение, которое работает на базе IIS. Данный компонент предоставляет облегченное API для регистрации, изменения и удаления номеров  в базе данных SQL.

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

1. Откройте командную строку с правами администратора.
2. Перейдите в папку Distrib компонента EAPhoneServer.

3. Запустите установку компонента через вызов команды: 

   Code Block
   language bash
   EA.PhoneManagementServer.deploy.cmd /Y

   
   

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

Удаление компонента EAPhoneServer

1. Остановите приложение EAPhoneServer в IIS Manager.
2. Откройте папку C:\inetpub\wwwroot.
3. Удалите папку “EAPhoneServer” со всем содержимым. 
4. Удалите приложение “EAPhoneServer” в IIS Manager.

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

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

3. Откройте "Правила авторизации". Измените существующее правило или добавьте новое. В настройках укажите пользователя или группу пользователей, которым будет доступен вызов методов API.

   Info
   title Информация
   При указании группы пользователей указывается значение атрибута name данной группы.  При указании пользователя указывается значение атрибута sAMAccountName или userPrincipalName.

   
   

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

1. Откройте конфигурационный файл компонента Web.config (C:\inetpub\wwwroot\EAPhoneServer\Web.config).

2. В теге appSettings выполните следующие настройки:

   Info
   title Информация
   От имени указанного пользователя будут выполняться запросы к API.

   
   

   1. В строке с параметром key, со значением username, задайте значение для параметра value. В значении укажите имя пользователя в формате UPN, созданного для работы с компонентом. 

      
      

      Code Block
      language yml title Пример
      <add key="username" value="Admin-API@new.loc" />

      
      

   2. В строке с параметром key, со значением password, задайте значение для параметра value. В значении укажите пароль пользователя.

      Code Block
      language yml title Пример
      <add key="password" value="Q1q2E3e4" />

      
      

   3. В строке с параметром key, со значением lognames, задайте формат логирования имен пользователей. Поддерживаемые форматы : 

      Info
      title Информация
      Если необходимо указать несколько форматов, то требуется указать значения через запятую.

      
      

      • Id - Идентификатор пользователя в системе Indeed AM в формате rootUserCatalogProviderId_Guid.
      • Name - Значение атрибута name из Active Directory. 
      • CanonicalName - Значение атрибута sAMAccountName из Active Directory - Имя пользователя в формате Canonical-Name (myserver.demo.local/users/UserName). 
      • PrincipalName - Значение атрибута userPrincipalName атрибута userPrincipalName из Active Directory. 
      • SamCompatibleName - Значение атрибута из Active DirectoryИмя пользователя в формате domainName\UserName. 
      • DistinguishedName - Значение атрибута distinguishedName атрибута distinguishedName из Active Directory. 
      • Sid - Значение атрибута objectSid атрибута objectSid из Active Directory. 
      • Email - Значение атрибута атрибута mail из Active Directory или значение указанное в конфигурационном файле сервера. 
      • Phone - Значение атрибута telephoneNumber из Active Directory или значение указанное в конфигурационном файле сервера. 
3. Задайте url для подключения к лог серверу. Редактируем тег logServer.
   1. URL - url для подключения к log серверу в формате http(s)://полное_dns_имя_сервера/ils/api.
   2. CertificateThumbprint - если закрытый ключ в реестре, а сертификат в хранилище компьютера.
   3. CertificateFilePath - если ключевая пара в pfx.
   4. CertificateFilePassword - пароль от pfx.

4. Для значения параметра 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/" />

   
   

5. Шифрование и расшифровка параметров в теге appSettings.

   Info
   title Информация
   Данная настройка не обязательна.

   
   

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

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

      

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

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

      

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

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"}’