API Response Format

Overview

An HTTP code of 200 is responded for each successful data requests. If there is any error exists, an HTTP code 200 will be given as well as platform Error Code and error description.

 

Success

A valid request made using current credentials will return a 200 response. The body of the response will be a JSON file starting as follows:

{

    "code": 0,

    "msg": "Successful operation",

    "msg_en": "Successful operation",

    ......

}

 

Failure 

An invalid request or a request that cannot be authenticated will result a 200 response. The body of the response will give detailed information as in this example:

{

    "code": 1000001,

    "msg": "Wrong access token",

    "msg_en": "Wrong access token"

}

If the code is not 0 it is a failed request and msg_en field giving more details.

 

List of Error Codes

 

Error Code (errorCode) Description
1000001 Wrong access token.
1000002 Wrong user token
1000003 Wrong api path.
1000004 Wrong signature.