CSC Perk+ API Access

Owned by Former user (Deleted)
Last updated: Aug 14, 2019 by Jonathan Warner (Unlicensed)
2 min read

The EzyStream platform can provide access to additional Subscription Coupons, called Perk+. The EzyStream API will provide you with a unique URL for each of your users. Your application’s UI should hide this URL from your user by being opened in your application as a web view, retaining your own header and footer/navigation active in the app. 

1. Request Access to Subscription Coupons (authenticated by channel token) 

- Request must include your token (tk), the user’s surname (sn). (encrypted), email (em) address and membership number (mn) (encrypted). 
- If validated, a unique URL is returned.
- If not validated, we return a 403 or 404 error, with a message.


Embed URL Usage

The usage of the Perk+ embed is subject to pre-approved criteria from the Frequent Values (by Entertainment) programme. Learn how to embed the URL into your app correctly.


REQUEST URL 

Perk+ Version 1: https://vodapi.ezystream.com/v3/coupon/ext/eb-url?mn=UzZVNPUWl&tk=3af2e35a-3797&sn=Jkluda&em=a@gmail.com

Perk+ Version 2: https://vodapi.ezystream.com/v4/coupon/ext/eb-url?mn=UzZVNPUWl&tk=3af2e35a-3797&sn=Jkluda&em=a@gmail.com


EXAMPLE RESPONSE - SUCCESS

{

"url": 'https://www.demourl.co.nz/' 

} 


EXAMPLE RESPONSE - NO ACCESS PERMITTED 

{

"error": 403, 
"message": “Access Denied" 

} 


EXAMPLE RESPONSE - ERROR 

{

"error": 404, 
"message": “Invalid Membership number" 

}


ADDITIONAL, OPTIONAL ACTIONS PERFORMED BY EZYSTREAM
(Please let us know if you think these are applicable to you)

2. If request was not successful because the user hasn’t paid for access yet.

  1. Our platform generates an email on your behalf to your user. This email is branded using the colours and logos loaded into your EzyStream Dashboard. This email asks the user if they would like to add access to the your Subscription Coupons, for a cost written in the email. 
  2. Once user clicks ‘Accept’ in email, another email is send to the administrators of your account, letting you know you can externally bill your member. 

3. Retrying Access

  1. Once the user has clicked ‘Accept’ in their email, their access will activate. 
  2. When the user retries to use the feature in your application, triggering a second request to us, we will be able to authenticate access and return a valid URL.

NOTE: We do not store the user’s name or email address, it is forgotten once authentication is complete, or email is sent.



Struggling to find an answer to your question? Send us an email: help@ezystream.com