Gameball Developers Guide
v3.0
v4.0v3.0
v3.0
v4.0v3.0
  • Introduction
  • What's New in V3.0
  • Installing Gameball
    • Web
      • Show Gameball Customer Widget
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Go-Live Checklist
    • iOS
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
      • Go-Live Checklist
    • Android
      • Getting Started
      • Initialize Gameball SDK
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Referrals
      • Push Notifications
      • Go-Live Checklist
    • React Native
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
      • Go-Live Checklist
      • Migration from v1 to v2
    • Flutter
      • Getting Started
      • Initialize Gameball SDK
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Referrals
      • Go-Live Checklist
    • Generic Mobile App
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
    • Retail & Modern POS
      • Initialize Gameball Customer Profile
      • Track Orders & Cashback Reward
      • Track Refunds
      • Enable Redemption
        • Prepare POS for Redemption
        • Using Virtual ID
          • Using Virtual Card
  • REST API
    • Overview
      • Server-Side SDKs
    • Authentication
    • API Reference
      • Customer
      • Event
      • Transactions
      • Order
      • Coupons
      • Leaderboard 👑
      • Notifications 👑
      • Configurations 👑
      • Batches 👑
        • Batch Operations Data
      • OTP
      • Partner 🤝
        • Client 🤝
        • Redemption Rule 🤝
        • Cashback Rule 🤝
    • Webhooks
      • Notifications Webhook
      • Customer Profile Webhook
    • Errors
    • Object Reference
  • Tutorials
    • Build Custom UI Elements 👑
      • Display Reward Campaign Progress
      • Show VIP Tiers
      • Show Customer Points Balance
      • Build Leaderboards
      • Show Notifications Inbox
      • Adapt UI to Configurations
      • Advanced UI Techniques
        • Increase Sales with Cashback UI Elements
        • Derive Engagement with Rewards Campaigns UI Elements
    • Tracking Customer Events
    • Build your Own Notification System
    • Checkout Integration Example
    • Redemption Integration Options
      • Redeem with coupon system
        • Integrate your coupon system
          • Example using e-commerce platform(WooCommerce)
          • Example using a custom coupon system
        • Build couponing experience
          • Using Gameball widget
          • Build custom experience
            • Showing customers available points
            • Allowing customers to create coupons
            • Apply the discount code to your cart
        • Coupon integration reference
      • Redeem with direct debt
        • Get customers points balance
        • Redeem customer points
  • Third Party Integrations
    • Segment Integration
Powered by GitBook
On this page
  • Breaking Changes
  • Holding points
  • Removed Hashing
  • New Features
  • New batch interfaces 👑
  • New Endpoints
  • Order API Endpoint
  • Mark Notifications API Endpoint
  • Updated Endpoints
  • Removed Referral API
  • Custom UI APIs for GURU Clients
  • New Mobile SDKs Versions
  • New API documentation structure

What's New in V3.0

Breaking Changes

Holding points

Holding points before redeem is now optional.

Transactions API will be flexible to accept redeeming points with or without a hold reference. This will allow integrators to pick the best integration sequence that fits their system flow.

Removed Hashing

Hashing is no longer required for sensitive APIs like transactions & customer's information. Gameball now uses two keys for authentication:

  • Web Key (Public Key) : used for non sensitive APIs and initialization of Widget

  • Secret\transactions Key: used to authenticate sensitive API calls.

New Features

New batch interfaces 👑

New batch interface is created to allow GURU clients to execute batches via API. The batch interfaces will support batches for:

  • Reward

  • Redeem

  • Manual Transaction

  • Balance Retrieval

New Endpoints

Order API Endpoint

New Orders API is created to support e-commerce clients to track their orders. This API supports sending an event for placing the order, reward for paid amount and redeem point. It also accepts guest orders for analytical purposes

Mark Notifications API Endpoint

New notifications API endpoint is introduced that enables systems to mark notifications as read.

Updated Endpoints

Removed Referral API

Referrer code can be sent within the create customer API without the need of the old API dedicated for the referral case.

Custom UI APIs for GURU Clients

New APIs are now available and updated to better suit different businesses, also specially designed for our GURU clients to support them in building their custom UIs. There APIs are as follows:

  • Get Programs Configurations

  • Get customer progress

  • Get customer notifications

  • Get leaderboard

New Mobile SDKs Versions

We have released new versions of our mobile SDKs to leverage the power of the new V3 APIs. These upgraded SDK versions incorporate the latest best practices, resulting in accelerated performance and seamless functionality for your mobile apps.

The following list provides more details about the new SDKs

Platform
Package Name
Min. version supporting V3

iOS

Gameball

2.2.0

Android

gb-mobile-android

1.5.1

React Native

react-native-gameball

2.0.26

Flutter

gameball_sdk

1.0.3

New API documentation structure

Better API documentation including changes in structure and organization. It also includes new tutorials and walkthrough sections as follows:

  • Build Custom UI 👑

  • Track Customer Events

  • Build your Own Notification System

PreviousIntroductionNextWeb

Last updated 5 months ago