Share with On-Demand Website
BlendVision One offers a on-demand website showroom for each of your AODs by default, which you can directly share with your audience for listening the audios.
You have capabilities to customize it as per your preferences, including:
- The website and player template design
- The website's availability (Public, Access Code Protection, Token Integration)
- Membership integration
Here is a sample of a public BlendVision One showroom website, feel free to explore it.
Obtain and Distribute the Showroom Website as Your Needs
- Public
- Access Code Protection
- Token Integration
The showroom will be public and accessible to all users who visit the website when the AOD's privacy
is set to SECURITY_PRIVACY_TYPE_PUBLIC
.
Use the following template to create the website URL for the AOD and distribute it to your audience:
https://showroom.one.blendvision.com/showroom?token=resource_token&lang=en&t=0&shareUrl=example.com
Attributes | Required | Description |
---|---|---|
resource_token | Required | Refer to the steps to obtain the token. |
lang | Optional | Locale (zh , ja , en ). |
t | Optional | The default timestampe (seconds) to start playback when player initiated. |
shareUrl | Optional | The URL to share on social media. If no value provided, the default URL will be set to https://showroom.one.blendvision.com?token=resource_token |
Obtain Resource Token
Make a POST request to the API: POST /bv/cms/v1/resources/tokens
Query Parameters | Required | Description |
---|---|---|
resource_id | Required | The unique ID of your content. |
resource_type | Required | The streaming type of your content. |
customer_id | Optional | Your custom user ID to identify who is watching the content. |
customer_name | Optional | Your custom user name to identify who is watching the content. |
Here is an example of a request body:
{
"resource_id": "<resource-id>",
"resource_type": "RESOURCE_TYPE_LIVE",
"customer_id": "<customer-id>",
"customer_name": "<customer-name>"
}
The showroom will only be accessible with an authorized token when the AOD's privacy
is set to SECURITY_PRIVACY_TYPE_TOKEN
.
BlendVision One offers the Access Code
feature, allowing you to generate multiple unique token-authorized access codes, which serve as unique passwords when users visit the showroom website.
The Access Code
is token-based, so the device limit will comply with the privacy
settings of your AOD.
To utilize the showroom website with access codes, you will distribute the same website URL along with different unique Access Code to your audience:
Showroom Website URL
https://showroom.one.blendvision.com/?lang=en
Attributes | Required | Description |
---|---|---|
lang | Optional | Locale (zh , ja , en ). |
Access Codes
To generate access codes, make a POST request to the API: POST /bv/cms/v1/redeem-codes
The required parameters are:
id
: The ID of the Livestream, VOD, or AOD for which you want to generate redeem codes.type
:RESOURCE_TYPE_AOD
.amount
: The number of access codes you want to generate. The maximum is 1000.
Here's an example of generating 5 access codes for a AOD with ID of 12345
:
{
"id":"12345",
"type":"RESOURCE_TYPE_AUDIO_EVENT",
"amount":5
}
After making the request, you will receive a response containing an array of access codes. Here is an example response:
{
"redeem_codes": [
{
"code":"ABC123"
},
{
"code":"DEF456"
},
{
"code":"GHI789"
},
{
"code":"JKL012"
},
{
"code":"MNO345"
}
]
}
The showroom will only be accessible with an authorized token when the AOD's privacy
is set to SECURITY_PRIVACY_TYPE_TOKEN
.
You can manage user authorization in your system by issuing tokens only to users who are authorized according to your business requirements.
To generate the AOD showroom website URLs for your authorized users, use the following template:
https://showroom.one.blendvision.com/showroom?token=resource_token&lang=en&t=0&shareUrl=example.com
Attributes | Required | Description |
---|---|---|
resource_token | Required | Refer to the steps to obtain the token. |
lang | Optional | Locale (zh , ja , en ). |
t | Optional | The default timestampe (seconds) to start playback when player initiated. |
shareUrl | Optional | The URL to share on social media. If no value provided, the default URL will be set to https://showroom.one.blendvision.com?token=resource_token |
Obtain Resource Token
Make a POST request to the API: POST /bv/cms/v1/resources/tokens
Query Parameters | Required | Description |
---|---|---|
resource_id | Required | The unique ID of your content. |
resource_type | Required | The streaming type of your content. |
customer_id | Optional | Your custom user ID to identify who is watching the content. This parameter is required if the content's security privacy is set to SECURITY_PRIVACY_TYPE_TOKEN . |
customer_name | Optional | Your custom user name to identify who is watching the content. |
Here is an example of a request body:
{
"resource_id": "<resource-id>",
"resource_type": "RESOURCE_TYPE_LIVE",
"customer_id": "<customer-id>",
"customer_name": "<customer-name>"
}