API Request/Response
All requests are made using HTTP POST method. Request data is formatted in JSON format. Regardless of success/error response, data is always formatted in JSON format, HTTP status code always 200.
All API requests must contain "Content-Type: application/json" HTTP header. If there is no request parameter, the request body must contain an empty JSON object, "{}". Empty request body will result in error.
Success Response Params
Name
Description
Type
status
Status
string ( 100 )
...
Successful Response Params
Example success response:
Error Response Params
Name
Description
Type
status
Status
string ( 100 )
error_code
Error Code
integer
error_msg
Error Message
string ( 255 )
errors
Extra Error Information
array
Example error response:
Note: Each error code defines a different error (e.g. validation, authentication, data format).
Last updated
Was this helpful?