User Roles & Access Control
Voucherify organizes work on promotional campaigns with Users and Projects. These components give you the ability to launch enterprise-grade promotions, which require the involvement of many parties. Let's see how access control in Voucherify works in practice.
- Key Concepts
- Merchants with no access to the dashboard
- Roles of users with access to the dashboard:
- List of actions permitted within Voucherify roles – dictionary
If you want to share and redeem promo codes by collaborating with affiliates, we supplied Voucherify with features that enable you to limit users' access to the dashboard and perform particular actions only.
- Users – you can invite team members to collaborate on campaigns on the Dashboard. After account confirmation, new users can be granted access to projects. Each user's activity is tracked and can be seen in the audit logs. Go here to learn how to invite new members.
- Projects – projects group campaigns in collections. The primary goal of projects is to help you control user access to campaigns. You can define which users have access to separate projects. For example, Jane can operate only on new acquisition campaigns but cannot access employee discounts. Go here to learn more about managing your projects.
- API keys – each project can have multiple API keys. This gives you the ability to control how your team members and 3rd party vendors interact with the API and access data. Learn more about API keys here.
The user structure is managed per project. However, the custom roles are defined for the whole organization.
Merchants with API keys
Merchants with API keys are allowed to perform validation and redemption only, excluding other activities (they don't have access to the Dashboard). You can make as many redemption points as you want to and keep the only rights to create and manage your coupons.
Coupons are generated and managed by your Voucherify account.
- When vouchers are ready, you can deliver them to your affiliates (Merchants) where they are published.
- Customers can now come to these stores (Merchants) to redeem their codes.
- The Merchant sends a redemption request to Voucherify. If the coupon is valid, Voucherify sends a positive response, and the redemption is successful (all redemption details are noted in your Voucherify account).
The Merchant role is available with unique API keys, which you can create in the Voucherify Dashboard.
To begin, open the Project Settings and go General > Application Keys section.
- Choose Plus to generate unique API keys and assign them to a particular merchant (you can add as many merchants as you want to). After you define a name for a merchant and choose the Merchant role, choose Create access API key option.
- Share the API key with your affiliate and send the coupons (see export options) to publish. With these credentials, the Merchant can validate/redeem delivered codes.
Users with dashboard access
Within Team settings, you can also assign particular roles to your team members and affiliates. Roles control what kind of access to your data a specific user is granted.
The roles can be added only by the ADMIN user, who doesn't have any limits on an account.
The process is divided into two main steps:
- Define a role – grant access to particular data and activities (endpoints).
- Invite a new team member and assign them to the role.
While inviting a new team member to the project, an administrator can assign one of the built-in roles:
|ADMIN||Has full access to everything in the workspace.|
|USER||Can read, modify and export data from an assigned project, but cannot add new team members or create new projects.|
|VIEWER||Can read all data from an assigned project and export data, but cannot modify any data.|
|MERCHANT||Can search vouchers by the code, search customers by their source id, email, and phone number, redeem vouchers and view redemptions invoked with his/her account. Merchants have access to the products list but can't update or create products. They won't be able to read any other data in the project or perform any other action besides a redemption. Merchants are allowed to export their redemptions.|
|CUSTOM ROLE||ADMIN can create new roles and set access rights allowed for each of them. By default, custom roles have data export disabled.|
To manage Users' Structure, go to the Team settings – ROLES.
In the roles directory, you can:
- view actions performed within predefined roles (click on a role name to view details),
- add new roles (see the section below),
- edit your custom roles with the pencil tool .
Assign a user to a built-in role
If you'd like to use one of the default roles (User, Merchant, or Viewer), you can invite a new team member. Read more here.
Create a custom role and assign user
If you'd like to add a new role, follow these steps:
In Team Settings > Roles, duplicate one of the predefined roles, and the app will direct you to the edit tool.
Name your role, select limitations of your given user role, and click Save.
Go to Team Settings > Team. If you choose to add a new member, click Invite Member.
- You will have the option of adding an email address, their first and last name, add the user to a project and assign the custom role to the user within the project scope.
To add the user to a project, Select a Project from the list and then select the Role that the user will have within the project.
To remove the user from a project, click on the .
When you are finished with assigning projects and roles, click Invite Member. Read more about inviting a member here.
If you choose to edit a user, click on the tricolon ⁝ next to the user whose role you would like to modify, then choose Edit. You have the option of updating their first and last name, remove the user from a project, add the user to a project and assign the custom role to the user.
When you are finished with assigning projects and roles, click Save.
Below we've listed all actions which can be permitted within Voucherify roles:
- Read Dashboard.
- Access onboarding process.
- Read Campaigns.
- Create Campaigns
- Modify Campaigns and related Validation Rules.
- Delete Campaigns.
- Enable Campaigns.
- Disable Campaigns.
- Export Points Expirations.
- Campaigns' updates must be approved by the Managing User.
- Created Campaigns must be approved by the Managing User.
- Read Vouchers.
- Read Voucher by code.
- Create Vouchers.
- Modify Vouchers.
- Enable Vouchers.
- Disable Vouchers.
- Redeem Voucher.
- Rollback Redemptions(Rollback means turning back redemption once it's made).
- Publish Voucher.
- Import Vouchers.
- Export Vouchers.
- Delete Vouchers.
- Add balance to Gift Vouchers.
- Adding vouchers to existing Campaigns must be approved by the Managing User.
- Vouchers' updates must be approved by the Managing User.
- Created standalone Vouchers must be approved by the Managing User.
- Read Redemptions.
- Read Redemptions history of identified Voucher.
- Rollback Redemptions.
- Export Redemptions.
- Limit listing of Redemptions to those done by User (if you mark this box, users will see only redemptions invoked by their account).
- Read and export Distributions and Publications.
- Create and modify Distributions.
- Enable Distributions.
- Disable Distributions.
- Export Publications.
- Read Customers.
- Read a single Customer by ID or Source ID.
- Create and modify Customers and Segments.
- Export Customers.
- Read Products.
- Create and modify Products.
- Import Products
- Read events and technical logs (Logs enable users to investigate every API call related to the selected voucher).
- Access Project Settings.
- Access and configure integrations.
- Access to Project Users list (required in, i.e. cases like Validation Rules or Redemptions list filtering).
- Modify base Project Details (like Locale, Currency, etc.).
- Read API keys and other Settings.
- Modify API keys and other Settings, including upgrading the API version.
- Read defined Webhooks.
- Create and modify Webhooks.
- Read Metadata Schema.
- Add and modify Metadata Schema.
- Read Custom Event Schema.
- Add and modify Custom Event Schema.
- Delete Custom Event Schema.
- Read Custom Domains' essential data.
- Add and modify Custom Domains, including uploading SSL certificates.
- Link Custom Domains with desired resources (landing pages, cockpits).
- Delete Custom Domain and drop the link.
- Read Validation Rules.
- Create and modify Validation Rules.
- Delete Validation Rules.
Validation Rules Limitations
- Validation Rules' changes must be approved by the Managing User.
- Read Landing Pages.
- Create and modify Landing Pages.
- Delete Landing Pages.
- Read locations.
- Create and modify locations.
- Delete locations.