YOUR EZYSTREAM DASHBOARD
Your dashboard will allow you to:
- Generate an API Access Token (you may only have one current token).
- Add your own coupons and update them.
- Manage valid membership numbers (via CSV file if you wish).
- View statistics about coupon usage.
- View the status and billing information on your EzyStream account (if EzyStream charges your organisation directly).
COUPON ACCESS OUTLINE
Requesting the Coupon List will return a list of available coupons with appropriate details.
PLEASE NOTE: The request must include your token and the user’s membership number (encrypted and then converted to base64).
REQUEST URL
https://vodapi.ezystream.com/v4/coupon/ext/list?mn=UzZVNPUWVWSWl&tk=3af2e35a-3797
EXAMPLE RESPONSE - SUCCESS
[
{
"couponOrgName": "Company Name",
"phoneNumber": "0800 111 111",
"website": "https://www.companyname.co.nz",
"listImage": "https://admin.ezystream.com/static/images/coupons/list/image-200.jpg",
"logoImage": "https://admin.ezystream.com/static/images/coupons/logo/image-600.jpg",=
"showBarcode": 1,
"categoryName": 3,show name
"contactEmail": "email@company.co.nz",
"order": 1,
"couponCode": "123",
"name": "description of the coupon"
},
.
.
.
]
EXAMPLE RESPONSE - ERROR
{
"error": 404,
"message": "Your token is invalid!"
}
Tip
The barcode flag indicates whether the Supplier expects the app to display a barcode. If true, the Coupon Code should be displayed as a barcode using your own barcode font/generator.
IMAGES
[list_image]
The list image you receive is designed for listing all/multiple suppliers/coupons on a single page.
- This image will always be 200px high, with a variable width - designed for creating a list.
- These images are intended to be used on a white background/inserted into a button, such as the example below.
[logo_image]
- This image will always be 600px wide, with a variable height - designed for placing on a page by itself.
- These images are intended to be used on a white background/inserted into a button, such as the example below.
|
|
|---|---|
| A) Coupon List Images | B) Coupon Detail Image |
Related articles