Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.idea/*
4 changes: 4 additions & 0 deletions 19-how-does-the-distribution-manager-work.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
url: "https://support.voucherify.io/article/19-how-does-the-distribution-manager-work"
---

4 changes: 4 additions & 0 deletions 405-integration-catalog.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
url: "https://support.voucherify.io/category/405-integration-catalog?sort=name"
---

4 changes: 4 additions & 0 deletions 48-referral-program-basics.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
url: "https://support.voucherify.io/article/48-referral-program-basics"
---

4 changes: 4 additions & 0 deletions 491-getting-started-with-loyalty-programs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
url: "https://support.voucherify.io/article/491-getting-started-with-loyalty-programs"
---

4 changes: 4 additions & 0 deletions 538-sandbox.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
url: "https://support.voucherify.io/article/538-sandbox"
---

Binary file added ca79d4d-small-favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
286 changes: 124 additions & 162 deletions docs.json
Original file line number Diff line number Diff line change
@@ -1,166 +1,128 @@
{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"name": "Mint Starter Kit",
"colors": {
"primary": "#122460",
"light": "#07C983",
"dark": "#15803D"
},
"favicon": "/favicon.svg",
"navigation": {
"tabs": [
{
"tab": "Developer guides",
"groups": [
{
"group": "Getting started",
"pages": [
"guides/getting_started/welcome-to-voucherify",
"guides/getting_started/introduction",
"guides/getting_started/key-concepts",
"guides/getting_started/project-setup-guide"
]
},
{
"group": "Integration blueprint",
"pages": [
"guides/integration_blueprint/integration-overview",
"guides/integration_blueprint/campaign-limits"
]
},
{
"group": "Development",
"pages": [
"guides/development/API-Endpoints",
"guides/development/API-Optimization",
"guides/development/API-Reference",
"guides/development/API-Version-Upgrades"
]
},
{
"group": "Distribution recipes",
"pages": [
"guides/distribution_recipes/Messaging-Automation"
]
},
{
"group": "Customization",
"pages": [
"essentials/settings",
"essentials/navigation"
]
},
{
"group": "Writing content",
"pages": [
"essentials/markdown",
"essentials/code",
"essentials/images",
"essentials/reusable-snippets"
]
},
{
"group": "AI tools",
"pages": [
"ai-tools/cursor",
"ai-tools/claude-code",
"ai-tools/windsurf"
]
}
]
},
{
"tab": "API reference",
"groups": [
{
"group": "Endpoints",
"openapi": {
"source": "/api-reference/openapi.json",
"directory": "api-reference"
}
},
{
"group": "Events",
"openapi": {
"source": "/api-reference/OpenAPIWebhooks.json",
"directory": "api-reference"
}
}
]
},
{
"tab": "Voucherify dashboard documentation",
"groups": [
{
"group": "Campaigns",
"pages": [
"dashboard-stuff/campaigns/discount"
]
},
{
"group": "Something",
"pages": [
"dashboard-stuff/campaigns/discount"
]
}
]
}
],
"global": {
"anchors": [
{
"anchor": "Documentation",
"href": "https://mintlify.com/docs",
"icon": "book-open-cover"
},
{
"anchor": "Community",
"href": "https://mintlify.com/community",
"icon": "slack"
},
{
"anchor": "Blog",
"href": "https://mintlify.com/blog",
"icon": "newspaper"
}
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"name": "Introduction",
"colors": {
"primary": "#122460",
"light": "#122460",
"dark": "#122460"
},
"favicon": "/ca79d4d-small-favicon.png",
"navigation": {
"tabs": [
{
"tab": "Guides",
"groups": [
{
"group": "Getting started",
"pages": [
"docs/introduction",
"docs/welcome-to-voucherify",
"docs/getting-started",
"docs/key-concepts"
]
},
{
"group": "Integration Blueprint",
"pages": [
"docs/integration-overview",
"docs/campaign-limits",
"docs/distributions",
"docs/campaign-reporting",
"docs/team-management",
"docs/brand-management",
"docs/security"
]
},
{
"group": "Development",
"pages": [
"docs/welcome",
"docs/authentication",
"docs/integration-processes",
"docs/data-parsing",
"docs/metadata-mapping",
"docs/data-synchronization",
"docs/api-endpoints",
"docs/sdks",
"docs/management-api",
"docs/performance",
"docs/limits",
"docs/api-optimization",
"docs/client-side-api",
"docs/api-version-upgrades",
"docs/fraud-prevention-mechanisms"
]
},
{
"group": "Campaigns Recipes",
"pages": [
"docs/checking-eligibility",
"docs/locking-validation-session",
"docs/transfer-loyalty-points"
]
},
{
"group": "Discounts Recipes",
"pages": [
"docs/manage-stackable-discounts",
"docs/discount-effects",
"docs/give-item-for-free-unit-discount"
]
},
{
"group": "Distributions Recipes",
"pages": [
"docs/csv-export",
"docs/import-codes"
]
}
},
"logo": {
"light": "/logo/light.svg",
"dark": "/logo/dark.svg"
},
"navbar": {
"links": [
{
"label": "Support",
"href": "mailto:hi@mintlify.com"
},
{
"group": "More",
"pages": [
"docs/support"
]
}
]
},
{
"tab": "API reference",
"groups": [
{
"group": "Introduction",
"pages": [
"docs/introduction-1",
"docs/errors",
"docs/versioning",
"docs/listing",
"docs/object-schemas"
]
},
{
"group": "Object schemas",
"pages": [
"docs/objects/redemption-object",
"docs/objects/voucher-object",
"docs/objects/campaign-object"
]
},
{
"group": "Endpoints",
"openapi": {
"source": "/api-reference/openapi.json",
"directory": "api-reference"
}
},
{
"group": "Events",
"openapi": {
"source": "/api-reference/OpenAPIWebhooks.json",
"directory": "api-reference"
}
],
"primary": {
"type": "button",
"label": "Dashboard",
"href": "https://dashboard.mintlify.com"
}
},
"contextual": {
"options": [
"copy",
"view",
"chatgpt",
"claude",
"perplexity",
"mcp",
"cursor",
"vscode"
}
]
},
"footer": {
"socials": {
"x": "https://x.com/mintlify",
"github": "https://github.com/mintlify",
"linkedin": "https://linkedin.com/company/mintlify"
}
}
}
}
]
},
"logo": "/images/c94a6d3-small-voucherify_logo_white.png"
}
44 changes: 44 additions & 0 deletions docs/api-endpoints.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: "API endpoints"
description: "Suggest Edits"
---

Voucherify is shipped from shared clusters located on three continents, as well as from dedicated clusters for enterprise customers.

If you want to get the best performance from Voucherify, it is recommended to create a project in the region (cluster) closest to your customers.

When you create a project, you can choose a preferred region. You can have projects located in different regions within one organization.

If your project is not created in Europe and your organization has a dedicated cluster, you must configure your application to use the appropriate API endpoint. Otherwise, your HTTP requests will be rejected.

The default API endpoint for the shared cluster in Europe is `https://api.voucherify.io`. Other API endpoints are created with the `https://<region>.api.voucherify.io` pattern.

## Shared Clusters

| **Shared Cluster** | **Endpoint** |
| ------------------ | ------------------------------- |
| Europe (default) | `https://api.voucherify.io` |
| United States | `https://us1.api.voucherify.io` |
| Asia (Singapore) | `https://as1.api.voucherify.io` |

## SDK

Each [SDK](/docs/sdks) provided by Voucherify has a method to override the default API endpoint.

* [https://github.com/rspective/voucherify.js#api-endpoint](https://github.com/rspective/voucherify.js#api-endpoint)
* [https://github.com/voucherifyio/voucherify-nodejs-sdk#api-endpoint](https://github.com/voucherifyio/voucherify-nodejs-sdk#api-endpoint)
* [https://github.com/voucherifyio/voucherify-java-sdk#api-endpoint](https://github.com/voucherifyio/voucherify-java-sdk#api-endpoint)
* [https://github.com/voucherifyio/voucherify-ruby-sdk#api-endpoint](https://github.com/voucherifyio/voucherify-ruby-sdk#api-endpoint)
* [https://github.com/voucherifyio/voucherify-php-sdk#custom-api-url](https://github.com/voucherifyio/voucherify-php-sdk#custom-api-url)
* [https://github.com/voucherifyio/voucherify-python-sdk#api-endpoint](https://github.com/voucherifyio/voucherify-python-sdk#api-endpoint)
* [https://github.com/voucherifyio/voucherify-dotNET-sdk#api-endpoint](https://github.com/voucherifyio/voucherify-dotNET-sdk#api-endpoint) [https://github.com/voucherifyio/voucherify-dotNET-sdk#api-endpoint-1](https://github.com/voucherifyio/voucherify-dotNET-sdk#api-endpoint-1)
* [https://github.com/voucherifyio/voucherify-android-sdk#configuration](https://github.com/voucherifyio/voucherify-android-sdk#configuration)
* [https://github.com/voucherifyio/voucherify-ios-sdk#api-endpoint](https://github.com/voucherifyio/voucherify-ios-sdk#api-endpoint)
* [https://github.com/voucherifyio/voucherify-rust-sdk#api-endpoint](https://github.com/voucherifyio/voucherify-rust-sdk#api-endpoint)

***

* [Table of Contents](#)

* * [Shared Clusters](#shared-clusters)
* [SDK](#sdk)
Loading