Gameball Developers Guide
v3.0
v3.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
  • Authentication
  • API Reference
  • Webhooks
  • Errors
  • Object Reference
  1. REST API

Overview

This section gives a detailed guide on all Gameball APIs that are needed during integration.

PreviousUsing Virtual CardNextServer-Side SDKs

Last updated 1 year ago

The Gameball API is organized around . Our API has predictable resource-oriented URLs, returns responses, and uses standard HTTP response codes, authentication, and verbs. In this section, you will find all the available APIs required across all Gameball features as well as all the API methods that can be used in the SDKs.

Our Server Side SDKs for v3.0 are currently in progress and to be released soon.

Authentication

Before using any of our API endpoints, you need to get familiar with how Gameball authenticates any incoming requests. Which is described in details in the section.

API Reference

Gameball provides a set of endpoints which enables you to interact with and utilize Gameball Engine efficiently. All supported endpoints are described as follows:

  • 👑

  • 👑

  • 👑

  • 👑

Base URL

The API base URL is the following, with v3.0 as our current version.

https://api.gameball.co/api/{version}

Webhooks

Errors

Object Reference

Check the following section to learn more about the .

Webhooks are a powerful resource that you can use to automate your use cases and improve your productivity. Check the section to find out more.

Learn more about common errors and their description in our section.

Learn more about our objects in the .

REST
JSON-encoded
Authentication
Customer
Event
Transactions
Order
Leaderboard
Notifications
Configurations
Batches
API Reference
Webhooks
Errors
Object Reference