Skip to content

Commit

Permalink
Minor corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
p-woznikowski committed Dec 4, 2023
1 parent 10ef004 commit d877632
Show file tree
Hide file tree
Showing 17 changed files with 29 additions and 28 deletions.
2 changes: 1 addition & 1 deletion docs/guides/development/API-Endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Voucherify is shipped from shared clusters located on three continents, as well

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 your create a project, you can choose a preferred region. You can have projects located in different regions within one organization.
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.

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/development/API-Optimization.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Voucherify API for stackable discounts lets you validate and redeem multiple obj

In the redemption request, you need to provide a list of redeemables that define what discounts or codes will be redeemed/validated. By integrating stackable discount API into your app, you can make a single call with multiple redeemables, instead of separate redemption calls for each of them.

Read more about the [Stackable Discounts API.](doc:manage-stackable-discounts)
Read more about the [Stackable Discounts API](doc:manage-stackable-discounts).

### Data import

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/development/Client-Side-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ hidden: false
order: 190
---

Sometimes it's important to validate a promo code or promotion on the client-side, e.g., you want to calculate and display a discounted price on the fly. That's why Voucherify comes with client-side features build in [Voucherify JS SDK](https://github.com/voucherifyio/voucherify-js-sdk) - an open-source JavaScript library which enables you to query the API.
Sometimes it's important to validate a promo code or promotion on the client side, e.g., you want to calculate and display a discounted price on the fly. That's why Voucherify comes with client-side features built into [Voucherify JS SDK](https://github.com/voucherifyio/voucherify-js-sdk) - an open-source JavaScript library that enables you to query the API.

Among other features it delivers [Voucherify React Widgets](https://github.com/voucherifyio/voucherify-js-sdk#-voucherify-react-widget)
Among other features, it delivers [Voucherify React Widgets](https://github.com/voucherifyio/voucherify-js-sdk#-voucherify-react-widget)

<!-- ![React Widget](../../assets/img/guides_development_client_side_api_widget_1.gif "React Widget") -->
![React Widget](https://files.readme.io/0427b12-widget.gif "React Widget")
Expand All @@ -24,7 +24,7 @@ Voucherify JS SDK offers many client-side features:

## Installation & reference

Visit :fa-github-alt: [Github repository](https://github.com/voucherifyio/voucherify-js-sdk) to get the up-to-date documentation.
Visit :fa-github-alt: [Github repository](https://github.com/voucherifyio/voucherify-js-sdk) to get the current documentation.

> 🚧 Domain white list
>
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/development/Examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ To manage promotional activities on the frontend, consider using Voucherify open

## Figma Promo UI Kits

Looking for ready designs for the best promotions experience in your ecommerce store? Check out our 100% customizable UI kit with ready-to-use components based on the best practices for usability:
Looking for ready designs for the best promotions experience in your e-commerce store? Check out our 100% customizable UI kit with ready-to-use components based on the best practices for usability:

* [Download Coupon & Promotions UI Kit on Figma](https://www.figma.com/community/file/1100356622702326488)
* [Download Referral UI Kit on Figma](https://www.figma.com/community/file/1039555483777372722)
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/development/Limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To understand the basic limits of your account, check out [Pricing](https://www.
## Enterprise plan

Users with an Enterprise plan have custom API requests limits. Depending on the case, it can be counted per hour or per minute. Bulk API requests are counted in hour periods in both cases.
Users with an Enterprise plan have custom API request limits. Depending on the case, it can be counted per hour or per minute. Bulk API requests are counted in hour periods in both cases.

## Webhooks

Expand Down Expand Up @@ -73,7 +73,7 @@ These headers are:
- `X-Rate-Limit-Remaining` - number of API requests that can still be made in a current period
- `X-Rate-Limit-Retry` - the time when the next API request can be made, in Unix epoch format (in seconds)
- `Retry-After` - (optional) number of seconds left before the next API request can be made, shown after a limit is reached
- `X-Rate-Limit-Type` - (optional) type of API limit that was reached, possible values: api_calls / bulk_api_calls / api_calls_cycle / webhook_calls
- `X-Rate-Limit-Type` - (optional) type of API limit that was reached, possible values: api_calls / bulk_api_calls / api_calls_cycle / webhook_calls

## Notifications

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/development/data-synchronization.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Read our [customer import guide](https://support.voucherify.io/article/67-how-to

If you want to keep your customers database up to date with Voucherify, create a customer in Voucherify every time a new user is added to your database. Use the [create customer](ref:create-customer) API endpoint to create customer data.

To update customer data, use [update customer](ref:update-customer) API endpoint. The [create customer](ref:create-customer) API endpoint can be also used to update customer data.
To update customer data, use the [update customer](ref:update-customer) API endpoint. The [create customer](ref:create-customer) API endpoint can be also used to update customer data.

#### Synchronizing with connectors

Expand Down
6 changes: 4 additions & 2 deletions docs/guides/getting_started/Key-Concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,11 @@ There are two types of segments in Voucherify:
- **auto-update**: customers are dynamically added to or removed from the segment if they match a given filter, e.g., the customer's birthday is today.

> πŸ“˜ Learn more
> - [Customer segments](https://support.voucherify.io/article/51-customer-segments)
> - [Customer segments](https://support.voucherify.io/article/51-customer-segments) article
## Incentivization <!-- TBD -->
## Incentivization rules and processes <!-- TBD -->

In Voucherify, you can set rules that govern how incentives, such as vouchers or discounts, are applied. Also, the incentives can be managed under several processes related to their application.

### Validation rules

Expand Down
9 changes: 4 additions & 5 deletions docs/guides/getting_started/Welcome-to-Voucherify.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,15 @@ As a [MACH-certified vendor](https://machalliance.org/), Voucherify follows the

## Who uses Voucherify and why?

Voucherify can be successfully adopted across industries in B2C and B2B contexts – from ecommerce to travel and mobile on-demand services.
Voucherify can be successfully adopted across industries in B2C and B2B contexts – from e-commerce to travel and mobile on-demand services.

Leveraging targeted promotions at every stage of the customer lifecycle can help you maximize engagement. This way, you can acquire customers through social media promotion, convert them with a welcome offer, grow them as customers via referrals, and ultimately, build better retention tactics with smart loyalty campaigns and re-engage them with incentives tailored to their profiles. This is the perfect scenario that each brand should aspire to achieve. But to get there, you need proper technology.

![Promotion lifecycle](https://files.readme.io/bebe00d-guides_getting_started_welcome_to_voucherify_acquisition_to_re-activation_diagram-02.png "Promotion lifecycle showing acquisition, conversion, growth, retention, and re-activation")

## Retail – Ecommerce & POS
## Retail – e-commerce and POS


Voucherify is perfect for ecommerce brands transitioning to MACH and building a standard tech stack for their brands. We work great with commercetools and other MACH tools when it comes to scaling across multiple countries/brands, including integrating various business models (DTC, B2B, marketplace).
Voucherify is perfect for e-commerce brands transitioning to MACH and building a standard tech stack for their brands. We work great with commercetools and other MACH tools when it comes to scaling across multiple countries/brands, including integrating various business models (DTC, B2B, marketplace).

Voucherify enhances store capabilities with advanced promotions, crucial for revenue. At the same time, Voucherify opens the door to loyalty and referral programs without the need to integrate any additional platform.

Expand Down Expand Up @@ -136,7 +135,7 @@ QSRs often need to handle a large volume of data in real-time. Voucherify provid

## Software vendors

Voucherify APIs can be effectively integrated into other software tools to drastically enhance the offer of technology vendors. Voucherify has already been successfully incorporated into mobility technologies, booking services, and ecommerce and marketplace engines.
Voucherify APIs can be effectively integrated into other software tools to drastically enhance the offer of technology vendors. Voucherify has already been successfully incorporated into mobility technologies, booking services, and e-commerce and marketplace engines.

> πŸ‘ Customer story – Grinta
>
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/integration_blueprint/Campaign-reporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ order: 12
> * Learn Voucherify API and Dashboard reporting capabilities.

> πŸ‘ **Outcome**:
> πŸ‘ **Outcome**
>
> Connect Voucherify to external BI tools or prepare reports using built-in campaign analytics.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/integration_blueprint/Data-Model.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ order: 8
> * Learn more about metadata.
> * Choose which attributes and events you would like to share with Voucherify.
> πŸ‘ **Outcome**:
> πŸ‘ **Outcome**
>
> Data model PoC that is based on your use cases and business model.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ order: 15
> * Estimate how many customers will be included in promotions and how often their data should be synced with Voucherify.
> * Think of what it takes to migrate promotions from your current system.
> πŸ‘ **Outcome**:
> πŸ‘ **Outcome**
>
> API usage forecast, including monthly and hourly API calls number and a Voucheify deployment plan.
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/integration_blueprint/Distributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ order: 11
> * Learn how Voucherify publication works.
> * Discover Voucherify integrations for messaging.
> πŸ‘ **Outcome**:
> πŸ‘ **Outcome**
>
> Connect Voucherify with your preferred communication channels.
---

Evaluate your customer journey and **think of places and times the information about the deal should be displayed**: website, product pages, emails, SMS, push, print, partners, or social media. Think of how you want to remind customers about the deals they’re eligible to use. Voucherify offers **two distribution modes**:
Evaluate your customer journey and **think of places and times the information about the deal should be displayed**: website, product pages, emails, SMS, push, print, partners, or social media. Think of how you want to remind customers about the deals they’re eligible to use. Voucherify offers **two distribution modes**

* **Pull** – you can use API to get promotions in front of customers (e.g., list all active coupons for John Doe).
* **Push** – an integral distribution mechanism that you can use to define a trigger for the message send-out (e.g., if John Doe signs up for a newsletter, send him a 10% off promo code).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ order: 13
>
> * Understand how Voucherify supports multiple brands and locations through projects.
> πŸ‘ **Outcome**:
> πŸ‘ **Outcome**
>
> Ability to set up separate projects for different locations, currencies, brands, or development phases.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/integration_blueprint/Security.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ order: 16
> * Identify PII data to be shared with Voucherify.
> * Analyze your distribution processes in relation to GDPR and Data Privacy laws.
> πŸ‘ **Outcome**:
> πŸ‘ **Outcome**
>
> Data security assessment of integration.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/integration_blueprint/Team-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ order: 13
> * Think of roles and permissions necessary to manage campaigns.
> * Learn more about user management and approval workflows.
> πŸ‘ **Outcome**:
> πŸ‘ **Outcome**
>
> Invite team members with specific roles and set up approval workflows to keep your campaigns safe.
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/integration_blueprint/campaign-limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ hidden: false
order: 10
---

> πŸ“˜ **Goals**:
> πŸ“˜ **Goals**
>
> - Identify how the lack of limits impacted the ROI of previous campaigns.
> - Learn the built-in validation rules of Voucherify.
> - Discover how to extend your campaigns with custom limits built on top of business-specific restrictions.
> πŸ‘ **Outcome**:
> πŸ‘ **Outcome**
>
> Ability to build advanced promotion limits to personalize your campaigns and prevent fraud.
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/integration_blueprint/scenario-discovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ hidden: false
order: 4
---

> πŸ“˜ **Goals**:
> πŸ“˜ **Goals**
>
> - Identify a campaign for your pilot project.
> - Learn key capabilities for each campaign type.
> - Uncover roadblocks and 3rd-party integrations.
> πŸ‘ **Outcome**:
> πŸ‘ **Outcome**
>
> Creation of an initial POC for Voucherify integration.
Expand Down

0 comments on commit d877632

Please sign in to comment.