zh:server_docs:api_call_guide:calling_protocol

调用协议

请求

请求协议 HTTPS
字符集编码 UTF-8
  • 在具体 API 说明中会给出 URL 路径,也就是域名后面的部分,在 URL 路径前面拼接上具体区域的域名即为完整的请求 URL;
  • 请参考 API 列表
公共请求头 说明
Authorization 用于传递 API 的访问凭证,请参考 鉴权方法
Content-Type
  • Method 为 GET 的 API 不要求传递 Content-Type 头;
  • Method 为 POST 的 API 需要传递的 Content-Type 头为如下 3 种之一:
    1. application/x-www-form-urlencoded
      • 大部分 API 都是这种方式,如无特殊说明则均为这种方式
    2. multipart/form-data
      • 个别 API 是这种方式,例如涉及到文件上传的 API,会在具体的 API 给出说明;
    3. application/json
      • 个别 API是这种方式,会在具体 API 给出说明;

响应

Content-Type application/json
字符集编码 UTF-8
参数 类型 参数说明
code int 错误代码。0 是成功,非 0 是失败,请参考 错误代码
msg string 错误描述,当失败的时候会给出具体的错误描述。
req_id string 日志跟踪 id,当遇到问题需要猎户星空协助查问题时候,请提供此跟踪 id 值。
data object 业务数据 data 对象,详见下述 响应体 data 对象
  • 不同的 API 会有不同的响应体 data 对象,请参考具体的 API 说明;
{
    "code": 0,
    "msg": "",
    "req_id": "test_req_id",
    "data": {
        // 不同的 API 会有不同的响应体 data 对象,请参考具体的 API 说明
    }
}
  • 最后更改: 2024-04-02 14:51 +0800