How does the access control work in Voucherify?
Voucherify organizes work on promo campaigns with
projects. These components give you the ability to launch enterprise-grade promotions, which require many parties to be involved. Let's see how access control in Voucherify works in practice:
- Users - you can invite team members to collaborate on campaigns in 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.
- 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. Examples: Jane can operate only on
new acquisition campaignsbut cannot access
employee discountor Vendor A cannot access vendor B's campaigns.
- API keys - each project can have multiple API keys. This gives you the ability to control how your internal applications and 3rd party vendors access your data.
In this section:
In case you might want to share and redeem your coupons by collaboration with affiliates, we supplied Voucherify with features that enable you to limit users' access to the dashboard and perform particular endpoints only.
How does it work? 🤔
Users' 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 endpoints (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 `Merchants` role is available with unique API keys, which you can create in the Voucherify dashboard. To begin with, open the Project Settings and go to the API-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). When you define a name for a merchant, 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.
Roles of users with access to the dashboard 👋
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:
- Firstly, define a role - grant access to particular data and endpoints.
- Secondly, 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:
- USER - can read and modify data from an assigned project, but cannot add new team members or create new projects
- VIEWER - can read all data from an assigned project, but cannot modify any data
- MERCHANT - can redeem/validate vouchers and view redemptions invoked with his/her account. They won't be able to read any other data in the project.
or a CUSTOM ROLE - admin can create new roles and set access rights allowed for each of them.
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 (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 go straight to step two and invite a new team member.
Create a custom role and assign user
If you'd like to add a new users role, follow these steps:
1. Duplicate one of the predefined roles, and the app will direct you to the edit tool.
2. Name your role and select limitations of your given user role.
Available actions and data access 🔓
Below we've listed all actions which can be permitted within Voucherify roles:
- Read dashboard.
- Access onboarding process.
- Read Campaigns.
- Create and modify Campaigns.
- Delete Campaigns.
- Enable Campaigns.
- Disable Campaigns.
- Campaigns' updates must be approved by the Managing User.
- Created Campaigns must be approved by the Managing User.