bluepine-web-sdk v1.0.1

bluepine-web-sdk

How Bluepine Works

To inspire and enhance user's in-app behaviour, Bluepine enables you to build gamified challenges. Any event may be made more engaging by using game elements like cash, your own branded virtual coins and voucher codes for your own brand or any other 3rd party voucher code incentives.

With its Plug & Play SDK, Bluepine incorporates these game elements into your programme. From its Web Dashboard, Bluepine enables you to administer these gamified challenges. These challenges are known as Campaigns.

Users can be rewarded for accomplishing specific tasks in each campaign, such as opening a new account, completing KYC, making purchases that exceed a specified threshold, or checking in every day. Bluepine offers a reward to a user as a Scratch Card once they successfully finish a job. Cash, virtual coins, or voucher codes are all possible prize types for this scratch card.

Events are the core of the rewards programme. The Events that the user receives as a result of their activities are tracked by Bluepine's Rewards System, which also decides if they are eligible for rewards. When a user completes the intended task or transaction, your backend notifies Bluepine of the event by making an API request. The Rewards System searches for Campaigns linked to this Event, verifies eligibility, and then gives the user their prize.

Developer’s Guide

If you are a developer, you can get started by setting up the SDK in your application.

Web Plugin

Version:- 1.0.1

How to add Web Plugin in HTML Web Application

Step 1: Include Bluepine’s SDK in your Web Application

 <script type="text/javascript" src="https://unpkg.com/bluepine-web-sdk/dist/BluepineSDK.min.js" defer></script>

Step 2: Start Bluepine in your Web Application for Non-logged in users

<script type="text/javascript">
  (function () {
    var data = {
      partner_id: "<Take this from bluepine dashboard>"
    };
    window.onload = function(){
    bluepine.initSDK(data);
  }
  })();
</script>

Step 3: Initialise the SDK for a Logged-in/Signed Up User

<script type="text/javascript">
  (function () {
    var data = {
      partner_id: "<Take this from dashboard>",
      user_id: "<unique user id>"
    };

    window.onload = function(){
        bluepine.initSDK(data);
    }
  })();
</script>

How to add Web Plugin in React Web Application

Step 1: Include Bluepine’s SDK in your Web Application

• Install package

npm i bluepine-sdk

• Import package

import bluepine from 'bluepine-web-sdk';

Step 2: Start Bluepine in your Web Application for Non-logged in users

    var data = {
      partner_id: "<Take this from bluepine dashboard>"
    };

    bluepine.initSDK(data);

Step 3: Initialise the SDK for a Logged-in/Signed Up User

    var data = {
      partner_id: "<Take this from dashboard>",
      user_id: "<unique user id>"
    };

    bluepine.initSDK(data);

Send User Events

Send User Events using Server-to-Server setup using User Events API. https://bluepine.readme.io/

Function to show Bluepine Club Button

bluepine.showBluepineButton();

Function to Hide Bluepine Button

bluepine.hideBluepineButton();

Change a position of button

By default the position of the button is to the left but if you want to change the position to the right then set the position of the button to the right before calling bluepineSDK.initSDK();

bluepine.btnPosition="right";