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")

Upload VOD file

URL :

 http://api.westream.com/upload

Response :

{
    "message":
            {
                "idVideo": "abc1234",
                "fileName": "video_1.mp4",
                "filePath" : "http://api.westream.com/user_upload/filename.mp4"
            },
    "code": 200,
    "success": "true"
}

Parameters :

file(type:file) username(string)

URL :

 http://api.westream.com/upload/encoding

Response :

{
    "message":
                {
                    "idVideo": "abc123",
                    "fileName": "test-vide.mp4",
                    "message": "start encoding"
                },
    "code: 200",
    "success":true
}

Parameters :

idVideo(string) username(string)

URL :

 http://api.westream.com/upload/encoding/status

Response :

{
    "message":
                {
                    "status":"finished"
                },
    "code":200,
    "success":true
}
{
    "message":
                {
                    "status":"processing",
                    "progress":"35.23532"
                },
    "code":200,
    "success":true
}

Parameters :

idVideo(string)

Upload stream record file

URL :

 http://api.westream.com/upload/encoding/stream-record

Response :

{
    "message":
                {
                    "idVideo": "abc123",
                    "fileName": "test-vide.mp4",
                    "message": "start encoding"
                },
    "code: 200",
    "success":true
}

Parameters :

username(string) fileName(string) ex: filename.mp4

Upload posterframe

link :

 http://api.westream.com/upload/poster-frame

Response :

{
    "message":
                {
                    "idContrib":"abcd1234",
                    "fileName":"test.jpg",
                    "filePath":"http://westream.com\contrib\test.jpg"
                },
    "code":200,
    "success":true
}

Parameters :

file(type:file) username(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.