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

Authentication

link :

 //api.westream.com/auth/credentials

Response :

{
    "api_version": "v1.1",
    "results":
                {
                    "user_client_token": "42rfs...a123",
                    "user_refresh_token": "f2fds...f234",
                    "user_access_token": "z12df...s0fa",
                    "user_access_token_created_at": 1478707886,
                    "user_access_token_expires_in": 3600
                },
    "status_code": 200,
    "success": true
}

Parameters :

email(string [username or email]) password(md5)

link :

 //api.westream.com/auth/cpa/google

Response :

{
    "api_version": "v1.1",
    "results":
                {
                    "user_client_token": "42rfs...a123",
                    "user_refresh_token": "f2fds...f234",
                    "user_access_token": "z12df...s0fa",
                    "user_access_token_created_at": 1478707886,
                    "user_access_token_expires_in": 3600
                },
    "status_code": 200,
    "success": true
}

Parameters :

idToken(string) idClient(string)

Token

link :

 //api.westream.com/auth/token/refresh

Response :

{
    "api_version": "v1.1",
    "results":
                {
                    "user_access_token": "z12df...s0fa",
                    "user_access_token_created_at": 1478707886,
                    "user_access_token_expires_in": 3600
                },
    "status_code": 200,
    "success": true
}

Parameters :

none

link :

 //api.westream.com/auth/token/revoke

Response :

{
    "api_version": "v1.1",
    "results":
                {
                    "user_access_token": "z12df...s0fa",
                    "user_access_token_created_at": 1478707886,
                    "user_access_token_expires_in": 3600
                },
    "status_code": 200,
    "success": true
}

Parameters :

none

Registration

link :

 //api.westream.com/auth/registration

Response :

{
    ..
}

Parameters :

email(string) password(hash MD5) name(string) lastName(string)

link :

 //api.westream.com/auth/registration/cpa/google

Response :

{
    ..
}

Parameters :

idToken(token generate by Google Client) idClient(Google client ID)

Check user E-mail

link :

 //api.westream.com/auth/registration/check/email

Response :

{
    ..
}

Parameters :

email(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.