This is the API Documentation for Vidello Integration. The API calls described below have been made to allow a third-party software to upload videos directly into Vidello.
To be able to use the API you need a secret key. If you don't have one please contact the Vidello support at support@vidello.com and request one.
All calls must be made using the POST method and you must include the user apikey (which is unique to each Vidello user account) and your secret key.
So the first thing to do is allowing your user to save his Vidello apikey somewhere in your software. Users can find their apikey in Vidello inside the Settings / Integrations page. That apikey should then be used in every API call allowing us to identify the user who's doing the request.
This call allows you to get the list of projects of the user which owns the passed APIKEY. This is important for the next step for video uploading where a project_id is required.
Parameters:
Parameters | Required | Type | Description |
secret | Yes | String | Your secret key |
apikey | Yes | String | The user apikey |
Example of successful call (status code = 200)
[
{
"id": "13",
"name": "My first project"
},
{
"id": "27",
"name": "Another project"
}
]
Error messages:
Status Code | Error Code | Description |
401 | SECRET_KEY_NOT_VALID | Secret key is not validing |
401 | AUTHENTICATION_FAILED | User not found or expired |
This call allows you to directly upload a video into Vidello. The video must be fully accessible for download on a url that must be passed to the call.
Parameters:
Parameters | Required | Type | Description |
secret | Yes | String | Your secret key |
apikey | Yes | String | The user apikey |
url | Yes | String | The video url |
project_id | Yes | String | The project ID in Vidello where to import the video |
name | No | String | The video name. If not provided the video filename is used |
Example of successful call (status code = 200). The id of the video is returned
{
"id": "21534"
}
Error messages:
Status Code | Error Code | Description |
401 | SECRET_KEY_NOT_VALID | Secret key is not validing |
401 | AUTHENTICATION_FAILED | User not found or expired |
404 | NOT_FOUND | Project id not specified or not valid |
403 | AUTHORIZATION_FAILED | The user can't access the specified project |
400 | URL_NOT_VALID | Video url not valid |
This call allows you to directly upload a video into Vidello. The video must be fully accessible for download on a url that must be passed to the call.
Parameters:
Parameters | Required | Type | Description |
secret | Yes | String | Your secret key |
apikey | Yes | String | The user apikey |
video_id | Yes | String | The video id |
Example of successful call (status code = 200).
{
"success": true
}
Error messages:
Status Code | Error Code | Description |
401 | SECRET_KEY_NOT_VALID | Secret key is not validing |
401 | AUTHENTICATION_FAILED | User not found or expired |
404 | NOT_FOUND | Video id not specified or not valid |
403 | AUTHORIZATION_FAILED | The user can't access the specified video |
400 | NOT_READY | Video hasn't been fully transcoded yet |
This is an additional method that returns a complete list of projects and related videos.
Parameters:
Parameters | Required | Type | Description |
secret | Yes | String | Your secret key |
apikey | Yes | String | The user apikey |
Example of successful call (status code = 200)
[
{
"id": "13",
"name": "My first project",
"videos": [
{
"id": "2354",
"code": "sdjftk23gd7h89lho",
"created_at": "2017-08-03 09:11:54",
"updated_at": "2018-04-19 09:02:05",
"title": "input-filename.mp4",
"width": "500",
"height": "700",
"duration": "117.334",
"ratio": "0.714286",
"master_hls": "https://embed.vidello.com/1234567/sdjftk23gd7h89lho/video/master.m3u8",
"mp4": [
{
"name": "Low",
"width": "457",
"height": "640",
"url": "https://embed.vidello.com/1234567/sdjftk23gd7h89lho/video/457/video.mp4"
},
{
"name": "Very Low",
"width": "286",
"height": "400",
"url": "https://embed.vidello.com/1234567/sdjftk23gd7h89lho/video/286/video.mp4"
}
],
"size": "0.0327203"
},
.. other videos here ..
]
},
]
Error messages:
Status Code | Error Code | Description |
401 | SECRET_KEY_NOT_VALID | Secret key is not validing |
401 | AUTHENTICATION_FAILED | User not found or expired |
This call returns the embed code of a video.
Parameters:
Parameters | Required | Type | Description |
secret | Yes | String | Your secret key |
apikey | Yes | String | The user apikey |
video_id | Yes | String | The video id |
responsive | Yes | String | accepted values are "true" and "false" |
width | No | String | used only if responsive is "false" |
popover | No | String | accepted values are "true" and "false". Empty means "false" |
In case of a successful call (status code = 200) the embed code is returned.
Error messages:
Status Code | Error Code | Description |
401 | SECRET_KEY_NOT_VALID | Secret key is not validing |
401 | AUTHENTICATION_FAILED | User not found or expired |
404 | NOT_FOUND | The specified video has not been found |
403 | AUTHORIZATION_FAILED | The specified video is not owned by user |