Manage Membership via API Access
- Former user (Deleted)
- Zachary Freiberg
- Former user (Deleted)
- Jonathan Warner (Unlicensed)
When you want to keep your membership list up to via within EzyStream automatically, you can do so via our API. Access to our API needs to be setup by your account manager.
It's important to understand the different between your users, and your membership list. User accounts will be created in your platform (and represents actual users), while members are also stored by us and are used to approve access to member only features (members are potential users).
Alternate Methods
EzyStream also offers the option to manage your membership list in our dashboard, or my importing a CSV file of your current members.
Create a Token
Before you can access our API, you need to have a valid token. Learn how to generate one here.
Valid Actions
Our API allows you to:
- Create a member,
- Delete a member,
- Set the expiry date of a member (this is the expiry of the membership in your system, not the annual anniversary of Perk+),
- Put a member on hold,
- Request access to Perk+ for a member,
- Request renewal of Perk+ for a member.
Add Member
Create a membership number in our API
A membership number is the unique identifier for each member.
REQUEST URL
https://vodapi.ezystream.com/v4/membership-no/ext
method: post
parameters:
fn: (optional)
first name of customer
ln: (optional, when acc set to true or 1, required)
last name of customer
em:(optional)
email customer's email
acc: (optional) value can be 0, 1
Request for Perk+ Access
epd: (optional) use Unix timestamp (UTC time)
expiry date of membership number
ohd: (optional) value can be 0, 1
whether membership is on hold
mn: (required)
encrypted membership number
tk: (required)
security token being provided
EXAMPLE RESPONSE - SUCCESS
{
"success": 200,
"message": "Member created"
}
EXAMPLE RESPONSE - ERROR
{
"success": 500,
"message": "Unable to create member"
}
Delete Member
Permanently Delete an existing member. Note, you may like to consider putting a member on hold, rather than deleting it entirely.
NOTE: Deleting a member will permanently remove their access to Perk+ and will require them to repurchase access (Or use a second licence).
REQUEST URL
https://vodapi.ezystream.com/v4/membership-no/ext
method: delete
parameters:
mn: (required)
encrypted membership number
tk: (required)
security token being provided
EXAMPLE RESPONSE - SUCCESS
{
"success": 200,
"message": "Member deleted"
}
EXAMPLE RESPONSE - ERROR
{
"success": 500,
"message": "Unable to delete member"
}
Set Expiry Date
Set the expiry date of your membership. We will prevent access for the member after this date, even if the member's Perk+ access is still valid.
REQUEST URL
https://vodapi.ezystream.com/v4/membership-no/ext
method: put
parameters:
epd: (optional) use Unix timestamp (UTC time)
expire date of membership number
mn: (required)
encrypted membership number
tk: (required)
security token being provided
EXAMPLE RESPONSE - SUCCESS
{
"success": 200,
"message": "Member updated"
}
EXAMPLE RESPONSE - ERROR
{
"success": 500,
"message": "Unable to update"
}
Put a member On Hold
Temporarily lock a member out by putting a hold on their membership.
REQUEST URL
https://vodapi.ezystream.com/v4/membership-no/ext
method: put
parameters:
ohd: (required) value could be 0, 1
whether membership is on hold
mn: (required)
encrypted membership number
tk: (required)
security token being provided
EXAMPLE RESPONSE - SUCCESS
{
"success": 200,
"message": "Member updated"
}
EXAMPLE RESPONSE - ERROR
{
"success": 500,
"message": "Unable to update"
}
Request or Renew Perk+ Access
Request access to Perk+ for a member. When using this feature, management of how the user pays your organisation for access to Perk+ (if relevant) is managed by you.
Access is valid for 12 months and can be renewed by you at that time - after you process an annual payment if required.
REQUEST URL
https://vodapi.ezystream.com/v4/membership-no/ext
method: put
parameters:
fn: (optional)
first name of customer
ln: (required)
last name of customer
em: email (optional)
customer's email
acc: (required) value fixed to 1
whether user requires Perk+ access
mn: (required)
encrypted membership number
tk: (required)
security token being provided
EXAMPLE RESPONSE - SUCCESS
{
"success": 200,
"message": "Member updated"
}
EXAMPLE RESPONSE - ERROR
{
"success": 500,
"message": "Unable to update"
}
Related articles
Struggling to find an answer to your question? Send us an email: help@ezystream.com