The RewardStream APIs are a set of RESTful web services that enable you to access, create, or modify data held in the RewardStream system. RewardStream has a number of APIs that allow you to integrate with our system to help you have a fully automated customer referral program. At a high level, these APIs include but are not limited to:

  • Sync Member Data API - this is used to perform Single Sign On (SSO) between your customer system and RewardStream's system, creating a seemless integration and transition for your customers between your website and your referral program without having your custoemrs create or use separate log in credentials.
  • Get Offer API - this is used to allow an external system to retrieve the details about the referral offer via the referral code provided by the person who was referred (e.g. discount dollar amount or percentage) and check if the referral code is valid.
  • Redeem Offer API - this isI fee used to allow an external system to notify RewardStream via the referral code provided by the person who was referred that an account has been opened and/or a purchase has been made and will update the code in RewardStream so that it cannot be used again.
  • Record Purchase API - this is used to allow an external system to notify RewardStream that a subsequent purchase has been made by an existing account in RewardStream. Subsequent qualified purchases made within the Offer Period will be recorded and additional rewards can be given.
  • Get Reward API - this is used to allow an external system to retrieve the details about a referral reward via the reward code provided by the person who made a successful referral (e.g. discount dollar amount or percentage) and check if the reward code is valid.
  • Redeem Reward API - this is used to allow an external system to notify RewardStream via the reward code provided by the person who made a successful referral that the code was use to make a purchase and will update the code in RewardStream so that it cannot be used again.

Other RewardStream APIs that are not documented here can create, retrieve, or update member/referrer information, referee information, accounts, purchases, referrals, and rewards. Let us know if you'd like to learn more.

RewardStream can also integrate with your APIs to verify your customer accounts and issue rewards (e.g. apply plan codes, account credits, points, etc.)

Please contact us if you're interested in learning more about integrating with our APIs.

Did this answer your question?