...
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).
- Manage Subscription Coupons Access Codes if separately supplied to you.
- View statistics about coupon usage.
- View the status and billing information on your EzyStream account .
AUTHENTICATING ON OUR SERVER
To access our API, you’ll need to generate a unique token which can be done your EzyStream Dashboard. This should be kept secure, and should be installed within your application securely. It allows us to identify you, and protect against unauthorised traffic.
GENERATING YOUR TOKEN AND SECRET
...
Info | ||
---|---|---|
| ||
|
USING ENCRYPTION (AES)
Before making a request to our API, you must encrypt details like your membership. This can be done by:
- Open SSL encryption (openssl_encrypt).
- Specify the AES Cipher. AES-256-CBC
- Use the token generated in your Dashboard as the key (Remove dashes). key
- Use the secret as a initialization vector. iv
- (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 encoded to base64).
REQUEST URL
https://vodapi.ezystream.com/v3v4/coupon/ext/list?mn=UzZVNPUWVWSWl&tk=3af2e35a-3797
EXAMPLE RESPONSE - SUCCESS
[
{
"couponOrgName": "ArmstrongCompany Name",
"phoneNumber": "0800 506 111 111",
"website": "https://www.armstrongcompanyname.co.nz",
"listImage": "https://admin.ezystream.com/static/images/coupons/list/Armstrong- Buttonimage-200.jpg",
"logoImage": "https://admin.ezystream.com/static/images/coupons/logo/Armstrongimage- Header-600.jpg",=
"showBarcode": 01,
"categoryName": 3,show name
"contactEmail": "nullemail@company.co.nz",
"order": 1,
"couponCode": "CSC555123",
"name": "description of the coupon"
...
A) Coupon List Images | B) Coupon Detail Image |
Related articles
Filter by label (Content by label) | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...