This tutorial describes how to work with Antavo’s APIs, Prize Wheel module, and Rewards module to add a scratch card reward as a gamification element in your loyalty program.
1. Build the scratch card
You can request all the information to build and display the scratch card reward on the loyalty membership site through Antavo’s Entity API, please find the specific endpoint to call in our API documentation here.
2. Create prizes through the Rewards module
The prizes that customers can win by scratching a card should be configured as rewards using the Reward module. A reward can be created in the UI by clicking on ‘Create a new reward’, under ‘Rewards’.
You can choose any of the reward types according to your needs, you can find the steps of the configuration of each reward type in our user manual.
Regardless of the number of points set in the ‘Points’ configuration field, no points will be deducted from the customers’ point balances if they win the reward as a prize of the scratch card.
Click ‘Save’ when all the desired fields are filled in and then ‘Set active’ to activate the reward and make it available for the Prize Wheel module.
Alternatively, new rewards can be created through the Entity API as well, find further information here.
3. Set up game mechanics through the Prize Wheels module
The game mechanics of the Prize wheels module provides a suitable solution if you’d like to offer a scratch card reward to your loyal members. The chances of winning a prize can be built upon the same percentage values as it works within prize wheels. The only difference is the frontend display of the draw, this time the chances are not represented by slices of a prize wheel, but a scratch card displays the result of the game on the card after the surface is rubbed off.
A reward can be created in the UI by clicking the ‘Create a new prize wheel’ option, under ‘Prize Wheels’ module.
You can find help to configure a prize wheel in our user manual here.
As you use the module to offer a scratch card reward to your customers, the ‘Disable reward claim’ option of the prize wheel should not be enabled, so that the reward prize can automatically be registered on the customer’s account when a customer redeems points to try their luck and wins.
Please make sure all the reward prizes are active while your scratch card is available for customers as inactive rewards cannot be assigned to customers by this module.
Alternatively, new prize wheels can be created through the Entity API as well, find further information here.
4. Connect mechanics and frontend elements using API calls
To query the scratch card rewards that a specific customer is eligible to redeem based on the prize wheel configuration, you need to send a GET request to the Display API endpoint that returns the list of the prize wheels available. Based on this information you can display the options on the membership site according to your own design principles.
You can trigger Antavo to enter the customer into a prize draw by sending a POST request to the dedicated endpoint of the Display API. You can decide what customer action on the membership site should trigger the request to be sent, you can implement it upon point redemption for a chance to scratch the reward card or when the customer starts rubbing the card off.
When the request is sent, Antavo evaluates the request based on the mechanics configured in the Prize wheel module and registers the ‘Wheel spin’ event and the ‘Reward’ event (if the customer wins a prize) accordingly.
In the response to this POST request, Antavo returns the result with the information about the details of the drawn prize option, so that you can notify your customers right away.
5. Test your scratch card reward
After you have configured the rewards and the prize wheels on the Backoffice and built the front-end elements in your staging environment, we suggest testing the whole customer experience and backend processes carefully.
In case the scratch card reward is configured properly, you should find a ‘Wheel spin’ event in the Events history of the customer account that you use for testing. The attributes of the event reflect the result of the evaluation of the configured mechanics.
If the ‘Result’ field of the event stores the ID of a reward, it means that the customer has won a prize reward, therefore a ‘Reward’ event should be registered right after that assigns the reward to the customer account.