Introduction

What is Voucherify API?

The Voucherify API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, such as HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients.

We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application

Never expose your secret API key in any public website’s client-side code.

JSON is returned by all API responses, including errors. However, Voucherify API libraries convert responses to appropriate language-specific objects.

To make the API as explorable as possible, this documentation has a test mode. You can test all methods at no cost. Click Try it in an endpoint page to open a playground and configure your request.

An API call is a single request sent to the Voucherify API to process, save, or fetch data. For example, when a customer redeems a discount coupon, the redemption request counts as one API call. API calls are counted against your project limits. If you exceed your hourly or monthly quota in a production project, your campaigns may be blocked. You can check current API usage in Project settings > API Usage. To increase API call limits, upgrade your pricing plan or buy an API call package.

Fields that are necessary in the request are marked as required. Fields that will always be returned in the response are also marked as required.

In general the API consists of 3 sets:

• Application API - full capability, designed to be accessed from your server application
• Client API - limited capability, designed to be accessed from your website or mobile application
• Management API - endpoints designed to manage Voucherify projects within organization. Enterprise feature only - contact Voucherify sales team for more details.

Find out more about how to authenticate your application to access the API.