Loyalty Program Punch API
If you have your own system and would like to punch for a mobile number at a loyalty program without our dashboard, we have just created an API allowing you to do just that. This API is for server-to-server communication, in case you have your own CRM system or something similar to manage your customer base.
Url: https://mcpn.us/limeApi?ev=loyaltyPunch
You must supply all of the following parameters
Parameters (case sensitive, bold are mandatory):
|
Parameter Name (Case Sensitive)
|
Value |
Description |
Default Value |
|
user |
Advertiser username |
The advertiser’s username that matches the api_id and own the loyalty program |
None |
|
api_id |
Advertiser Api Id |
The Advertiser's api_id that matches the username |
Generated from edit profile |
|
loyaltyProgramId |
Number |
Loyalty Program Id |
|
|
mobile |
String |
The mobile number that we want to check it's progress |
|
|
numOfPunches |
Number |
Indicates the number of desired punches |
Return Code
If the API succeeds then it will return with status code 200 with a success message in the html body like: "1 point has been added to mobile number: 15555555555. Current status: 3/20"
If an error occurs or there is an invalid parameter then it returns with status code 400 or 500 with an error message in the response.
Example:
https://mcpn.us/limeApi?ev=loyaltyPunch&user=advertiseruser&api_id=a5SNH43WyAA83SWLK&loyaltyProgramId=123&mobile=15555555555&numOfPunches=1
Comments
0 comments
Article is closed for comments.