VideosApi

All URIs are relative to https://api.kinow.com/api

Method	HTTP request	Description
attachCoverToVideo	POST /videos/{video_id}/cover
attachFeaturesToVideo	POST /videos/{video_id}/features
attachVideoToProduct	POST /products/{product_id}/videos
createVideo	POST /videos
createVideoSubtitle	POST /videos/{video_id}/subtitle
deleteVideo	DELETE /videos/{video_id}
getCustomerHasAccessToVideo	GET /customers/{customer_id}/videos/{video_id}/has-access
getCustomerHasAccessToVideos	POST /customers/{customer_id}/videos/has-access
getDisabledSubscriptions	GET /videos/{video_id}/disabled-subscriptions
getVideo	GET /videos/{video_id}
getVideoAccess	GET /videos/{video_id}/customers/{customer_id}/access
getVideoBonus	GET /videos/{video_id}/bonus
getVideoCover	GET /videos/{video_id}/cover
getVideoDownloadUrl	GET /videos/{video_id}/download-url
getVideoFeatures	GET /videos/{video_id}/features
getVideoGeolocation	GET /videos/{video_id}/geolocation
getVideoGeolocationByIp	POST /videos/{video_id}/geolocations/{ip_address}
getVideoPlayer	GET /videos/{video_id}/player
getVideoSubtitles	GET /videos/{video_id}/subtitles
getVideoViews	GET /videos/{video_id}/views
getVideos	GET /videos
getVideosFromProduct	GET /products/{product_id}/videos
setVideoGeolocation	PUT /videos/{video_id}/geolocations
updateVideo	PUT /videos/{video_id}

attachCoverToVideo

attachCoverToVideo($video_id, $id_image)

Attach cover to video (the image need to be attached to the product)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to fetch
$id_image = 789; // int | Image ID to attach

try {
    $api_instance->attachCoverToVideo($video_id, $id_image);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->attachCoverToVideo: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to fetch
id_image	int	Image ID to attach

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

attachFeaturesToVideo

attachFeaturesToVideo($video_id, $features)

Attach feature to video

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | 
$features = "features_example"; // string | To attach existing FeatureValue to Product:     ```     [{     \"id_feature\":3,     \"id_feature_value\":5     }]     ```      To create a custom FeatureValue:     ```     [{     \"id_feature\":3,     \"custom_value\":[{     \"lang\": 1,     \"value\": \"string\"     }]     }]     ```

try {
    $api_instance->attachFeaturesToVideo($video_id, $features);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->attachFeaturesToVideo: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int
features	string	To attach existing FeatureValue to Product: ``` [{ "id_feature":3, "id_feature_value":5 }] ``` To create a custom FeatureValue: ``` [{ "id_feature":3, "custom_value":[{ "lang": 1, "value": "string" }] }] ```

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

attachVideoToProduct

attachVideoToProduct($product_id, $video_id)

Attach video to product

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$product_id = 789; // int | Product ID to fetch
$video_id = 789; // int | Video ID to attach

try {
    $api_instance->attachVideoToProduct($product_id, $video_id);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->attachVideoToProduct: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
product_id	int	Product ID to fetch
video_id	int	Video ID to attach

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

createVideo

\Kinow\Client\Model\VideoResponse createVideo($body)

Create new video

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$body = new \Kinow\Client\Model\CreateVideoRequest(); // \Kinow\Client\Model\CreateVideoRequest | Video parameters

try {
    $result = $api_instance->createVideo($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->createVideo: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Kinow\Client\Model\CreateVideoRequest	Video parameters

Return type

\Kinow\Client\Model\VideoResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

createVideoSubtitle

\Kinow\Client\Model\SubtitleResponse createVideoSubtitle($video_id, $body)

Create new Video Subtitle

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to attach the created Subtitle
$body = new \Kinow\Client\Model\CreateVideoSubtitleRequest(); // \Kinow\Client\Model\CreateVideoSubtitleRequest | Subtitle settings

try {
    $result = $api_instance->createVideoSubtitle($video_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->createVideoSubtitle: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to attach the created Subtitle
body	\Kinow\Client\Model\CreateVideoSubtitleRequest	Subtitle settings

Return type

\Kinow\Client\Model\SubtitleResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

deleteVideo

deleteVideo($video_id)

Delete video

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to fetch

try {
    $api_instance->deleteVideo($video_id);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->deleteVideo: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to fetch

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getCustomerHasAccessToVideo

getCustomerHasAccessToVideo($customer_id, $video_id)

Get customer access to video

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$customer_id = 789; // int | Customer ID to fetch
$video_id = 789; // int | Video ID to fetch

try {
    $api_instance->getCustomerHasAccessToVideo($customer_id, $video_id);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getCustomerHasAccessToVideo: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
customer_id	int	Customer ID to fetch
video_id	int	Video ID to fetch

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getCustomerHasAccessToVideos

\Kinow\Client\Model\VideoAccessInfo[] getCustomerHasAccessToVideos($customer_id, $body)

Get customer access to Videos

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$customer_id = 789; // int | Customer ID to fetch
$body = new \Kinow\Client\Model\VideoIDList(); // \Kinow\Client\Model\VideoIDList | List of Video IDs separated by comma, eg. '42,21,84'

try {
    $result = $api_instance->getCustomerHasAccessToVideos($customer_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getCustomerHasAccessToVideos: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
customer_id	int	Customer ID to fetch
body	\Kinow\Client\Model\VideoIDList	List of Video IDs separated by comma, eg. '42,21,84'

Return type

\Kinow\Client\Model\VideoAccessInfo[]

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getDisabledSubscriptions

\Kinow\Client\Model\SubscriptionListResponse getDisabledSubscriptions($video_id, $page, $per_page)

Get disabled subscriptions list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getDisabledSubscriptions($video_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getDisabledSubscriptions: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to fetch
page	int		[optional]
per_page	int		[optional]

Return type

\Kinow\Client\Model\SubscriptionListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getVideo

\Kinow\Client\Model\VideoResponse getVideo($video_id)

Get video

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to fetch

try {
    $result = $api_instance->getVideo($video_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getVideo: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to fetch

Return type

\Kinow\Client\Model\VideoResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getVideoAccess

getVideoAccess($video_id, $customer_id)

Get video access

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to fetch
$customer_id = 789; // int | Customer ID to fetch

try {
    $api_instance->getVideoAccess($video_id, $customer_id);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getVideoAccess: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to fetch
customer_id	int	Customer ID to fetch

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getVideoBonus

\Kinow\Client\Model\Bonus[] getVideoBonus($video_id)

Get bonus list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to fetch

try {
    $result = $api_instance->getVideoBonus($video_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getVideoBonus: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to fetch

Return type

\Kinow\Client\Model\Bonus[]

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getVideoCover

\Kinow\Client\Model\ImageResponse getVideoCover($video_id)

Get video cover

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to fetch

try {
    $result = $api_instance->getVideoCover($video_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getVideoCover: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to fetch

Return type

\Kinow\Client\Model\ImageResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getVideoDownloadUrl

\Kinow\Client\Model\DownloadInformations getVideoDownloadUrl($video_id, $customer_id, $ip_address)

Get video download informations

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to fetch
$customer_id = 789; // int | Customer ID to fetch
$ip_address = "ip_address_example"; // string | IP address

try {
    $result = $api_instance->getVideoDownloadUrl($video_id, $customer_id, $ip_address);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getVideoDownloadUrl: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to fetch
customer_id	int	Customer ID to fetch	[optional]
ip_address	string	IP address	[optional]

Return type

\Kinow\Client\Model\DownloadInformations

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getVideoFeatures

\Kinow\Client\Model\Features getVideoFeatures($video_id, $page, $per_page)

Get video features

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getVideoFeatures($video_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getVideoFeatures: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to fetch
page	int		[optional]
per_page	int		[optional]

Return type

\Kinow\Client\Model\Features

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getVideoGeolocation

\Kinow\Client\Model\GeolocationListResponse getVideoGeolocation($video_id, $page, $per_page)

Get geoloc list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getVideoGeolocation($video_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getVideoGeolocation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to fetch
page	int		[optional]
per_page	int		[optional]

Return type

\Kinow\Client\Model\GeolocationListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getVideoGeolocationByIp

getVideoGeolocationByIp($video_id, $ip_address, $page, $per_page)

Check access to a video by geolocation

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to fetch
$ip_address = "ip_address_example"; // string | IP address
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $api_instance->getVideoGeolocationByIp($video_id, $ip_address, $page, $per_page);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getVideoGeolocationByIp: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to fetch
ip_address	string	IP address
page	int		[optional]
per_page	int		[optional]

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getVideoPlayer

\Kinow\Client\Model\PlayerConfiguration getVideoPlayer($video_id, $customer_id, $country_id, $ip_address, $iso_code, $force_reload)

Get video player

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to fetch
$customer_id = 789; // int | Customer ID to fetch
$country_id = 789; // int | Country ID to use in video analytics
$ip_address = "ip_address_example"; // string | IP address
$iso_code = "iso_code_example"; // string | Define the player UI language. If not providen, fallback on platform default language.
$force_reload = true; // bool | Force seekbar to the begining and ignore viewing resume

try {
    $result = $api_instance->getVideoPlayer($video_id, $customer_id, $country_id, $ip_address, $iso_code, $force_reload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getVideoPlayer: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to fetch
customer_id	int	Customer ID to fetch	[optional]
country_id	int	Country ID to use in video analytics	[optional]
ip_address	string	IP address	[optional]
iso_code	string	Define the player UI language. If not providen, fallback on platform default language.	[optional]
force_reload	bool	Force seekbar to the begining and ignore viewing resume	[optional]

Return type

\Kinow\Client\Model\PlayerConfiguration

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getVideoSubtitles

\Kinow\Client\Model\ExtractSubtitlesResponse getVideoSubtitles($video_id, $page, $per_page)

Get subtitles of a video

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 

try {
    $result = $api_instance->getVideoSubtitles($video_id, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getVideoSubtitles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to fetch
page	int		[optional]
per_page	int		[optional]

Return type

\Kinow\Client\Model\ExtractSubtitlesResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getVideoViews

\Kinow\Client\Model\VideoViews getVideoViews($video_id)

Get video views

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to fetch

try {
    $result = $api_instance->getVideoViews($video_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getVideoViews: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to fetch

Return type

\Kinow\Client\Model\VideoViews

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getVideos

\Kinow\Client\Model\VideoListResponse getVideos($page, $per_page, $features, $filters, $ip)

Get videos list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$page = 789; // int | 
$per_page = 789; // int | 
$features = "features_example"; // string | ``` features[*][value]=string&features[*][operator]=strict&features[1][value]=string&features[1][operator]=strict _______________  { \"*\": { \"value\": \"string\", \"operator\": \"strict\" }, \"1\": { \"value\": \"string\", \"operator\": \"contains\" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than). To search on all features, you can pass * as featureId.
$filters = "filters_example"; // string | ``` name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt _______________  { \"name\": { \"value\": \"string\", \"operator\": \"contains\" }, \"date_add\": { \"value\": \"string\", \"operator\": \"lt\" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than).
$ip = "ip_example"; // string | Filter by user IP

try {
    $result = $api_instance->getVideos($page, $per_page, $features, $filters, $ip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getVideos: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
page	int		[optional]
per_page	int		[optional]
features	string	``` features[][value]=string&features[][operator]=strict&features[1][value]=string&features[1][operator]=strict _______________ { "": { "value": "string", "operator": "strict" }, "1": { "value": "string", "operator": "contains" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than). To search on all features, you can pass as featureId.	[optional]
filters	string	``` name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt _______________ { "name": { "value": "string", "operator": "contains" }, "date_add": { "value": "string", "operator": "lt" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than).	[optional]
ip	string	Filter by user IP	[optional]

Return type

\Kinow\Client\Model\VideoListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

getVideosFromProduct

\Kinow\Client\Model\ProductVideoListResponse getVideosFromProduct($product_id, $page, $per_page, $sort_by, $sort_direction, $ip, $filters)

Get videos attached to product

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$product_id = 789; // int | Product ID to fetch
$page = 789; // int | 
$per_page = 789; // int | 
$sort_by = "sort_by_example"; // string | Sort by this attribute (id by default)
$sort_direction = "sort_direction_example"; // string | Sorting direction (asc by default)
$ip = "ip_example"; // string | Filter by user IP
$filters = "filters_example"; // string | ``` name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt _______________  { \"name\": { \"value\": \"string\", \"operator\": \"contains\" }, \"date_add\": { \"value\": \"string\", \"operator\": \"lt\" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than).

try {
    $result = $api_instance->getVideosFromProduct($product_id, $page, $per_page, $sort_by, $sort_direction, $ip, $filters);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getVideosFromProduct: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
product_id	int	Product ID to fetch
page	int		[optional]
per_page	int		[optional]
sort_by	string	Sort by this attribute (id by default)	[optional]
sort_direction	string	Sorting direction (asc by default)	[optional]
ip	string	Filter by user IP	[optional]
filters	string	``` name[value]=string&name[operator]=contains&date_add[value]=string&date_add[operator]=lt _______________ { "name": { "value": "string", "operator": "contains" }, "date_add": { "value": "string", "operator": "lt" } } ``` Operator can be: strict, contains, between, in, gt (greater than), lt (lower than).	[optional]

Return type

\Kinow\Client\Model\ProductVideoListResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

setVideoGeolocation

setVideoGeolocation($video_id, $enabled, $behavior_detected_countries, $behavior_non_detected_countries, $countries)

Handle geolocation for videos by countries

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to fetch
$enabled = 56; // int | Enabled
$behavior_detected_countries = "behavior_detected_countries_example"; // string | Behavior for detected countries
$behavior_non_detected_countries = "behavior_non_detected_countries_example"; // string | Behavior for non-detected countries
$countries = "countries_example"; // string | IDs of the non-detected countries separated by comma

try {
    $api_instance->setVideoGeolocation($video_id, $enabled, $behavior_detected_countries, $behavior_non_detected_countries, $countries);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->setVideoGeolocation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to fetch
enabled	int	Enabled
behavior_detected_countries	string	Behavior for detected countries
behavior_non_detected_countries	string	Behavior for non-detected countries
countries	string	IDs of the non-detected countries separated by comma	[optional]

Return type

void (empty response body)

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

updateVideo

\Kinow\Client\Model\VideoResponse updateVideo($video_id, $body)

Update video

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiClientId
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Id', 'Bearer');
// Configure API key authorization: ApiClientSecret
Kinow\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Client-Secret', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Kinow\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Client-Secret', 'Bearer');

$api_instance = new Kinow\Client\Api\VideosApi();
$video_id = 789; // int | Video ID to update
$body = new \Kinow\Client\Model\UpdateVideoRequest(); // \Kinow\Client\Model\UpdateVideoRequest | 

try {
    $result = $api_instance->updateVideo($video_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->updateVideo: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
video_id	int	Video ID to update
body	\Kinow\Client\Model\UpdateVideoRequest

Return type

\Kinow\Client\Model\VideoResponse

Authorization

ApiClientId, ApiClientSecret

HTTP request headers

Content-Type: Not defined
Accept: Not defined

Files

VideosApi.md

Latest commit

History

VideosApi.md

File metadata and controls

VideosApi

attachCoverToVideo

Example

Parameters

Return type

Authorization

HTTP request headers

attachFeaturesToVideo

Example

Parameters

Return type

Authorization

HTTP request headers

attachVideoToProduct

Example

Parameters

Return type

Authorization

HTTP request headers

createVideo

Example

Parameters

Return type

Authorization

HTTP request headers

createVideoSubtitle

Example

Parameters

Return type

Authorization

HTTP request headers

deleteVideo

Example

Parameters

Return type

Authorization

HTTP request headers

getCustomerHasAccessToVideo

Example

Parameters

Return type

Authorization

HTTP request headers

getCustomerHasAccessToVideos

Example

Parameters

Return type

Authorization

HTTP request headers

getDisabledSubscriptions

Example

Parameters

Return type

Authorization

HTTP request headers

getVideo

Example

Parameters

Return type

Authorization

HTTP request headers

getVideoAccess

Example

Parameters

Return type

Authorization

HTTP request headers

getVideoBonus

Example

Parameters

Return type

Authorization

HTTP request headers

getVideoCover