Платежные web-сервисы: Сервис интеграции с платежной системой (оплата через терминалы) — различия между версиями
[досмотренная версия] | [досмотренная версия] |
Achkasov (обсуждение | вклад) |
Achkasov (обсуждение | вклад) |
||
Строка 129: | Строка 129: | ||
<code>public TokenResult GetUserToken(string userLogin, string userPassword)</code> | <code>public TokenResult GetUserToken(string userLogin, string userPassword)</code> | ||
====Описание принимаемых методом параметров==== | ====Описание принимаемых методом параметров==== | ||
− | * '''userLogin''' - имя пользователя; | + | * '''userLogin''' - ''имя пользователя'' on-line системы бронирования ПК «Мастер-Web»; |
− | * '''userPassword''' - пароль. | + | * '''userPassword''' - ''пароль'' пользователя on-line системы бронирования ПК «Мастер-Web». |
====Возвращаемые значения==== | ====Возвращаемые значения==== | ||
Метод возвращает результат своей работы в виде класса '''TokenResult'''. Корректность результата проверяется значением поля '''ErrorCode''' данного класса: | Метод возвращает результат своей работы в виде класса '''TokenResult'''. Корректность результата проверяется значением поля '''ErrorCode''' данного класса: |
Версия 09:29, 8 октября 2013
Версия статьи от 8-10-2013. Для перехода на версию статьи, соответствующую используемой Вами версии программы, нажмите ссылку в таблице ниже:
Более ранние версии: |
Содержание
Введение
Данный модуль предназначен для проверки заявки и проведения платежа через платежную систему в базу туроператора. Модуль совместим со следующими платежными системами:
- TourPay
- Лидер
- PayTravel
Установка
Для установки Сервиса для интеграции с платежной системой нужно создать директорию Finance в каталоге c:/inetpub/wwwroot/
(корневом каталоге IIS) и выложить туда распакованные файлы из архива mw-finance-2007.2.XX.XXXX.zip
В управлении IIS необходимо создать виртуальный каталог для папки Finance.
Создание виртуального каталога
По умолчанию корневым каталогом IIS является C:/Inetpub/wwwroot
. Для создания виртуального каталога для приложения находящегося в этом каталоге нужно выполнить следующие действия:
1 Зайти в Пуск (Start) → Настройки (Settings) → Панель управления (Control Panel) → Администрирование (Administrative Tools)
2 Диспетчер служб IIS
3 В открывшемся дереве каталогов выбрать Web Sites – Default Web Site. В открывшемся списке найти папку, для которой нужно создать виртуальный каталог, кликнуть по ней правой кнопкой мыши и выбрать Преобразовать в приложение
4 В открывшемся окне нужно нажать кнопку ОК
Подключение к базе данных ПК «Мастер-Тур»
В файле web.config
, расположенном в папке Finance пропишите необходимые параметры подключения (красным цветом выделены значения, которые необходимо ввести).
Строка подключения к базе данных ПК «Мастер-Тур»:
<add key = "connectionString" value = "Data Source=ip-адрес сервера базы данных ПК «Мастер-Тур»;Initial Catalog=название базы данных ПК «Мастер-Тур;User ID=логин пользователя ПК «Мастер-Тур»;Password=пароль пользователя ПК «Мастер-Тур»"/>
Настройка
После установки сервис для интеграции (например «Сервис для интеграции с платежной системой Название_Системы») доступен по адресу
http://ip-адрес сервера Мастер-Веб/Finance/FinanceService.asmx
.
Настройки в файле WEB.CONFIG
Дополнительные настройки, задаются в файле web.config
, находящемся в папке Finance.
№ | Описание | Значение | Настройка |
---|---|---|---|
1 | Определяет тип платежной операции. Тип платежной операции так же может задаваться в настройке SYSPaymentOperationId в таблице SystemSettings. В таком случае в настройке PaymentOperationId задается название настройки из таблицы SystemSettings. |
Идентификатор (PO_Id) типа операции из таблицы PaymentOperations. Либо название настройки SYSPaymentOperationId из таблицы SystemSettings. |
<add key="PaymentOperationId" value="1" /> |
2 | Определяет время действия идентификатора аутентифации (token). | Время действия (в минутах). | <add key="TokenExpireTime" value="10" /> |
3 | Включение режима записи нового платежа в систему «Мастер-Финанс». При этом в ПК «Мастер-Тур» платежи не сохраняются. | true - включена запись платежей в «Мастер-Финанс»;
false или отсутствие настройки - выключает запись платежей в «Мастер-Финанс». |
<add key="AddPaymentsToMasterFinance" value="true"/> |
4 | Определяет тип платежной системы при сохранении платежей в систему «Мастер-Финанс» (столбец DP_PAYMENTSSYS таблицы FIN_DOGOVOR_PAID). | Название платежной системы. | <add key="PaymentSystem" value="Лидер"/> |
5 | Настройка, определяющая дату, на которую должен подбираться курс валют для пересчета суммы к оплате. | orderdate — дата оформления заявки; today — курс на текущую дату; |
<add key="courseExchangeDate" value="orderdate"/> |
6 | Настройка, позволяющая включить механизм логирования. | true — система логирования включена;
false или отсутствие настройки — логирование выключено. |
<add key="UseLog" value="true"/> |
7 | Настройка определяющая филиал, с которым будет создан платеж. | Reservation — филиал путевки;
CurrentUser или отсутствие настройки — филиал пользователя, от имени которого работает сервис. |
<add key="PaymentFilialSource" value="CurrentUser"/> |
Подготовка данных
Проверка заявок и проведение платежа через платежную систему в базу туроператора осуществляется по оформленным путевкам. У путевки должен быть зафиксирован курс валюты, т.е. в истории путевки должно присутствовать сообщение "Фиксация курса".
Логирование
Для детализации ошибок, которые могут возникнуть при работе web-сервиса (например, когда методы web-сервиса возвращают значение ErrorCode 2) можно включить логирование.
В секции <configSections>
надо добавить строку:
<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
Далее прописывается секция <log4net>
:
<log4net>
<appender name="ExceptionLogger" type="log4net.Appender.FileAppender">
<param name="File" value="C:\\MasterTourLogs\\ExceptionLogger.txt" />
<param name="AppendToFile" value="true" />
<layout type="log4net.Layout.PatternLayout">
<param name="ConversionPattern" value="%date [%thread] %-5level [%ndc] - %message %newline %exception" />
</layout>
</appender>
<logger name="ExceptionLogger">
<param name="Threshold" value="ALL" />
<appender-ref ref="ExceptionLogger" />
</logger>
</log4net>
Красным цветом выделен путь к файлу лога. Здесь может быть указан произвольный путь.
Работа в системе
Аутентификация (метод GetUserToken)
Метод возвращает строку - идентификатор аутентификации, который используется для подтверждения авторизации при вызове методов web-сервисов.
Сигнатура метода
public TokenResult GetUserToken(string userLogin, string userPassword)
Описание принимаемых методом параметров
- userLogin - имя пользователя on-line системы бронирования ПК «Мастер-Web»;
- userPassword - пароль пользователя on-line системы бронирования ПК «Мастер-Web».
Возвращаемые значения
Метод возвращает результат своей работы в виде класса TokenResult. Корректность результата проверяется значением поля ErrorCode данного класса:
- 0 - результат корректный;
- 2 – внутренняя ошибка;
- 5 - неправильный логин или пароль.
Описание класса приведено ниже:
public class TokenResult { public int ErrorCode; public string Token; }
где
- ErrorCode - код результата;
- Token - идентификатор аутентификации.
Проверка заявки (метод CheckReservation)
Описание метода
Данный метод предназначен для проверки наличия заявки в БД и определения ее стоимости.
Сигнатура метода
public AmountSum CheckReservation(string userToken, string dgCode)
Описание принимаемых методом параметров
- userToken - идентификатор аутентификации, полученный при вызове метода GetUserToken;
- dgCode - строковая переменная, представляющая собой код проверяемой путевки.
Возвращаемые значения
Метод возвращает результат своей работы в виде класса AmountSum. Корректность результата проверяется значением поля ErrorCode данного класса:
- 0 – результат корректный, в полях возвращены корректные значения;
- 1 – заявка не найдена в БД;
- 2 – внутренняя ошибка;
- 3 - заявка была аннулирована;
- 4 - путевка уже оплачена;
- 6 - некорректный или устаревший идентификатор аутентификации(token).
Ниже приводится описание класса.
public class AmountSum { public double Amount public string RateCode public double NationalCurrencyPrice public string NationalRateCode public int ErrorCode public int FilialKey public DateTime BeginTourDate public DateTime EndTourDate }
- Amount - сумма к оплате в валюте тура;
- RateCode - iso-код валюты тура;
- NationalCurrencyPrice - сумма к оплате в национальной валюте;
- NationalRateCode - iso-код национальной валюты;
- ErrorCode - код результата;
- FilialKey - ключ филиала, который создал заявку;
- BeginTourDate - дата начала тура;
- EndTourDate - дата окончания тура.
- MainTouristFIO - фамилия и инициалы главного туриста.
Проведение платежа по заявке (метод CreatePayment)
Описание метода
Данный метод предназначен для создания платежа по путевке в финансовом блоке ПК «Мастер-Тур».
Сигнатура метода
public int CreatePayment(string userToken, DateTime date, Decimal sum, string currencyIsoCode, string reservationCode, string paymentId)
Описание принимаемых методом параметров
- userToken - идентификатор аутентифкации;
- date – дата проведения платежа;
- sum – сумма платежа;
- currencyIsoCode – ISO-код валюты, в которой осуществляется платеж;
- reservationCode – номер путевки;
- paymentId – идентификатор платежа во внешней системе.
Возвращаемые значения
Данный метод возвращает целочисленное значение обозначающее результат выполнения операции:
- 0 – операция выполнена успешно, платеж проведен;
- 1 – заявка не найдена в БД;
- 2 – внутренняя ошибка при создании платежа;
- 3 - заявка была аннулирована;
- 4 - путевка уже оплачена;
- 6 - некорректный или устаревший идентификатор аутентификации(token).
- 7 - платеж с таким идентификатором уже существует.
При этом в БД создается платеж по выбранной путевке.