en:server_docs:api_call_guide:calling_protocol

Calling Protocol

Request

Request Protocol HTTPS
Character Encoding UTF-8

Request Entry Point

  • The URL path will be provided in the specific API documentation, which is the part after the entry point. Prepend the entry point of the specific region to the URL path to get the complete request URL;
  • Please refer to API List;
Common Request Headers Description
Authorization Used to pass the access token for the API. Please refer to Authentication Methods.
Content-Type
  • For APIs with the GET method, the Content-Type header is not required;
  • For APIs with the POST method, the Content-Type header needs to be one of the following 3 types:
    1. application/x-www-form-urlencoded
      • Most APIs use this method, unless otherwise specified;
    2. multipart/form-data
      • Some APIs use this method, for example, APIs involving file uploads will specify this in the specific API documentation;
    3. application/json
      • Some APIs use this method, specified in the specific API documentation;

Response

Content-Type application/json
Character Encoding UTF-8
Parameter Type Description
code int Error code. 0 means success, non-zero means failure, Please refer to Error Codes.
msg string Error description. When there is a failure, a specific error description will be provided.
req_id string Log tracking ID. When encountering problems that require assistance from OrionStar, please provide this tracking ID value.
data object Business data object, see below for details Response Body Data Object.
  • Different APIs will have different response body data objects, please refer to the specific API documentation;
{
    "code": 0,
    "msg": "",
    "req_id": "test_req_id",
    "data": {
        // Different APIs will have different response body data objects, please refer to the specific API documentation
    }
}
  • Last modified: 2024-04-09 20:49 +0800