Contents
- Video Save
- Video Get
- Videos Get Status
- Playlist Save
- Add To Playlist
- Playlist Get
- Playlists Get All
- Playlists Delete
- MRSS Feed Save
- MRSS Feed Get
Video Save
Request |
Method |
POST |
Target |
https://console.connatix.com/api/videos/savevideo
|
Headers |
content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
JSON object with properties
id |
number |
required |
Video identifier. 0 (default) |
title |
string |
required |
Video title |
description |
string |
required |
Video description |
imageURL |
string |
required |
Thumbnail image URL |
videoURL |
string |
required |
Video URL |
categories |
[number] |
optional |
Array of category identifiers - reference |
language |
number |
optional |
Language identifier, default 0 (English) - reference |
expiryDate |
date string |
optional |
Expiry date in format "yyyy-MM-dd" |
clickURL |
string |
optional |
URL to be opened when video player is clicked |
|
Response |
Status |
HTTP Status Code |
Headers |
set-cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
JSON object with properties
id |
number |
Video identifier. 0 (default) |
title |
string |
Video title |
description |
string |
Video description |
imageURL |
string |
Thumbnail image URL |
videoURL |
string |
Video URL |
categories |
[number] |
Array of category identifiers - reference |
language |
number |
Language identifier - reference |
expiryDate |
date string |
Microsoft JSON in format "/Date(ticks)/"
Example: "/Date(1503705600000)/"
|
clickURL |
string |
URL to be opened when video player is clicked |
status |
number |
Video status |
0 |
Active |
1 |
Inactive |
2 |
Deleted |
3 |
Rejected |
encoderJobID |
string |
Video encoder job identifier |
encoderJobProgress |
number |
Video encoder job status |
0 |
waiting |
1 |
pending |
2 |
assigning |
3 |
processing |
4 |
finished |
5 |
failed |
6 |
canceled |
|
Video Get
Request |
Method |
GET |
Target |
https://console.connatix.com/api/videos/getvideo/<id>
<id>: video identifier (required)
|
Headers |
content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Response |
Status |
HTTP Status Code |
Headers |
set-cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
JSON object with properties
id |
number |
Video identifier. 0 (default) |
title |
string |
Video title |
description |
string |
Video description |
imageURL |
string |
Thumbnail image URL |
videoURL |
string |
Video URL |
categories |
[number] |
Array of category identifiers - reference |
language |
number |
Language identifier - reference |
expiryDate |
date string |
Microsoft JSON in format "/Date(ticks)/"
Example: "/Date(1503705600000)/"
|
clickURL |
string |
URL to be opened when video player is clicked |
state |
number |
Video status |
0 |
Active |
1 |
Inactive |
2 |
Deleted |
3 |
Rejected |
encoderJobID |
string |
Video encoder job identifier |
encoderJobProgress |
number |
Video encoder job status |
0 |
waiting |
1 |
pending |
2 |
assigning |
3 |
processing |
4 |
finished |
5 |
failed |
6 |
canceled |
|
Videos Get Status
Request |
Method |
POST |
Target |
https://console.connatix.com/api/videos/getvideostatus
|
Headers |
content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
Array of objects
id |
number |
Video identifier |
jobID |
string |
Video encoder job identifier |
|
Response |
Status |
HTTP Status Code |
Headers |
set-cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
JSON object with properties
id |
number |
Video identifier |
status |
number |
Video status |
0 |
Active |
1 |
Inactive |
2 |
Deleted |
3 |
Rejected |
statusReason |
string |
Video status messages in case is rejected. Messages separated by column (;) |
jobID |
string |
Video encoder job identifier |
jobProgress |
number |
Video encoder job status |
0 |
waiting |
1 |
pending |
2 |
assigning |
3 |
processing |
4 |
finished |
5 |
failed |
6 |
canceled |
|
Playlist Save
Request |
Method |
POST |
Target |
https://console.connatix.com/api/videos/savelist
|
Headers |
content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
JSON object with properties
id |
number |
required |
Playlist identifier. 0 (default) |
name |
string |
required |
Video title |
videos |
[number] |
required |
Array of video identifiers |
videoOrder |
number |
optional |
Playlist play order |
|
|
0 |
Random |
|
|
1 |
Latest (default) |
|
|
2 |
By Order When set, recommended to set also property videosOrder |
videosOrder |
[number] |
optional |
Each element represents the order of the matching video (by position) from 'videos' property. When set, it is mandatory to have same length as 'videos' property.
Relevant when 'Playlist play order' set to 'By Order' (i.e. videoOrder = 2) |
|
Response |
Status |
HTTP Status Code |
Headers |
set-cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
JSON object with properties
id |
number |
Playlist identifier |
name |
string |
Playlist name |
videos |
[number] |
Array of video identifiers |
videoOrder |
number |
Playlist play order |
videosOrder |
[number] |
Each element represents the order of the matching video (by position) from 'videos' property. |
|
EXAMPLES
Playlist Save (no ordering options)
curl -X POST 'https://console.connatix.com/api/videos/savelist' -H 'content-type: application/json' -H 'Cookie: ConnatixAuth=<cookie_value>' --data-binary '{"id":0,"name":"test.playlist", "videos": [9854, 851, 78423]}'
HTTP/1.1 200 OK
{
"id":2578, "name":"test.playlist", "videos": [9854, 851, 78423], "videoOrder": 1, "videosOrder": []}
Playlist Save (ordered)
curl -X POST 'https://console.connatix.com/api/videos/savelist' -H 'content-type: application/json' -H 'Cookie: ConnatixAuth=<cookie_value>' --data-binary '{"id":0,"name":"test.ordered.playlist", "videos": [9854, 851, 78423]}, "videoOrder": 2, "videosOrder": [1,3,2]}'
HTTP/1.1 200 OK
{
"id":2579, "name":"test.ordered.playlist", "videos": [9854, 851, 78423], "videoOrder": 2, "videosOrder": [1,3,2]}
Add to Playlist
Request |
Method |
POST |
Target |
https://console.connatix.com/api/videos/addtolist
|
Headers |
content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
JSON object with properties
id |
number |
conditional |
Playlist identifier. Required in case name is supplied |
name |
string |
conditional |
Playlist name. Required in case id is supplied. |
videos |
[number] |
required |
Array of video identifiers |
videoOrder |
number |
optional |
Playlist play order |
|
|
0 |
Random |
|
|
1 |
Latest (default) |
|
|
2 |
By Order When set, recommended to set also property videosOrder |
videosOrder |
[number] |
optional |
Each element represents the order of the matching video (by position) from 'videos' property. When set, it is mandatory to have same length as 'videos' property.
Relevant when 'Playlist play order' set to 'By Order' (i.e. videoOrder = 2) |
|
Response |
Status |
HTTP Status Code |
Headers |
set-cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
JSON object with properties
id |
number |
Playlist identifier |
name |
string |
Playlist name |
videos |
[number] |
Array of video identifiers |
videoOrder |
number |
Playlist play order |
videosOrder |
[number] |
Each element represents the order of the matching video (by position) from 'videos' property. |
|
Playlist Get
Request |
Method |
GET |
Target |
https://console.connatix.com/api/videos/getlist/<id>
<id>: Playlist identifier (required)
|
Headers |
content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Response |
Status |
HTTP Status Code |
Headers |
set-cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
JSON object with properties
id |
number |
Playlist identifier |
name |
string |
Playlist name |
videos |
[number] |
Array of video identifiers |
videoOrder |
number |
Playlist play order |
videosOrder |
[number] |
Each element represents the order of the matching video (by position) from 'videos' property. |
|
Playlists Get All
Request |
Method |
GET |
Target |
https://console.connatix.com/api/videos/getlist/<id>
<id>: Playlist identifier (required)
|
Headers |
content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Response |
Status |
HTTP Status Code |
Headers |
set-cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
JSON object with properties
items |
[object] |
Array of playlist objects |
id |
number |
name |
string |
|
Playlists Delete
Request |
Method |
GET |
Target |
https://console.connatix.com/api/videos/deletelist/<id>
<id>: Playlist identifier (required)
|
Headers |
content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Response |
Status |
HTTP Status Code |
Headers |
set-cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
Empty |
Request |
Method |
POST |
Target |
https://console.connatix.com/api/videos/savemrssfeed
|
Headers |
content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
JSON object with properties
id |
number |
required |
Feed identifier. 0 (default) |
name |
string |
required |
Feed name |
state |
number |
required |
Feed status |
|
|
0 |
Active |
|
|
1 |
Inactive |
type |
number |
required |
Feed type |
|
|
0 |
Individual Videos |
|
|
1 |
Highlights |
url |
string |
required |
Feed URL |
refreshRate |
number |
optional |
Feed Refresh Rate in minutes |
batchMaxItems |
number |
optional |
Number of items to ingest per Refresh Cycle |
categories |
[number] |
optional |
Array of category identifiers - reference |
playlists |
[number] |
optional |
Array of playlist identifiers. When set, videos are automatically added in playlists. - see also Playlists Get All |
newPlaylists |
[string] |
optional |
Array of playlist names When set, playlists are automatically created and videos added in playlists. |
settings |
string (json) |
optional |
JSON stringified object with generate settings for Highlights video.
slides |
number |
Number of slides of the generated highlights video. Supported values are between 2 and 10. |
|
|
Response |
Status |
HTTP Status Code |
Headers |
set-cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
JSON object with properties
id |
number |
Feed identifier. |
|
Request |
Method |
GET |
Target |
https://console.connatix.com/api/videos/getMrssFeed/<id>
<id>: feed identifier (required)
|
Headers |
content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Response |
Status |
HTTP Status Code |
Headers |
set-cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
JSON object with properties
id |
number |
Feed identifier. 0 (default) |
name |
string |
Feed name |
state |
number |
Feed status |
|
0 |
Active |
|
1 |
Inactive |
type |
number |
Feed type |
|
0 |
Individual Videos |
|
1 |
Highlights |
url |
string |
Feed URL |
refreshRate |
number |
Feed Refresh Rate in minutes |
batchMaxItems |
number |
Number of videos to ingest per refresh cycle |
categories |
[number] |
Array of category identifiers - reference |
playlists |
[number] |
Array of playlist identifiers. When set, videos are automatically added in playlists. - see also Playlists Get All |
settings |
string (json) |
JSON stringified object with generate settings for Highlights video.
slides |
number |
Number of slides of the generated highlights video. Supported values are between 2 and 10. |
|
lastSync |
string |
Last refresh date and time formatted as "MM/dd/yy hh:mm" |
nextSync |
string |
Estimated next refresh date and time formatted as "MM/dd/yy hh:mm" |
videoItemsCount |
number |
Total number of videos ingested from feed ( all refresh cycles ) |
|
Comments
Please sign in to leave a comment.