Introduction

This section contains no articles.

Authentication

• Authentication

  The BLOY Public API lets you integrate your app or service with BLOY Loyalty: programmatically access customer data, loyalty points, rewards, ways to earn, VIP tiers, and referrals. Base URL: https://api.bloy.io Data format: JSON Authentication: Bearer token (API Key) Get your API Key From the Navigation Tab, click on Settings. Scroll down to the Public API section. Locate your API kSome readers

Customers

• Customers

  Get customer list Retrieve a paginated list of customers from your loyalty program GET /rest-api/v1/customers Query parameters Example requestFew readers

Rewards

• Rewards

  Get customer rewards Retrieve a list of rewards earned by a customer GET /rest-api/v1/rewards Query parameters Example requestFew readers

Activities

• Activities

  Get customer activities Retrieve activities for a customer, such as redeemed rewards or earned points GET /rest-api/v1/activities Query parameters Example requestFew readers

Points

• Points

  Add points Add loyalty points to a customer's balance. POST /rest-api/v1/points/add Body Example requestFew readers

Points Redemptions

• Points Redemptions

  List all points redemptions Retrieve all "ways to redeem" (redemption configurations) for the shop, including a redeemable flag indicating whether the given customer has enough points to redeem each one. GET /rest-api/v1/pointsRedemptions Query parametersFew readers

• Earning Rules

  List Ways to Earn Retrieve the list of "ways to earn" (earning rule configurations) for the shop. GET /rest-api/v1/earningRules Query parameters Example request ExampFew readers

• Referral

  Get a customer's referral code Retrieve (or automatically generate, if not yet created) the customer's referral code. GET /rest-api/v1/referral Query parameters Example request ExampFew readers

• VIP

  Get the VIP program Retrieve the shop's active VIP program, including its tiers, perks, entry rewards, and per-tier earning rules. GET /rest-api/v1/vip Example request Example responseFew readers