Skip to main content

​
Create an account

Create an account to start using Voucherify. Fill in your details and choose your region. Your region determines where your data is stored. Choose the region closest to your location to reduce latency. After you sign up, you will receive a verification email. If you don’t receive it, contact Voucherify support.
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.

​
Get your API keys

To use the Voucherify API, you need two credentials:
  • Application ID (sent as X-App-Id header)
  • Application secret key (sent as X-App-Token header)
Add these headers to every API request. To find your keys:
  1. Go to Project settings.
  2. Open the General tab.
  3. Scroll to the Application keys section.
Key types:
  • Application keys – Use these to authorize API requests from your server. You can create multiple keys for different users.
  • Client-side keys – Use these for public applications like mobile apps and websites.
  • Integration keys – Use these to connect with other platforms.
Sandbox API keys are always visible.In production projects:
  • Primary secret key: visible for 14 days after first generation, or 15 minutes after regeneration
  • Secondary secret keys: visible for 15 minutes after generation or regeneration
Save your secret keys immediately and store them securely.

​
Make your first API call

Your Sandbox project includes test campaigns and codes you can use right away. The most common API call is validation. This checks if a customer can use a discount code on their order. To make your first validation call:
  1. Log in to your Voucherify account (top right corner of this page). This connects your Sandbox API keys to the interactive documentation.
  2. Go to Validate stackable discounts.
  3. Click Try it button.
  4. Select your Cluster based on your region:
    • api – Europe
    • us1.api – North America
    • as1.api – Asia
  5. The cURL field on the right will already have the Sandbox onboarding validation selected.
  6. Click Send to send the request.
The response appears above the request. You can modify the request using the interactive documentation. Alternative: Use the Postman collection to make API calls. Next steps: Explore the Sandbox project and Demo shop to test campaigns and view API payloads.

​
Use the Postman collection

Postman is a tool for testing APIs. The Voucherify Postman collection includes all API endpoints and integration examples. To get started:
  1. Go to the Voucherify Postman collection.
  2. Fork the collection to your Postman workspace. For beginners, fork Voucherify API – Onboarding.
  3. Add your API credentials in Environments.
  4. Send your first validation request.
Available collections:

​
Invite team members

To add users to your team:
  1. Click your name in the lower left corner.
  2. Go to Team Settings.
  3. Select Team to invite members and assign roles.
Enterprise clients can use the Management API to perform account-related activities regarding projects, users, and other settings through the API.

​
Explore the Sandbox project

The Sandbox project helps you learn the Voucherify API through the dashboard. Use it alongside the interactive API reference or Postman collection.

​
Audit log

The Audit log tracks all API activity. To view API logs:
  1. Go to Audit log in the left sidebar.
  2. Click Add filter.
  3. Select Channel.
  4. Choose condition in and select API.
The log shows status, method, URL, log ID, channel, and creation date. Click any log entry to see request and response bodies, query parameters, and related events.

​
Demo shop

The Demo shop shows how Voucherify integrates with customer applications. Use it to test campaigns and monitor API calls during the customer journey. To use the Demo shop:
  1. Go to Marketer hub in the left sidebar.
  2. Click Demo shop.
  3. Expand the API calls bar at the bottom of the screen.
The API calls section shows endpoint details, methods, and JSON payloads. You can copy payloads or view the API documentation for each method.
⌘I