1. Developers

API Playground - An introduction to this free resource for developers

Learn and test the capabilities of BeeLiked's API with our public sandbox

Introduction to Playground

We've created our Playground so you can understand the power of the BeeLiked Platform without the requirement to have a BeeLiked Account of your own or spend time setting up promotions to fit your use cases.

To help you get started exploring what is possible, we've created an Account on the platform called 'Playground' where we've set up a number of promotions to demonstrate the BeeLiked platform capabilities.

We've created a quick start for you to run this in Postman. Click here to import the project into your Postman application and explore what is possible. (see linked articles below for further information on scenarios)

BeeLiked's API documentation can be found at: https://developer.beeliked.com 

Our Playground Account API credentials

Should you wish to experiment outside of Postman, you will need the following API credentials to be able to connect.

API Client:

7652bc49-cdd8-4118-b6b0-8fdfeda6918d

API Secret

KdQBvonvJiLmBKSNSfiY1gV6AfuykX
 

Please Note Whilst we have created demo promotions with test data, during the course of your testing, you may generate test entries of your own. This data would be accessible to everyone with access to these credentials. We will regularly delete all third party data.

 

User Cases for you to test the API

Public Promotions - for lead generation or audience insights

Your promotions can have an entry form configured to ask for any contact information or other demographic information you would like to collect. We've set up promotions that collect basic data but also include questionnaires.

  • Users' contact data and permission marketing preferences (when entered into an entry form). Learn how
  • Retrieving results from entries to your promotion, for example, if and what someone won, as well as any coupon codes they may have won. Learn how

Private Promotions - for incentivizing existing audiences

Reward your customers, staff, or partners with invitations to play a game according to actions they take within your own applications. For example, when they spend a certain amount, make a purchase, hit a target, etc. You must request and present users with their unique Invite Link to be able to enter. Each InviteLink is valid for one entry only. (Please Note that our v1 API refers to Entry Links, but we've since updated the name within the platform to Invite Links Learn more about InviteLinks.)

  • InviteLinks can be requested on demand via the API. Each link contains a unique 10-character alphanumeric code known as the 'Invite Code'. The links you generate can be used once to enter a promotion and can be anonymous (given to anyone) or personalized (given to a specific individual) Learn how
  • Personalizing InviteLinks - Creating variable text or imagery for different users when using InviteLinks, for example, using placeholders to bring in their company name, their profile image, a company logo, or even whole paragraphs of text. Learn how
  • Regulate the number of times a user is invited to enter a promotion (using unique identifiers such as email) by looking up the number and date/time of previous entries. Learn how

If your intention is only to invite someone to enter a promotion once or a limited number of times, it can be helpful to look up if their UID is present already as an entrant and then make a decision of whether you issue a new InviteLink or not.