cURL Header

api-key specify your api-key to get access to API
user-client-token user client token
user-access-token user access token

response-type specify API response type : ("json" or "xml")
api-version specify required API version : ("v1.0" o "v1.1")

VOD file

URL :

 http://api.westream.com/video/list

Response :

{
    "message":
                [
                    {
                        "idVideo":"abcd1234",
                        "title":test title,
                        "description":null,
                        "keywords":null,
                        "date":"2016-02-25 11:26:57",
                        "status":"private",
                        "fileName":"test_file.mp4",
                        "videoBaseName":"123abc123",
                        "previewImageURL":"http://api.westream.com/username/preview_00000.png",
                        "type": "standard"
                    },
                    { .... },
                    { .... },
                    { .... },
               ],
    "code":200,
    "success":"true"
}

Parameters :

username(string)

URL :

 http://api.westream.com/video/update/metadata

Response :

{
    "message":"Updated successfully",
    "code":200,
    "success":true
}

Parameters :

idVideo(string) title(string)(optional) description(string)(optional) keywords(string)(optional) type(standard/360)(optional)

URL :

 http://api.westream.com/video/update/status

Response :

{
    "message":"Changed status successfully",
    "code":200,
    "success":true
}

Parameters :

idVideo(string)

URL :

 http://api.westream.com/video/view/metadata

Response :

{
    "message":
                {
                    "title":"video-title",
                    "description":"video-desc",
                    "keywords":"tag1","tag2","tag3",
                    "type":"standard"
                },
    "code":200,
    "success":true
}

Parameters :

idVideo(string)

link :

 http://api.westream.com/video/pending/list

Risultato :

{
    "message":
                [
                    {
                        "idVideo": "b62671b2434",
                        "title": "442b4-samila_1459416734_1.mp4",
                        ...
                        ...
                        "status": "failed",
                        "date": "2016-03-31 11:56:16",
                    }, {  }
                ],
    "code": 200,
    "success": true
}

Parametri da passare :

username;

Trash/delete file

URL :

 http://api.westream.com/video/trash/list

Response :

{
    "message":
                [
                    {
                        "idVideo":"abcd1234",
                        "title":null,
                        "date":"2016-02-25 10:39:16",
                        "fileName":"filename.mp4",
                        "videoBaseName":"abcd1234abcd",
                        "previewImageURL":"http://api.westream.com/username/preview_00000.png",
                        "dateTrash":"2016-02-25 14:31:54"
                    },
                    { .... },
                    { .... },
                    { .... },
               ],
    "code":200,
    "success":"true"
}

Parameters :

username(string)

URL :

 http://api.westream.com/video/trash

Response :

{
    "message":"Video has been moved to trash",
    "code":200,
    "success":true
}

Parameters :

idVideo(string)

URL :

 http://api.westream.com/video/restore

Response :

{
    "message":"Video restored successfully",
    "code":200,
    "success":true
}

Parameters :

idVideo(string)

URL :

 http://api.westream.com/video/delete

Response :

{
    "message":"Video deleted successfully",
    "code":200,
    "success":"true"
}

Parameters :

idVideo(string)

Output response example 

{
    "api_version": "v1.1"
    "results":
                [
                    { ... },
                    { ... }
                ],
    "message" : " ... ",
    "status_code" : "200",
    "success" : "true/false",
    "errors":
                {
                    "err_message" : " test error",
                    "err_code" : 34
                }
}
                        
{
    "api_version": "v1.0"
    "message":
                [
                    { ... },
                    { ... }
                ],
    "code" : "200",
    "success" : "true/false",
}

Errors

200 : Ok - Success!!

201 : Created

204 : Non content - There was no data to return.

400 : bad request - The request was invalid or cannot be otherwise served.

401 : Unauthorized - Authentication credentials were missing or incorrect.

403 : forbidden - The request is understood, but it has been refused or access is not allowed.

404 : Not found - The URI requested is invalid or the resource requested, such as a user, does not exists.

406 : Not Acceptable

500 : Internal Server Error - Something is broken.