Skip to main content

Get Started

issy Marketing Cloud provides a collection of API endpoints that allows developers to integrate Loyalty Program functionalities into their applications. The functionalities available are:

  • List of Loyalty Programs.
  • Participate on a Loyalty Program enabling users to acumulate credits based on a purchase receipt.
  • List the rewards related to a Loyalty Programs.
  • Transfer credits between users.
  • Redeem credits for rewards.

API appKey and appToken

Request to the issy service provider how to obtain an appKey and appToken. API appKey and appToken should be kept secured and should not be uploaded into a code repository. If a Secret is believed to be compromised, it can be disabled in the portal and a new Secret can be issued.

Urls

Dev enviroment
https://api-dev.issy.app

Prod enviroment
https://api.issy.app

Authentication

issy Marketing Cloud offers authentication by an API appKey and appToken. Use the appKey and appToken credential pair to authenticate API requests by sending their values in these HTTP headers:

Headers

{
"issy-key": "{tenant id}"
"issy-token": "{account app token}",
}

All request must contain an appKey and appToken in header

User identifier

User identifier must be a guid generated by the web site that is consuming the API.

    userid={guid}

Error Codes

issy API responses use standard HTTP codes.

  • 2xx: Indicate sucess
  • 4xx: Authentication error
  • 5xx: Server error