Overview
Describes the request and response formats used for API integration.
Request
All API requests are sent via HTTPS.
All API requests must be signed and API requests with an invalid signature will be rejected. Refer to Authentication for more information.
Refer to Diagrams for flow by situation for API interworking
Request Header
The header of all API requests except Get Browser Token must include svc-api-key.
The Get Browser Token request requires sis-api-key in the header.
Additionally, For requests that include scv-api-key in the header, must include signature, timestamp, and nonce in header.
Refer to Authentication for more information.
Request Body
The body data must be in JSON format.
For detailed body format by API, refer to API Reference.
Response
Response Body
The format of Response Body includes the fields below and is sent in JSON object format.
result
required
boolean
Returns true on success or false on failure, depending on the request processing.
data
optional
object
For requests that require response data, the data field contains the corresponding object .
If the request failed, the data field is not present in the response body.
The data field is structured as follows.
In case data is one object,
{
data: some value or object
}
In case data is a list,
{
data: {
total: 10
list: [some value or object, ..]
offset: 0
limit: 10
}
}
errorMessage
optional
string
If the request failed, describe the failed request.
Last updated