Concepts
A few terms come up everywhere in Keliplay. This page explains each one and how they fit together.
Channel
Section titled “Channel”A channel is a spot on your website or in your app where games appear, such as a homepage banner or a page in your loyalty app. You embed a channel once. After that, everything you change happens in the dashboard.
A channel shows one campaign at a time: whichever is live right now. When none is live, players see the channel’s between-campaigns message, a heading, a short text and an optional image that you set on the channel’s Settings tab.
Campaign
Section titled “Campaign”A campaign is one game with your settings: its rules, artwork, wording, prize and how winners are chosen. Every campaign belongs to one channel.
A campaign moves through these states:
| State | What it means |
|---|---|
| Draft | Being set up. Players cannot see it. |
| Active | Live on its channel, during its live window if it has one. |
| Paused | Temporarily hidden. Plays and results are kept. Set through the API; in the dashboard, end the live window instead. |
| Archived | Finished and put away. You can restore it. |
Live windows and handover
Section titled “Live windows and handover”A campaign can have a start and an end time. Several campaigns can share a channel as long as their live windows do not overlap, which lets you queue up next month’s campaign while this month’s is still running. The channel’s Campaigns tab shows them as Live, Queued and Finished.
When you activate a campaign on a channel that already has one live, you can choose when the new one takes over. Players who started the old campaign before the handover finish it normally.
Players and plays
Section titled “Players and plays”A player is one of your users. You identify them with your own id, called
participantRef, when you ask for a client token. Keliplay never needs their
name or email, and uses the id only to group their plays and prizes.
A play is one go at a game. Each play starts with a new client token. When the play ends it becomes an entry, which is what draws pick winners from.
Play limits
Section titled “Play limits”You can limit how often each player plays: a total per player, a number per day, or both. Set limits on the campaign, or on the channel to cover every campaign in it. Choose the time zone that decides when a “day” starts. When a player has used their plays, the token request answers with an error, and the pre-game page can show a “come back tomorrow” message.
Winners and rewards
Section titled “Winners and rewards”There are two ways to give players something, and you can use both on one campaign:
- Winner selection picks winners after the fact: by highest score, at random, or among players who predicted correctly. You can run a draw by hand, after every play, or on a schedule. See Prizes and winners.
- Rewards hand a coupon code to a player at the end of a play when they qualify, for example everyone who scores over 500. See Rewards and coupons.
Every draw is recorded and can be verified later.
Organisation, members and roles
Section titled “Organisation, members and roles”Your account is an organisation. People join it as members, and each member has a role that decides what they can do, from viewing results to managing API keys. API keys carry permissions in the same way. See Authentication and Settings.
Your plan decides which games and features your organisation can use, and limits
such as how many campaigns can be live at once. If you ask for something your plan
does not include, the API answers with status 402 and a message saying what is
missing. Your account manager can change your plan. See Plans.