Introduction

Odiccithat provides a series of games and experiences that encourage a retailer's customers to click through, play, and win.

Eagle Eye has created an integration to their platform to quickly enable a customer to be up and running with their games with little required configuration to either platform. This guide outlines the details of this integration and the setup required to support this.

Integration Details

The interactions with a consumer fall into three main stages:

• Game Entry
• Game Play
• Game Reward

Each of the stages is documented below with descriptions of the interactions between Odicci and AIR.

Game Entry Campaigns

A game entry is driven by an account placed in a customer’s wallet. This account could be created as a bounceback from a transaction (e.g. spend £30 and get an entry to a game), issued to a customer via an allocation mechanic (targeted groups, for example, a Birthday reward) or a Social and Behavioural Action (complete your profile and get an entry to the game). This guide doesn’t touch on these mechanics as they are captured elsewhere but does focus on the details of this account to drive the game.

Details:

The account needs to have an Account Client Type of GAME_ENTRY. This data point is used in the integration to search for accounts in the customer's wallet that are for a game entry.

The campaign type used should be Manual, as this account should not be adjudicated in a Cloud Based Adjudication and does not require any details of qualification or reward (other than a scheme if the loyalty programme is points-based).

If the loyalty program is based on points, the relevant scheme must be selected in the Game Entry campaign.

Example screenshots from setting up this campaign are detailed below:

📘

Redemption Partner

The "Redemption Partner" selection in this field is required to set up the campaign but is not used in any way in the game process. It's just necessary to create the campaign.

Every instance of an account in a customer’s wallet with a Client Account Type of GAME_ENTRY is considered to be a game entry.

Searching a customer's wallet for a game entry account can be achieved with the below API. This can be used to surface the game entry information into a digital estate or as a trigger to the gameplay.

GET /wallet/{{walletId}}/accounts?status=ACTIVE&clientType=GAME_ENTRY

Game Play

Gameplay is triggered by an action from the client app or website. This triggers an interaction with Odicci and passes in the customer’s walletId and the game entry accountId.

Odicci calls back to AIR to validate that the game entry is valid using the below API call. If the account exists and is active, Odicci continues the gameplay. If not, the play is stopped and a valid response is returned to the customer.

GET /wallet/{{walletId}}/account/{{accountId}}

Details of how this interaction is triggered with Odicci needs to be discussed with the Odicci team to advise on how this is established.

Once the game play in Odicci has been completed, the details of that reward are passed back to AIR to update the customer's wallet.

Game Reward

After a customer has played the game, regardless of whether a reward is given or not, the game entry Account in the customer’s Wallet gets marked as USED and a Wallet Transaction gets created in AIR to capture the game play interaction.

If the game config in Odicci allows the customer to attempt the gameplay multiple times, the call back to AIR is delayed until the customer wins a reward or all the play attempts are completed.

There are three different outcomes from the game. This is detailed below.

Points as a Reward

If the game is set up to award points to a customer, this is completed by Odicci calling the Backend Points Redeem API:

📘

Notes on the created data:

• Points Amount: This will be captured in the wallet transaction summary generated and the associated points credit transaction will be linked to the created wallet transaction
• walletTransactionType: This will always be set to the value GAME_REWARD
• reference: This value prevents the same game reward from being given more than once. This value will have the value of "GAMEREWARD_{{accountId}}"where the accountId is the account entry accountId
• meta.playattempts: This holds the number of attempts at winning a game a customer has taken. This value defaults to 1 unless a specific configuration is set up in Odicci to allow multiple attempts at winning a reward.

The above data points will be stored against the wallet transaction created in AIR providing the required data points for the client to surface the right information back to the client about their game play.

No Reward

A no-reward scenario generates the same data in AIR as a Points-Based Reward as the above but there is no Points-Based detail created. This will remove the GAME_ENTRY account (by marking it as USED in AIR) so the same entry cannot be played a second time.

Coupons as a Reward

If the reward from a game is an Account, the campaignId of the reward coupons needs to be entered into Odicci to enable the game set-up to be completed. The reward account issued can be against any campaign that is available within AIR:

• Another game entry coupon
• Money off the next transaction
• Points reward for the next transaction
• etc.

When the game is played and a coupon is to be awarded, this gets created in the custome'rs wallet and linked to the wallet transaction created. The game entry Account in the Wallet is also marked as USED.

📘

Additional Notes on created data:

• meta.rewardaccountid: This value will hold the ID of the account created in the customer's wallet

Integration Process Flow

To highlight the integration details between AIR and Odicci the below process flow outlines the integration and all the interactions between the platforms:

📘

Odicci Platform Set-up

For details on how to set up the game experience and integration to AIR in the Odicci platform, please see the Odicci documentation here: https://help.odicci.com/article/142-eagle-eye-integration