Управление правами в личном кабинете¶
Руководство пользователя.
Настоящий документ представляет собой руководство по использованию интерфейса для разграничения прав доступа в личном кабинете https://dashboard.xpay.by (далее по тексту — ЛК). Руководство определяет порядок предоставления или ограничения прав доступа к таким возможностям как: работа с заявками на подключение к платформе XPAY, управление операциями, доступ к статистике, настройка оповещений и т.д.
Уровень подготовки пользователя¶
Пользователь должен:
- иметь навык работы с любым веб-браузером;
- обладать знаниями о функциональности разделов «Платежи» и «Заявки» в ЛК.
Подготовка к работе¶
См. описание раздела «Подготовка к работе» документа «Личный кабинет. Руководство пользователя».
После успешной авторизации необходимо проверить доступность функциональности: нажать на иконку профиля в правом верхнем углу страницы. Если среди появившейся информации присутствует раздел «Ваши организации», в котором отображается «default organization» — функциональность доступна.
Описание элементов интерфейса¶
Ниже представлено краткое описание элементов интерфейса за исключением тех, что отражены в документе «Личный кабинет. Руководство пользователя».
Элемент | Описание |
---|---|
![]() |
Действие успешно совершено. Текст сообщения может отличаться от указанного здесь |
![]() |
Произошла ошибка. Действие не завершилось успешно. Текст сообщения может отличаться от указанного здесь |
![]() |
Подтвердить/отменить действие |
![]() |
Обновить список. Действует аналогично обновлению веб-страницы |
![]() ![]() |
Применить изменения |
![]() |
Раскрыть список |
![]() |
Закрыть форму |
Описание операций¶
Ниже отражен перечень действий, выполняемых в рамках управления правами доступа пользователей в ЛК.
Функция | Операция (задача) | Цель | Права владельца/администратора |
---|---|---|---|
Управление приглашениями в организацию | Пригласить пользователя в организацию | Предоставить определенные права доступа к ЛК | Да |
Управление приглашениями в организацию | Отменить приглашение | На случай, если приглашение было отправлено ошибочно | Да |
Управление правами доступа | Изменить текущие права доступа | Ограничить/расширить перечень доступных пользователю магазинов. Выдать пользователю дополнительную роль | Да |
Управление правами доступа | Исключить пользователя из организации | Лишить пользователя доступа ко всем магазинам, изменить текущий набор ролей пользователя путем его исключения и повторного приглашения | Да |
Действия приглашенного пользователя | Вступить в организацию | Получить определенные права доступа к ЛК владельца организации | Нет |
Действия приглашенного пользователя | Ознакомиться с правами и возможностями | Увидеть, к каким магазинам в ЛК владельца организации имеется доступ и какие действия при работе с ними можно совершать | Нет |
Действия приглашенного пользователя | Покинуть организацию | Лишиться доступа к ЛК владельца в рамках покинутой организации | Нет |
Управление организацией | Создать новую организацию | Объединить пользователей по неким признакам. Например, по ролям (только администраторы, только менеджеры), по степени риска и т.д. | Нет |
Управление организацией | Переименовать организацию | Дать более конкретное название созданной по-умолчанию организации | Да, если организация была создана не тем пользователем, который ее переименовывает |
Управление приглашениями в организацию¶
Организация — сущность, в рамках которой один пользователь (владелец) может управлять доступом других пользователей (сотрудников) к различной функциональности своего ЛК.
Для каждого пользователя ЛК по умолчанию создана одна организация, владельцем которой он является.
Изначально организация не включает в себя пользователей, правами которых может управлять владелец: их необходимо пригласить. Приглашения, которые еще не были приняты, можно отменить.
Для того чтобы управлять приглашениями, необходимо выполнить нижеописанные действия.
- Нажать на иконку профиля в правом верхнем углу страницы ЛК.
- Выбрать «Ваши организации».
- Нажать на строку с названием интересующей организации.
- Перейти в «Управление сотрудниками и организациями».
- Сделать активной вкладку «Приглашения».
Пригласить пользователя в организацию¶
Для того чтобы пригласить пользователя в организацию, необходимо пройти все шаги раздела «Управление приглашениями в организацию» и выполнить нижеописанные действия.
- Нажать «Сформировать приглашение».
- Ввести email для приглашения пользователя в открывшемся поверх страницы окне (здесь и далее по тексту — модальное окно).
- Нажать «Добавить».
- Выбрать интересующую роль, сделав активным переключатель под ней (здесь и далее по тексту — radio button).
- Нажать «Выбрать».
- Отметить магазины, с которыми будет работать пользователь в назначенной ему роли.
- Нажать «Отправить приглашение».
Пользователь получит назначенные ему права после вступления в организацию.
ПРИМЕЧАНИЯ
- При необходимости, пользователю можно назначить более одной роли. Пример: пользователь user@mail.com должен обладать правами роли «Менеджер» при работе с магазином 1 и правами роли «Бухгалтер» при работе с магазином 5. Для назначения нескольких ролей перед отправкой приглашения следует повторить действия из п.3 - п.6.
- Подробнее о ролях и правах доступа можно прочесть в разделе “Описание ролей и концепции доступа”.
- Организацию можно переименовать.
Отменить приглашение¶
В случае, когда приглашение отправлено ошибочно или решение о выдаче прав доступа пересмотрено — владелец или администратор организации может его отменить.
Для того чтобы отменить приглашение, необходимо пройти все шаги раздела «Управление приглашениями в организацию» и выполнить нижеописанные действия.
- Найти в общем списке пользователя, приглашение которого необходимо отменить.
- Раскрыть подробности его учетной записи.
- Нажать «Отменить приглашение».
ПРИМЕЧАНИЯ
Отмененное приглашение нельзя возобновить. Для того чтобы снова пригласить пользователя, чье приглашение уже было отменено, необходимо пройти все шаги раздела «Пригласить пользователя в организацию».
Управление правами доступа¶
Владелец или администратор организации может:
- ограничить список магазинов, с которыми будет работать пользователь в назначенной ему роли;
- выдать пользователю дополнительную роль;
- исключить пользователя из организации.
Для того чтобы управлять правами доступа, необходимо выполнить нижеописанные действия.
- Пройти шаги п.1 - п.4 раздела «Управление приглашениями в организацию».
- Проверить, что вкладка «Сотрудники» является активной.
- Найти в общем списке пользователя, которому планируется изменить права доступа.
- Раскрыть подробную информацию: появится список ролей и дополнительные возможности.
Изменить текущие права доступа¶
Для того чтобы изменить перечень доступных пользователю магазинов или ролей, необходимо пройти все шаги раздела «Управление правами доступа» и выполнить нижеописанные действия.
- Нажать «Редактировать».
- Отметить магазины, к которым пользователю разрешен доступ в разрезе каждой отдельной роли, или добавить новую роль (см. п.3 - п.6 раздела «Пригласить пользователя в организацию»).
ПРИМЕЧАНИЯ
- Каждое нажатие на checkbox (отметка галочкой) сохраняет внесенное изменение.
- Уже вступившего в организацию пользователя нельзя лишить существующей роли. Если такая необходимость имеется — следует исключить пользователя из организации, а затем пригласить его, назначив все необходимые роли.
- Подробнее о ролях и правах доступа можно прочесть в разделе «Описание ролей и концепции доступа».
Исключить пользователя из организации¶
Для того чтобы исключить пользователя из организации, необходимо пройти все шаги раздела «Управление правами доступа» и выполнить нижеописанные действия.
- Нажать «Исключить из организации»
- Подтвердить действие в открывшемся модальном окне.
- Проверить, что пользователь отсутствует в общем списке.
Действия приглашенного пользователя¶
Вступить в организацию¶
Для того чтобы вступить в организацию и получить доступ к ЛК ее владельца, необходимо выполнить нижеописанные действия.
- Получить от владельца организации приглашение по email.
- Пройти по ссылке в письме/открыть ссылку в веб-браузере.
- Нажать «Подтвердить» и «Перейти к списку организаций».
- Ознакомиться с деталями организации и перечнем ролей, которые назначены владельцем.
ПРИМЕЧАНИЯ
В случае, когда приглашение было отправлено, а затем отменено, ссылка из письма станет неактивной — пройдя по ней пользователь не сможет вступить в организацию.
Ознакомиться с правами и возможностями¶
Для того чтобы посмотреть свои права и возможности, необходимо выполнить нижеописанные действия.
- Пройти шаги п.1 - п.3 раздела «Управление приглашениями в организацию».
- Раскрыть подробную информацию по интересующей роли: появится список магазинов, при работе с которыми действуют ее права.
ПРИМЕЧАНИЯ
Подробное описание ролей и их возможностей можно найти в разделе «Описание прав доступа».
Покинуть организацию¶
Покинуть организацию может любой состоящий в ней пользователь (помимо владельца). Для того чтобы покинуть организацию, необходимо выполнить нижеописанные действия.
- Пройти шаги п.1 - п.3 раздела «Управление приглашениями в организацию».
- Нажать «Покинуть организацию».
Управление организацией¶
Создать новую организацию¶
Любой пользователь может создать новую организацию (тем самым став ее владельцем). Для этого необходимо выполнить нижеописанные действия.
- Пройти шаги п.1 - п.2 раздела «Управление приглашениями в организацию».
- Нажать «Создать организацию».
- Ввести название организации в открывшемся модальном окне.
- Нажать «Подтвердить».
- Проверить, что организация появилась в списке доступных.
Переименовать организацию¶
Для того чтобы изменить текущее название организации, ее владельцу или администратору необходимо выполнить нижеописанные действия.
- Пройти шаги п.1 - п.3 раздела «Управление приглашениями в организацию».
- Нажать «Переименовать организацию».
- Ввести новое имя в открывшемся модальном окне.
- Нажать «Подтвердить».
Описание ролей и концепции доступа¶
В части управления правами ЛК оперирует следующими сущностями:
Сущность | Описание |
---|---|
Организация | Сущность, в рамках которой один пользователь (владелец) может управлять доступом других пользователей (сотрудников) к различной функциональности ЛК. Например, позволять создавать счета на оплату, просматривать статистику по платежам, настраивать оповещения и т.д. Пользователи, не состоящие в организации, не имеют доступа к данным из ЛК владельца. Количество организаций для одного пользователя не ограничено |
Роль | Сущность, определяющая набор прав пользователя. У одного пользователя может быть более одной роли |
Магазин | Сущность, с которой пользователь может совершать лишь те действия, которые предусмотрены его ролью. Роль назначается для конкретных магазинов |
В ЛК существуют 4 роли преднастроенные роли: каждая из них уже обладает определенным набором прав. Зеленым цветом отмечено наличие права.
Право | Описание |
---|---|
Просмотр аналитики | Доступ к функциональности раздела «Сбор аналитических данных». Возможность ознакомиться с оборотом денежных средств, количеством платежей, средним чеком и иными аналитическими данными |
Просмотр инвойсов | Возможность получить информацию по выставленным для оплаты заказов счетам. |
Просмотр платежей | Возможность получить информацию по операциям оплаты созданных заказов |
Просмотр возвратов | Возможность получить информацию по операциям возврата денежных средств покупателю |
Просмотр API key | Возможность получить приватный ключ для доступа к API |
Управление отчетами | Доступ к функциональности раздела «Формирование отчетности». Возможность сформировать реестр операций и акт об оказании услуг |
Управление Webhooks | Возможность настраивать уведомления о состоянии инвойсов, платежей и возвратов |
Создать инвойс | Возможность выставить счет для оплаты заказа |
Создать платежную ссылку | Возможность создать ссылку для оплаты заказа |
Совершить возврат | Возможность инициировать возврат денежных средств по исходной операции оплаты заказа |
Заявки | Доступ к функциональности раздела «Управление заявками» |
Управление организациями и сотрудниками | Доступ ко всей функциональности, описанной в данном руководстве |
ПРИМЕЧАНИЯ
- Владелец и администратор обладают полным набором прав по отношению ко всем существующим магазинам (созданным под учетной записью владельца). Для пользователей с другими ролями доступ к тому или иному магазину необходимо указывать явно.
- Список доступных для выбора магазинов формируется автоматически: отражает все активные ранее созданные под учетной записью владельца магазины.
Обращения в поддержку¶
См. описание раздела «Обращения в поддержку» документа «Личный кабинет. Руководство пользователя».