Home - kangaroorewards/api-docs GitHub Wiki

Before you begin

  • Create a Developer Account. If you don't have one, you can get one by going to Kangaroo Rewards for Developers and signing up for free. Create an OAuth application and sign the API agreement. Once that is done, contact Kangaroo Support to approve the application(s).
  • Create a Business Account. Please contact Kangaroo Support to create one and also request the X-Application-Key for that account.
  • Employee. We recommend creating an employee specifically for API access, or use the main business admin's credentials to access the API. Please refer to Add a new employee

Once you have a business account, X-Application-Key, and an employee with an email and password set up, you can start creating customers through the API, and they will automatically appear in the business portal.

Obtain an Access Token for that employee (Authentication) that will be used to make authenticated API requests. The token will expire and should be regularly refreshed.

The employee you authenticate with (specifically the Access Token) and the X-Application-Key define the business under which the customers will be created.

Here are some links you will need to follow the tutorials:

OAuth2 App

Register an App with Kangaroo Rewards

Authentication

Implement Authentication

Business Rules

Modifying Business Rules

Customers

Customer Consent

Delete a Customer

Customer CRM Fields

Retrieve Customer CRM Fields

Update Customer CRM Fields

Transactions

QR Code Transaction

Redeem Points Transaction

Redeem Redemption Catalog

Redeem Offers

Redeem Points (Ecom)

Redeem Redemption Catalogs (Ecom)

Redeem Offers (Ecom)

Reward with Product Rewards

Product Rewards (A La Carte)

List Product Rewards

Referrals

Create Referral Program

Create and Reward Customers via Referrals

Workflows

Getting-started

How to create a Workflow

Integrations

Connect Integrations

Social Media

Create Social Media Call to Action

Update Social Media Call to Action

Delete Social Media Call to Action