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).
- 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
- Find the External API Access feature under ‘Subscriptions’
- Click ‘Configure’
- Click ‘Generate’. This then display’s your ‘token’ and ‘secret’.
IMPORTANT
- Once you close the configuration window, you cannot return to these details, so make sure you have saved them securely before closing the window.
- You can only have one token active at any one time. By generating a new coupon you will de-active your old one. Doing this could be disable access to our API in old versions of your application, so care should be taken.
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
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).
REQUEST URL
https://vodapi.ezystream.com/v3/coupon/ext/list?mn=UzZVNPUWVWSWl&tk=3af2e35a-3797
EXAMPLE RESPONSE - SUCCESS
[
{
"couponOrgName": "Armstrong",
"phoneNumber": "0800 506 111",
"website": "https://www.armstrong.co.nz",
"listImage": "https://admin.ezystream.com/static/images/coupons/list/Armstrong- Button-200.jpg",
"logoImage": "https://admin.ezystream.com/static/images/coupons/logo/Armstrong- Header-600.jpg",=
"showBarcode": 0,
"categoryName": 3,show name
"contactEmail": "null",
"order": 1,
"couponCode": "CSC555",
"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