Getting Started
Set up your Voucherify project
Creating an Account
Create an account.
Provide all the necessary details and select your preferred region. The selected region affects where your data is stored. To decrease the latency time, setting the region in your operating region is advised.
Europe region
Remember that if your organization sells products or services to customers based in the EU, you must adhere to the General Data Protection Regulation (GDPR).
Learn more in the security and data protection article.
Once you click sign up, you should receive a verification email. If you do not receive the email or if you have lost it, contact our support.
Managing Roles and Inviting Users
Manage your team roles and invite your team members:
- Click your name in the upper tab.
- Go to Team Settings.
- Go to Roles to manage the roles.
- Go to Team to invite members and assign roles to them.
Get Your API Keys
To access Voucherify API, the client application needs to pass Application ID
and Application Secret Key
. To find your keys, head to the Project Settings and in the General tab, scroll down to the Application Keys section. Below that section, you can generate your integration keys and see the client-side keys.
By default, there are two pairs of authentication keys. The first, Application Keys, are meant to authorize your requests to Voucherify API. You can create more Application Keys for each user. The second, Client-Side Keys, are meant for publicly available client applications (mobile apps and web applications).
A generated pair of Application ID and Application Secret Key must be attached to every HTTP request as custom headers: X-App-Id
, X-App-Token
.
API Key Visibility
The primary secret key is visible for 14 days only when it is generated for the first time and for 15 minutes when the token is regenerated. Secondary secret keys are visible for 15 minutes when they are generated for the first time or regenerated.
Write your secret keys down and keep them in a safe place.
The API keys in the Sandbox Project are never hidden.
Testing Your First Campaign
Take a look at the Sandbox project and the Demo Shop to test your first campaigns. Use the already created test campaigns with pre-defined validation rules to learn Voucherify possibilities or create your campaigns and experiment with the platform.
Postman Collection
Take a look at the Voucherify Postman collection, where you can test examples of the basic processes required to integrate Voucherify with your system, advanced interactions, and industry-specific cases.
Enabling Distributions
If you want to test the distribution of vouchers, your account must be verified as part of our anti-spam policy. You can send 10 messages per day, per month, and no emails from an unverified account.
To unlock the limits for trial accounts, set up brand details and contact our support.
Setting up Brand Details
To set up your brand details:
- Click your name in the upper tab.
- Go to Team Settings.
- Go to Brand details.
- Provide the necessary details. You can also provide your logo, a link to your privacy policy or your website.
Distribution Limits
The limits for verified trial accounts are 10 messages per day and 100 messages per month. Note that these limits do not apply to third-party email distribution services.
Learn more about distribution limits in our fair use policy.
Updated 2 days ago