Использование SELFIETOPAY API

SELFIETOPAY API - программный интерфейс для подключения сервиса SELFIETOPAY.

В качестве транспорта используется HTTPS протокол. Сообщения кодируются в JSON формат.

Общие положения

Мобильное приложение взаимодействует с сервером по протоколу REST. Протокол REST односторонний, только клиент может сделать запрос к серверу и получить ответ. Сервер не может передать данные на клиента без запроса. Многие операции на сервере асинхронные. Для их выполнения используется идентификатор (deferredId), по которому можно будет получить результат. После выполнения асинхронного запроса и получения в ответ deferredId, клиент в цикле запрашивает результат операции до тех пор, пока не получит непустое значение, либо не произойдет тайм-аут.

Общее описание процесса оплаты

Процесс оплаты выглядит следующим образом:

Касса отправляет заказ на сервер SWiP и включает камеру.
Пользователь смотрит в камеру.
Система распознает лицо и проводит оплату.
Пользователь забирает фискальный чек.

Сценарии использования

Регистрация

Действующие лица	Пользователь, Приложение
Описание	Регистрация нового пользователя.
Триггер	Желание пользователя оплачивать покупки бесконтактно.
Предусловия	Пользователь установил приложение "SWiP" с Play Маркет или App Store на свой мобильный телефон и запустил его.
Цели	Осуществить успешную регистрацию.
Успешный сценарий: Пользователь просматривает инструкцию с функциями SWiP и нажимает "Начать". Пользователь вводит номер телефона, на который будет выслано СМС с кодом для подтверждения. Ознакомляется и соглашается с Пользовательским соглашением SWiP, Правилами программы лояльности и Политикой в отношении обработки персональных данных, отмечает галочкой необходимый чекбокс и нажимает "Далее". Приложение отправляет код для подтверждения на указанный номер телефона. Пользователь вводит код, полученный по СМС. Пользователь придумывает ПИН-код для входа в приложение и повторяет его. Приложение отправляет ПИН-код на сервер. Приложение показывает экран с предложением прикрепить банковскую карту, пользователь нажимает "Далее". Приложение показывает экран с предложением подключить функцию SELFIETOPAY, пользователь нажимает "Далее".
Результат	Пользователь успешно зарегистрировался в приложении SWiP.
Расширения:
2а	Пользователь не ввел номер телефона. Отметил галочкой чекбоксы и нажал "Далее". Результат: Приложение показывает сообщение: "Введите корректный номер телефона".
2b	Пользователь ввел номер телефона, отметил галочкой только одно соглашение. Результат: Кнопка "Далее" отключена (неактивна).
4a	Пользователь не получил СМС. Нажимает "Отправить СМС ещё раз". Результат: СМС будет отправлено повторно.
4b	Пользователь вернулся назад и нажал "Далее" до истечения 60 секунд. Результат: Появляется сообщение о том, что лимит СМС исчерпан. Необходимо подождать 60 секунд.
4c	Пользователь ввел неверный код отправленный по СМС. Результат: Приложение показывает сообщение: "Упс! Что-то пошло не так. Попробуйте повторить немного позже"
5а	Пользователь вводит во второй раз неверный ПИН-код. Результат: Приложение сообщает, что пароли не совпадают. Необходимо ввести верный ПИН-код.
5b	Пользователь 3 раза подряд вводит неверный ПИН-код. Результат: Переход на экран с номером телефона.
7a	Пользователь нажимает "Прикрепить". Результат: Переход к сценарию "Прикрепление банковской карты".
8a	Пользователь нажимает "Подключить". Результат: Переход к сценарию "Подключение функции SELFIETOPAY".

Прикрепление банковской карты

Действующие лица	Пользователь, Приложение, Система
Описание	Прикрепление банковской карты.
Триггер	Пользователь нажал "Прикрепить" на экране успешной регистрации или "Добавить карту" в профиле в разделе "Способ оплаты".
Предусловия	Успешная регистрация пользователя.
Цели	Прикрепить банковскую карту для оплаты покупок сервисом SWiP.
Успешный сценарий: Пользователь вводит номер карты, срок действия карты, код CVC, имя и фамилию владельца и нажимает "Далее". В приложении открывается веб-страница банка для подтверждения операции. Пользователь вводит пароль для подтверждения операции из СМС. Система временно блокирует 1 рубль на указанной карте и привязывает карту к аккаунту пользователя. Через некоторое время блокировка суммы снимается эмитентом карты. Пользователь видит на экране сообщение "Карта добавлена".
Результат	Банковская карта успешно прикреплена.
Расширения:
1a	Пользователь неверно ввел номер карты и нажал "Далее". Результат: Приложение показывает сообщение "Не удалось добавить карту: Некорректный номер карты."
1b	Пользователь неверно ввел данные и нажал "Далее". Результат: Система переходит на веб-страницу банка и показывает сообщение: "Операция отклонена. Необходимо обратиться в банк, выпустивший карту".
1с	Пользователь сканирует карту. Результат: Номер карты вводится автоматически. Пользователь вводит срок действия карты, код CVC, имя и фамилию владельца нажимает "Далее".
3a	Пользователь не успел ввести пароль. Результат: Повторная отправка СМС.
4a	Система не смогла списать 1 рубль (недостаточно средств на карте). Результат: Появляется сообщение "Операция отклонена. Проверьте введенные данные, достаточность средств на карте и повторите операцию".

Удаление банковской карты

Действующие лица	Пользователь, Приложение
Описание	Удаление банковской карты.
Триггер	Пользователь хочет удалить банковскую карту.
Предусловия	Банковская карта была прикреплена.
Цели	Банковская карта успешно удалена.
Успешный сценарий: Пользователь заходит в профиль в раздел "Способы оплаты", нажимает иконку "Детали" возле необходимой карты. Затем нажимает "Удалить". Приложение удаляет банковскую карту из системы.
Результат	Банковская карта успешно удалена.
Расширения:
1a	Пользователь заходит в профиль в раздел "Способы оплаты" и проводит, не отрывая пальца, справа налево по необходимой карте (iOS). Результат: Переход к шагу 2.

Подключение функции SELFIETOPAY

Действующие лица	Пользователь, Приложение, Администратор
Описание	Подключение функции SELFIETOPAY.
Триггер	Пользователь нажал "Подключить" на экране успешной регистрации или "Подключить" в профиле в разделе "SELFIETOPAY".
Предусловия	Успешная регистрация пользователя.
Цели	Подключить функцию SELFIETOPAY для оплаты лицом.
Успешный сценарий: Пользователь принимает условия Политики в отношении обработки паспортных данных. Пользователь нажимает "Сканировать". Приложение запрашивает доступ к Камере. Пользователь дает разрешение на доступ к Камере. Пользователь делает селфи. Приложение сохраняет фотографию на сервере. Пользователь выбирает "Фото паспорта", нажимает "Сделать фото" и фотографирует паспорт. Приложение сохраняет фотографию на сервере. Пользователь выбирает "Селфи с паспортом", нажимает "Сделать фото" и делает селфи с паспортом. Приложение сохраняет фотографию на сервере. Пользователь нажимает подключить SELFIETOPAY. Заявка отправляется на проверку. Администратор подключает функцию SELFIETOPAY после успешной проверки данных. Пользователь видит сообщение "Функция SELFIETOPAY подключена".
Результат	Пользователь успешно подключил сервис SELFIETOPAY.
Расширения:
7a	Пользователь выбирает "Фото паспорта", нажимает "Выбрать из галереи". Результат: Пользователь переходит в галерею и выбирает необходимое фото.
9a	Пользователь выбирает "Селфи с паспортом", нажимает "Выбрать из галереи". Результат: Пользователь переходит в галерею и выбирает необходимое фото.
12a	Администратор не подключает функцию STP. Результат: Пользователь видит сообщение об ошибке при проверке данных. Возможные варианты: Плохое селфи. Плохое селфи с паспортом. Плохая фотография (не видны все данные). Фотография лица и фото на паспорте не совпадают. Не все документы загружены. Необходимо переснять плохое фото или добавить недостающие документы.

Отключение функции SELFIETOPAY

Действующие лица	Пользователь, Система
Описание	Отключение функции SELFIETOPAY.
Триггер	Пользователь хочет отключить функцию SELFIETOPAY.
Предусловия	Функция SELFIETOPAY была подключена.
Цели	Функция SELFIETOPAY успешно отключена.
Успешный сценарий: Пользователь заходит в профиль в раздел SELFIETOPAY, нажимает "Отключить". Пользователь не изменяет загруженные фото. Система отключает функцию SELFIETOPAY.
Результат	Функция SELFIETOPAY успешно отключена.
Расширения:
1a	Пользователь меняет какой-либо из загруженных снимков. Результат: Все снимки удаляются из профиля. Переход к сценарию "Подключение функции SELFIETOPAY".

Описание API для оплаты лицом