接口规范

请求响应格式标准

未特殊说明时,所有接口的请求、响应内容均为json格式、UTF-8编码的文本,分别在HTTP请求体和响应体中提供。
所有接口请求的HTTP Headers中需要提供必要的信息,如下:

公共请求头

**公共头部 ** 描述
Authorization 包含Access Key与请求签名。
Content-Type application/json; charset=utf-8。
x-bce-date 表示日期的字符串,符合API规范。
x-bce-content-sha256 表示内容部分的SHA256签名的十六进制字符串。这里内容指HTTP Request Payload Body。即Content部分在被HTTP encode之前的原始数据。

HTTP协议的标准头域不再这里列出。公共头域将在每个百度信息流推广API中出现,是必需的头域,其中x-bce-content-sha256头域只出现在POST和PUT请求中。POST、PUT、DELETE等请求数据放在request body中。

未特殊说明时,所有接口的请求和响应内容具有公共的结构,各接口的说明中仅提供公共结构之下“body”和“data”部分的说明。

请求体结构:

{
    "body": ..., // body的内容由具体接口定义,每个接口中“请求”部分即body的内容说明
    "header": {
        "opUsername": "xxxx", // 操作账户名称
        "opPassword": "xxxx", // 操作账户密码
        "tgUsername": "xxxx", // 被操作账户名称
        "tgPassword": "xxxx", // 被操作账户密码
        "bceUser": "xxxx" // BCE账户名
    }
}

公共响应头

公共头部 描述
Content-Type application/json; charset=utf-8。
x-bce-request-id 后端生成,并自动设置到响应头域中。

其中,request id使用UUID version4由百度信息流推广API服务生成。

响应体结构:

{
    "body": {
        "data": [...] // data为数组,内容由具体接口定义,每个接口中“响应”部分即data的内容说明
    },
    "header": {
        "oprs": 1,
        "failures": [],
        "succ": 1,
        "oprtime": 0,
        "desc": "success",
        "status": 0
    }
}