Checks whether a given authenticated user has access for an given item
The id of created premium content in InPlayer Dashboard (i.e asset id).
Contains the data:
{
id: number;
account_id: number;
customer_id: number;
customer_uuid: string;
ip_address: string;
country_code: string;
created_at: number;
expires_at: number;
item: {
content: string;
};
}
Gets sessions for the current browser
The id of code created for given premium content.
Contains the data:
[{
agent_info: string;
browser_fingerprint: string;
code: string;
code_id: string;
last_used: number;
}]
Retrieves the access code and browser fingerprint for the current asset from localStorage Returns null if no access code is present
The id of created premium content in InPlayer Dashboard (i.e asset id).
Contains the data:
{
item_id: number;
content: string;
in_use: boolean;
browser_fingerprint: string;
code: string;
type: string;
code_id: number;
}
Gets the item details for a given merchant item
The id of created premium content in InPlayer Dashboard (i.e asset id).
The Merchant's unique universal identifier (Merchant UUID). You can find it on the InPlayer's dashboard at the Account Details section as Account ID.
Contains the data:
{
id: number;
merchant_id: number;
merchant_uuid: string;
is_active: boolean;
title: string;
access_control_type: {
id: number;
name: string;
auth: boolean;
};
item_type: {
id: number;
name: string;
content_type: string;
host: string;
description: string;
};
age_restriction: {};
metadata: [{}];
created_at: number;
updated_at: number;
}
Get the access fees for a given item
The id of created premium content in InPlayer Dashboard (i.e asset id).
Contains the data:
{
id: number;
merchant_id: number;
amount: number;
currency: string;
description: string;
expires_at: number;
starts_at: number;
updated_at: number;
created_at: number;
access_type: {
id: number;
account_id: number;
name: string;
quantity: number;
period: string;
updated_at: number;
created_at: number;
};
item: {
id: number;
merchant_id: number;
merchant_uuid: string;
active: boolean;
title: string;
access_control_type: {
id: number;
name: string;
auth: boolean;
};
created_at: number;
updated_at: number;;
item_type: {
id: number;
name: string;
content_type: string;
host: string;
description: string;
};
age_restriction: {};
metadata: [{}];
metahash?: {};
content?: string;
template_id: number;
created_at: number;
update_at: number;
};
trial_period: {
quantity: number;
period: string;
description: string;
};
setup_fee: {
id: number;
fee_amount: number;
description: string;
};
seasonal_fee: {
id: number;
access_fee_id: number;
merchant_id: number;
current_price_amount: number;
off_season_access: boolean;
anchor_date: number;
created_at: number;
updated_at: number;
};
external_fees: [{
id: number;
payment_provider_id: number;
access_fee_id: number;
external_id: string;
merchant_id: number;
}];
geo_restriction: {
id: number;
country_iso: string;
country_set_id: number;
type: string;
};
current_phase: {
access_fee_id: number;
anchor_date: number;
created_at: number;
currency: string;
current_price: number;
expires_at: number;
id: number;
season_price: number;
starts_at: number;
status: string;
updated_at: number;
};
}
Returns purchase history for different payment type
The number of items per page. If it is not set the number of items per page will be 15.
The current page number. If it is not set the starting page will be returned.
The staring date filter.
The ending date filter.
The payment type filter. (i.e 'gift-payment', 'donation').
Contains the data:
{
collection: [{
access_fee_description: string;
action_type: string;
charged_amount: number;
client_id: string;
consumer_email: string;
consumer_id: number;
continent: string;
country: string;
country_iso: string;
created_at: string;
currency_iso: string;
device: {
type: string;
os: string;
model: string;
}
donation_description: string;
exchange_rate: number;
expires_at: string;
gateway_name: string;
gift: {
buyer_email: string;
code: string;
id: number;
receiver_email: string;
}
ip_address: string;
issued_by: number;
item_access_id: number;
item_id: number;
item_title: string;
item_type: string;
merchant_id: number;
note: string;
payment_history_id: number;
payment_method_name: string;
payment_tool_info: string;
payment_tool_token: string;
referrer: string;
settlement_currency: string;
timestamp: number;
transaction_token: string;
trx_token: string;
voucher_code: string;
voucher_discount: string;
}],
total: number;
unique_paying_customers: number;
}
Returns a signed Cloudfront URL with the merchant's signature
The id of created premium content in InPlayer Dashboard (i.e asset id).
The video url
Contains the data:
{
video_url: string;
}
Gets the donation options for the asset
The id of created premium content in InPlayer Dashboard (i.e asset id).
Contains the data:
{
donations: [{
id: number;
item_id: number;
amount: number;
currency: string;
description: string;
}];
donation_options: {
id: number;
item_id: number;
custom_price_enabled: boolean;
};
}
Gets an external asset details
The type of the asset. Can be any of these values.
The original video ID from the external OVP source (only for OVP asset type).
The Merchant's unique universal identifier (Merchant UUID). You can find it on the InPlayer's dashboard at the Account Details section as Account ID.
Contains the data:
{
access_fees: [
{
id: number;
merchant_id: number;
amount: number;
currency: string;
description: string;
expires_at: number;
starts_at: number;
updated_at: number;
created_at: number;
access_type: {
id: number;
account_id: number;
name: string;
quantity: number;
period: string;
updated_at: number;
created_at: number;
};
item: {
id: number;
merchant_id: number;
merchant_uuid: string;
active: boolean;
title: string;
access_control_type: {
id: number;
name: string;
auth: boolean;
};
item_type: {
id: number;
name: string;
content_type: string;
host: string;
description: string;
};
age_restriction: {
min_age: number;
};
metadata?: [{}];
metahash?: {};
content?: string;
template_id: number;
created_at: number;
update_at: number;
};
trial_period: {
quantity: number;
period: string;
description: string;
};
setup_fee: {
id: number;
fee_amount: number;
description: string;
};
seasonal_fee: {
id: number;
access_fee_id: number;
merchant_id: number;
current_price_amount: number;
off_season_access: boolean;
anchor_date: number;
created_at: number;
updated_at: number;
};
external_fees: [{
id: number;
payment_provider_id: number;
access_fee_id: number;
external_id: string;
merchant_id: number;
}];
geo_restriction: {
id: number;
country_iso: string;
country_set_id: number;
type: string;
};
current_phase: {
access_fee_id: number;
anchor_date: number;
created_at: number;
currency: string;
current_price: number;
expires_at: number;
id: number;
season_price: number;
starts_at: number;
status: string;
updated_at: number;
};
}
];
metahash: {};
}
Get package info for a given Package ID
The id of created package in InPlayer Dashboard.
Contains the data:
{
total: number;
page: number;
offset: number;
limit: number;
collection: [{
id: number;
merchant_id: number;
is_active: boolean;
title: string;
content: string;
item_type: {
id: number;
name: string;
content_type: string;
host: string;
description: string;
};
metadata: {};
items: number;
}];
}
Checks whether Free trial has been used for a given item
The id of created premium content in InPlayer Dashboard (i.e asset id).
Gets access with code for code access grant asset
Contains the data:
{
item_id: number;
content: string;
in_use: boolean;
browser_fingerprint: string;
code: string;
type: string;
code_id: number;
}
Gets access without authentication for asset with access control type data capture
Contains the data:
{
code: 200,
message: 'Access successfully granted'
}
Terminates session for the current browser
The id of created premium content in InPlayer Dashboard (i.e asset id).
Contains the data:
{
code: 200,
message: 'Successfully deleted session'
}
Generated using TypeDoc
Contains all Requests connected with items