...
Alternatively, new rewards can be created through the Entity API as well, find further information here.
33. Set up game mechanics through the Prize Wheels 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.
...