Настольные модули

В этом разделе перечислены модули, которые адаптированы только под настольные браузеры и большие (>= 9.7') планшеты.

Модуль «Личные финансы»

Описание

Полная функциональность CASHOFF в одном модуле.

Название

main

Размеры

Ширина: от 670px

Высота: по содержимому

Параметры

Название

Требуется

Тип

Описание

main_menu

-

string

Идентификатор раздела. Доступные идентификаторы:

client_overview - обзор
client_reports - отчеты
client_trans - устарело. Вместо него открывается client_reports
client_goals - цели
client_profiles - профили
client_budgets - бюджеты
client_suggestions - устарело. Советы больше не поддерживаются, раздел пустой. Вместо них теперь истории, отображаются в разделе client_overview.

По умолчанию будет открыт раздел обзора

menu_mode

-

string

Выбор режима меню. Возможные варианты:

external - меню не отображается. Для переключении разделов необходимо использовать параметр модуля main_menu, визуализация меню выполняется на стороне приложения.
internal - вверху модуля будет отображаться меню выбора разделов.

По умолчанию используется режим external.

Сообщения

Изменение текущего раздела

Взаимодействуя с модулем клиент может внутри него переходить между разделами. Если приложение показывает в своем интерфейсе какой текущий раздел, то ему необходимо подписаться на сообщение menuPageDidChange: оно сообщает об изменении текущего раздела. В качестве тела сообщения будет передан объект:

Поле	Тип	Описание
page	string	Идентификатор текущего раздела

Модуль «Расходы по категориям»

Описание	Небольшая диаграмма расходов по категориям
Название	reports-mini-category
Размеры	Ширина: 260px Высота: 360px

Модуль «Расходы по местам»

Описание	Небольшая диаграмма расходов по местам
Название	reports-mini-merchants
Размеры	Ширина: 260px Высота: 360px

Модуль «Операции по продукту»

Описание	Отображение пяти последних операций по конкретному продукту
Название	transactions-history
Размеры	Ширина: 670 Высота: по содержимому

Параметры

Название	Требуется	Тип	Описание
account	+	string	Идентификатор продукта

Модуль «Расходы по категориям по продукту»

Описание	Отображение расходов по категориям по конкретному продукту
Название	reports-account-category
Размеры	Ширина: 670 Высота: по содержимому

Параметры

Название	Требуется	Тип	Описание
account	+	string	Идентификатор продукта

Модуль «Цель по продукту»

Описание	Отображение цели, привязанной к конкретному продукту
Название	goal-for-account
Размеры	Ширина: 670 Высота: по содержимому
Примечания	Если цели по продукту нет, то модуль загружается пустым. Если цели нет по депозиту, то показывается предложение создать новую цель.

Параметры

Название	Требуется	Тип	Описание
account	+	string	Идентификатор продукта

Модуль «Ваши цели»

Описание	Отображение всех целей пользователя
Название	goals-mini
Размеры	Ширина: от 300 до 325 Высота: по содержимому

Модуль «Всего средств»

Описание	Отображает остатки по подключенным профилям
Название	all-funds
Размеры	Ширина: от 300 до 325 Высота: по содержимому

Модуль «Панель обновления»

Описание	Отображает статус всех подключённых профилей.
Название	profile-update-notification
Размеры	Ширина: 250px Высота: по содержимому
Примечания	Модуль предназначен для размещения с фиксацией по нижнему краю – исходя из этого он разворачивается вверх.

Мобильные модули

Модули в данном разделе адаптированы под экраны мобильных устройств.

Модуль «Личные финансы»

Описание	Полная функциональность CASHOFF для мобильных устройств в одном модуле.
Название	mobile-main
Размеры	Ширина: от 320px Высота: от 480px
Примечание	Предназначен для отображения во весь экран устройства и включает в себя навигационную панель в верхней части экрана. Эта навигационная панель содержит в себе кнопку меню, которую необходимо связать с главным меню приложения.

Параметры

Название

Требуется

Тип

Описание

menu

-

string

Идентификатор раздела. Доступные идентификаторы:

overview - обзор
trans - операции
reports - отчеты
goals - цели
profiles - профили
budgets - бюджеты
suggestions - советы
offers - акции
cashback - вознаграждение

Если не указано, то будет открыт раздел обзора.

menu_mode

-

string

Выбор режима меню. Возможные варианты:

external - самого меню нет, есть только кнопка. При ее нажатии вызывается экспортированный в модуль метод toggleMenu(). Приложению необходимо самостоятельно обработать вызов и показать собственное меню, которое будет включать разделы данного модуля.
internal - по кнопке меню открывается внутреннее меню CASHOFF. В этом меню есть только разделы данного модуля

По умолчанию используется режим external - т.е. меню должно быть реализовано вне данного модуля.

Сообщения

Изменение текущего раздела

Данный модуль, как и его веб версия, имеет событие menuPageDidChange, которое он отправляет при смене раздела внутри модуля. Тело сообщения аналогично - объект с идентификатором текущей страницы в атрибуте page.

Модуль «Кешбэк»

Описание	Функционал сервиса «Кешбэк за товар» для мобильных устройств.
Название	cashback
Размеры	Ширина: от 320px Высота: от 480px
Примечание	Предназначен для отображения во весь экран устройства и включает в себя навигационную панель в верхней части экрана. На главной странице модуля эта навигационная панель содержит в себе кнопку "Назад", которая позволяет пользователю вернуться в раздел МП, из которого он изначально пришел в модуль.

Сообщения

Принудительно закрыть модуль

Идентификатор: exitModule. Отправляется, когда пользователь нажимает кнопку "Назад" на главной странице модуля. Оно означает желание пользователя вернуться в ту часть приложения, из которой он перешел в модуль «Кешбэк».

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

Для полноценной работы модуля внутри МП необходимо на стороне МП реализовать сканер qr-кодов (распознавание qr-кода в кадре, захват данных qr-кода, передача их в качестве возвращаемого значения) и экспортировать js-метод openQRScanner, который будет открывать этот сканер и возвращать Promise с результатом сканирования.

Гибридные модули

Гибридные модули адаптированы под весь диапазон устройств и могут быть использованы как на полноразмерных мониторах, так и на мобильных устройствах.

Модуль "Лента историй"

Описание	Модуль представляет собой список историй в виде их превью версий.
Название	stories-list
Размеры	Ширина: произвольная Высота: по содержимому
Навигации	Содержит в себе переходы в модули story и favorite-story-feed

Модуль "Избранные истории"

Описание	Модуль аналогичен модулю stories-list, но показывает не текущии истории, а те, что добавлены в избранное.
Название	stories-favorites-list
Размеры	Ширина: произвольная Высота: по содержимому
Навигации	Содержит в себе переход в модуль story

Модуль "История"

Описание

Модуль просмотра конкретной истории.

Основной способ использования - через навигацию из модуля stories-list

Название

story

Размеры

Ширина: от 300px
Высота: от 600px

Параметры

Название	Требуется	Тип	Описание
storyID	+	string	Идентификатор истории

Сообщения

По завершению просмотра истории или нажатию на кнопку закрытия истории отправляет сообщение exitModule.

Модуль «Обновление профиля»

Описание	Модуль предоставляет интерфейс для создания, обновления и авторизации профиля.
Название	profile-update
Размеры	Ширина: от 320px Высота: по содержимому

Параметры

Название

Требуется

Тип

Описание

action

+

string

Идентификатор действия, которое нужно совершить в модуле:

create: создание нового профиля
update: обновление существующего профиля
continue: выполнение авторизации для запущенного обновления

profile_id

-

string

Идентификатор профиля.

Обязательно для действий update и continue, не используется в других.

provider_key

-

string

Идентификатор провайдера.

Опционально для действия create, не используется в других.

Сообщения

В процессе работы модуль сигнализирует о различных событиях.

Профиль создан

Сообщение отправляется в момент создания профиля и имеет идентификатор profileCreated. В качестве тела получает объект:

Атрибут	Тип	Описание
provider_key	string	Идентификатор провайдера
profile_id	number	Идентификатор созданного профиля

Авторизация завершена

Сообщение отправляется в момент, когда в процессе обновления профиль успешно авторизовался. Идентификатор сообщения profileAuthDone.

Обновление завершено

Сообщение отправляется в момент завершения обновления, успешного или нет. Сообщение имеет идентификатор profileUpdateDone и в качестве тела получает объект:

Атрибут

Тип

Описание

status

string

Идентификатор статуса обновления профиля.

Возможные значения перечислены в документации по серверному API CASHOFF.

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

Модуль последовательно находится в следующих состояниях (шагах):

выбор провайдера
авторизация
индикация процесса импорта данных

Параметр action указывает что нужно совершить в модуле и определяет с какого шага откроется модуль.

action

Описание

create

Модуль открыт с целью добавления нового профиля.

Если параметр provider_key не указан, то модуль откроется с шага 1, где клиент должен будет выбрать провайдера.

После выбора провайдера профиль будет создан, клиент должен будет выполнить авторизацию (шаг 2), после чего увидит индикацию процесса импорта (шаг 3)

update

Модуль открыт с целью обновления существующего профиля. Необходимо передать profile_id.

При открытии будет запущено обновление.

Если сохраненных авторизационных данных достаточно, то клиент сразу попадет на шаг 3. В противном случае он попадет сначала на шаг 2 и пройдет авторизацию.

continue

Модуль открыт с целью продолжения обновления существующего профиля. Необходимо передать profile_id.

Шаг модуля будет соответствовать этапу обновления профиля.

BANKS FAQ : Список модулей

Параметры

Сообщения

Изменение текущего раздела

Параметры

Параметры

Параметры

Сообщения

Изменение текущего раздела

Сообщения

Принудительно закрыть модуль

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

Модуль "Лента историй"

Модуль "Избранные истории"

Модуль "История"

Параметры

Сообщения

Параметры

Сообщения

Профиль создан

Авторизация завершена

Обновление завершено

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