Просмотр исходного текста страницы Web-сервисы: Сервис для работы с пользователями системы

==Введение==
Данный web-сервис предназначен для работы с пользователями системы Мастер-Web. Позволяет производить регистрацию и аутентификацию пользователей в качестве представителей агентств или частных лиц, получать информацию о зарегистрированных пользователях, изменять информацию зарегистрированных пользователей.

==Установка==
Для установки '''Сервиса для работы с пользователями системы''' нужно создать директорию '''UserManagementService''' в каталоге 
<code>c:/inetpub/wwwroot/</code> (корневом каталоге '''IIS''') и выложить туда файлы из папки '''UserManagementService'''.
В управлении '''IIS''' необходимо создать виртуальный каталог для папки '''UserManagementService'''.

===Создание виртуального каталога===
По умолчанию корневым каталогом '''IIS''' является <code>C:/Inetpub/wwwroot</code>. Для создания виртуального каталога для приложения 
находящегося в этом каталоге нужно выполнить следующие действия:<br />
1 Зайти в '''Пуск''' ('''Start''') &rarr; '''Настройки''' ('''Settings''') &rarr; '''Панель управления''' ('''Control Panel''') &rarr; '''Администрирование''' ('''Administrative Tools''')<br />
[[Файл: am_745.png|x500px|Панель управления]]<br />
<br />
2 '''Диспетчер служб IIS'''<br />
[[Файл: am_746.png|x500px|Администрирование - Диспетчер служб IIS]]<br />
<br />
3 В открывшемся дереве каталогов выбрать '''Web Sites – Default Web Site'''. В открывшемся списке найти ''папку'', для которой нужно создать ''виртуальный каталог'', кликнуть по ней правой кнопкой мыши и выбрать '''Преобразовать в приложение'''<br />
[[Файл: am_747.png|x500px|Преобразовать в приложение]]<br />
<br />
4 В открывшемся окне нужно нажать кнопку '''ОК'''<br />
[[Файл: am_748.png|x500px|Добавить приложение]]<br />
<br />

===Подключение к базе данных ПК «Мастер-Тур»===
В файле <code>web.config</code>, расположенном в папке '''UserManagementService''' пропишите необходимые параметры подключения (<span style="color:red">красным цветом</span> выделены значения, которые необходимо ввести).
Строка подключения к базе данных ПК «Мастер-Тур»:<br />
<code><add key = "connectionString" value = "Data Source=<span style="color:red">ip-адрес сервера базы данных ПК «Мастер-Тур»</span>;Initial Catalog=<span style="color:red">название базы данных ПК «Мастер-Тур</span>;User ID=<span style="color:red">логин пользователя ПК «Мастер-Тур»</span>;Password=<span style="color:red">пароль пользователя ПК «Мастер-Тур»</span>"/></code>
==Настройка==
После установки «Сервис для работы с пользователями системы» доступен по адресу <code><nowiki>http://ip- адрес сервера Мастер-Веб/UserManagementService/UserManagementService.svc</nowiki></code>.

===Настройка в файле WEB.CONFIG===
Дополнительные настройки задаются в файле  web.config, находящемся в папке UserManagementService.

{| border="1" cellpadding="8" style="background-color:#F9F9F9; border:#AAAAAA; border-collapse:collapse"

|- style="background-color:#F2F2F2"

! width="2%" | №
! width="28%" | Описание
! width="35%" | Значение
! width="35%" | Настройка

|- style="vertical-align:text-top"

| 1
| Настройка, определяющая к какому филиалу будет привязано регистрируемое агентство или частное лицо.
| '''Ключ филиала''' из таблицы tbl_Partners
|<syntaxhighlight lang="xml" enclose="div">
<add key="defaultFilialKey" value="2" />
</syntaxhighlight>

|- style="vertical-align:text-top"

| 2
|  Настройка, определяющая партнера в базе ПК «Мастер-Тур», к которому будут привязываться регистрируемые частные лица.
|'''Ключ партнера''' (из таблицы tbl_Partners), к которому будут привязываться регистрируемые частные лица.
|<syntaxhighlight lang="xml" enclose="div">
<add key="personalBookingPartnerKey" value="10769" />
</syntaxhighlight>

|- style="vertical-align:text-top"

| 3
|  Настройка, проверяющая уникальность ИНН регистрируемого агентства.
|  
* '''true''' - проверяется уникальность ИНН регистрируемого агентства;
* '''false''' или '''отсутствие настройки''' – не проверяется уникальность ИНН регистрируемого агентства.
|<syntaxhighlight lang="xml" enclose="div">
<add key="isCheckUniqueINN" value="true" />
</syntaxhighlight>

|- style="vertical-align:text-top"

| 4
| '''Определяет''', использовать ли признак '''Проверка реквизита''' из справочника [[Мастер-Тур:Справочники#Страны|«Страны»]] при проверке корректности ввода ИНН.
|  
* '''true''' – использовать признак '''Проверка ИНН''' - проверка проводится только для тех стран, у которых '''включен''' признак '''Проверка реквизита''';
* '''false''' или '''отсутствие настройки''' – проверка ИНН проводится для '''всех''' стран.
|<syntaxhighlight lang="xml" enclose="div">
<add key="useCheckINNSetting" value="true" />
</syntaxhighlight>
|}

==Подготовка данных==
Для получения token'a необходимо воспользоваться '''сервисом авторизации''' ([[Мастер-Web:Дополнительный модуль Распределенный поиск#Сервис авторизации|WsAuthorization]]).<br />

[[Файл:am_063.png|left|Предупреждение]]<br />
 С 1 января 2017 года вступили в силу положения Федерального закона от 02.03.2016 № 49-ФЗ «О внесении изменений в отдельные законодательные акты 
 Российской Федерации в целях совершенствования законодательства, регулирующего туристскую деятельность» (далее – Федеральный закон № 49-ФЗ), в связи 
 с чем вводится ограничение на осуществление бронирования партнёрами, не указавшими реестровый номер.
 Установить дату, начиная с которой данное ограничение начинает функционировать, можно в [[Мастер-Тур:Администрирование системы#Дополнительные настройки|дополнительных настройках]] ПК «Мастер-Тур».
 <span style="color:red">Настройка работает, начиная с релиза '''9222SP0'''.

==Работа в системе==
===Метод AgencyRegistration===
Данный метод предназначен для регистрации пользователей (агентств). <br />
====Сигнатура метода==== 
<code>public int AgencyRegistration(string Address, string AgencyName, string City, string Comment, string ContactName, string Country, string Email, string Fax, System.Nullable<int> Filial, string INN, System.Nullable<int> IsActive, string Login, string Password, string PhoneCode, string PhoneNumber, string Token, string ZipCode)</code>

====Описание принимаемых методом параметров====
* Address - адрес
* AgencyName – название агентства (обязательный параметр)
* City – город
* Comment – примечание
* ContactName – контактное лицо
* Contry – страна
* Email – e-mail пользователя(обязательный параметр)
* Fax – факс
* Filial – филиал
* INN – ИНН
* IsActive – признак активности пользователя сразу после регистрации
* Login – логин (обязательный параметр)
* Password – пароль  (пароль передается в незашифрованном виде. При работе с сервисом рекомендуется использовать протокол https) (обязательный параметр)
* PhoneCode – код города
* PhoneNumber – телефон
* PartnerRegisterNumber - реестровый номер
* Token - токен (обязательный параметр)
* ZipCode – индекс

====Возвращаемые значения====
* UserKey - идентификатор пользователя 

===Метод PersonRegistration===
Данный метод предназначен для регистрации пользователей (частных лиц). <br />
====Сигнатура метода==== 
<code>public int PersonRegistration(string Address, string City, string Country, string Email, System.Nullable<int> Filial, System.Nullable<int> IsActive, string Login, string Name, string Password, string PhoneCode, string PhoneNumber, string SecondName, string Surname, string Token, string ZipCode)</code>

====Описание принимаемых методом параметров====
* Address - адрес
* City – город
* Contry – страна
* Email – e-mail пользователя (обязательный параметр)
* Filial – филиал
* IsActive – признак активности пользователя сразу после регистрации
* Login – логин (обязательный параметр)
* Name – имя (обязательный параметр)
* Password – пароль  (пароль передается в незашифрованном виде. При работе с сервисом рекомендуется использовать протокол https) (обязательный параметр)
* PhoneCode – код города
* PhoneNumber – телефон
* SecondName - отчество
* Surname – фамилия
* Token - токен (обязательный параметр)
* ZipCode – индекс

====Возвращаемые значения====
* UserKey - идентификатор пользователя 

===Метод UniqueLoginCheck===
Данный метод предназначен для проверки логина пользователя на уникальность. <br />
====Сигнатура метода==== 
<code>public int UniqueLoginCheck(string Login, string Token)</code>
====Описание принимаемых методом параметров====
* Login – логин (обязательный параметр)
* Token - токен (обязательный параметр)
====Возвращаемые значения====
* LoginUnique - статус проверки логина на уникальность:
** 0 – логин не найден в БД
** 1 – логин найден в БД

===Метод GetUserKeyAndType===
Данный метод предназначен для получения идентификатора (UserKey) и типа пользователя (агентство или частное лицо). <br />
====Сигнатура метода==== 
<code>public UserKeyAndType GetUserKeyAndType(string Login, string Token)</code>
====Описание принимаемых методом параметров====
* Login – логин (обязательный параметр)
* Token - токен (обязательный параметр)
====Возвращаемые значения====
* UserKey - идентификатор пользователя 
* UserType - тип пользователя:
** 0 - агентство
** 1 - частник

===Метод UserAuthorization===
Данный метод предназначен для аутентификации пользователя. <br />
====Сигнатура метода==== 
<code>public UserAuthorizationResult UserAuthorization(string Login, string Password, string Token)</code>
====Описание принимаемых методом параметров====
* Login – логин (обязательный параметр)
* Password - пароль (обязательный параметр)
* Token - токен (обязательный параметр)
====Возвращаемые значения====
* AuthorizationStatus - статус авторизации:
** 0 - AccessDenied - пользователь не найден с указанным username и password
** 1 - AccessAllow - пользователь найден с указанным username и password
** 2 - DogovorExpired - дата окончания договора партнёра меньше текущей (для частников не проверять)
* UserCanBooking - возможность бронирования:
** false
** true
* UserRight - права пользователя:
** 1 - уполномоченный
** 0 - неуполномеченный
* UserType - тип пользователя:
** 0 - агентство
** 1 - частник

===Метод PasswordRecovery===
Данный метод предназначен для восстановления пароля зарегистрированного пользователя. <br />
====Сигнатура метода==== 
<code>public string PasswordRecovery(string Email, string Login, string Token)</code>
====Описание принимаемых методом параметров====
* Email - адрес электронной почты (обязательный параметр)
* Login – логин (обязательный параметр)
* Token - токен (обязательный параметр)
====Возвращаемые значения====
* Password - пароль (пароль передается в незашифрованном виде. При работе с сервисом рекомендуется использовать протокол https)

===Метод GetUserKeysByEMail===
Данный метод предназначен для получения идентификаторов пользователей по значению e-mail адреса. <br />
====Сигнатура метода==== 
<code>public int[] GetUserKeysByEmail(string Email, string Token)</code>
====Описание принимаемых методом параметров====
* Email - адрес электронной почты (обязательный параметр)
* Token - токен (обязательный параметр)
====Возвращаемые значения====
* Keys - идентификаторы пользователей из таблицы '''[DUP_USER]'''

===Метод GetAgencyInfo===
Данный метод предназначен для получения данных зарегистрированного пользователя "агентство". <br />
====Сигнатура метода==== 
<code>public AgencyInformation GetAgencyInfo(string Token, int UserKey)</code>
====Описание принимаемых методом параметров====
* Token - токен (обязательный параметр)
* UserKey - идентификатор пользователя (обязательный параметр)
====Возвращаемые значения====
* Address – адрес
* AgencyKey – ключ агентства из таблицы '''[Partners]''' 
* AgencyName – название агентства
* City – город
* Comment – примечание
* ContactName – контактное лицо
* Contry – страна
* Email – e-mail
* Fax – факс
* Filial – филиал
* INN – ИНН
* IsActive – признак активности пользователя сразу после регистрации
* PartnerRegisterNumber - реестровый номер
* PhoneCode – код города
* PhoneNumber – телефон
* ZipCode – индекс

===Метод GetPersonInfo===
Данный метод предназначен для получения данных зарегистрированного пользователя "частное лицо". <br />
====Сигнатура метода==== 
<code>public PersonInformation GetPersonInfo(string Token, int UserKey)</code>
====Описание принимаемых методом параметров====
* Token - токен (обязательный параметр)
* UserKey - идентификатор пользователя  (обязательный параметр)

====Возвращаемые значения====
* Address - адрес
* City – город
* Contry – страна
* Email – e-mail
* Filial – филиал
* IsActive – признак активности пользователя сразу после регистрации
* Name – имя
* PhoneCode – код города
* PhoneNumber – телефон
* SecondName - отчество
* Surname – фамилия
* ZipCode – индекс

===Метод ModifyAgencyInfo===
Данный метод предназначен для изменения данных зарегистрированного пользователя "агентство". <br />
====Сигнатура метода==== 
<code>public int ModifyAgencyInfo(string Address, string AgencyName, string City, string Comment, string ContactName, string Country, string Email, string Fax, System.Nullable<int> Filial, string INN, System.Nullable<int> IsActive, string Login, string Password, string PhoneCode, string PhoneNumber, string Token, int UserKey, string ZipCode)</code>
====Описание принимаемых методом параметров====
* Address - адрес
* AgencyName – название агентства
* City – город
* Comment – примечание
* ContactName – контактное лицо
* Contry – страна
* Email – e-mail
* Fax – факс
* Filial – филиал
* INN – ИНН
* IsActive – признак активности пользователя сразу после регистрации
* Login – логин
* Password – пароль  (пароль передается в незашифрованном виде. При работе с сервисом рекомендуется использовать протокол https)
* PartnerRegisterNumber - реестровый номер
* PhoneCode – код города
* PhoneNumber – телефон
* Token - токен (обязательный параметр)
* UserKey - идентификатор пользователя (обязательный параметр)
* ZipCode – индекс

====Возвращаемые значения====
* Status - статус изменения данных пользователя:
* 0 - Error 
* 1 - Ok
===Метод ModifyPersonInfo===
Данный метод предназначен для изменения данных зарегистрированного пользователя "частное лицо". <br />
====Сигнатура метода==== 
<code>public int ModifyPersonInfo(string Address, string City, string Country, string Email, System.Nullable<int> Filial, System.Nullable<int> IsActive, string Login, string Name, string Password, string PhoneCode, string PhoneNumber, string SecondName, string Surname, string Token, int UserKey, string ZipCode)</code>
====Описание принимаемых методом параметров====
* Address - адрес
* City – город
* Contry – страна
* Email – e-mail
* Filial – филиал
* IsActive – признак активности пользователя сразу после регистрации
* Login – логин
* Name – имя
* Password – пароль  (пароль передается в незашифрованном виде. При работе с сервисом рекомендуется использовать протокол https)
* PhoneCode – код города
* PhoneNumber – телефон
* SecondName - отчество
* Surname – фамилия
* Token - токен (обязательный параметр)
* UserKey - идентификатор пользователя (обязательный параметр)
* ZipCode – индекс

====Возвращаемые значения====
* Status - статус изменения данных пользователя:
* 0 - Error 
* 1 - Ok

[[Category:Web-сервисы]]