开发前必读
更新时间:2022-06-08
前置任务
开发者规范
- 以下定义使用本API的通用规范。
公共请求头
头域(Header) | 是否必须 | 说明 |
---|---|---|
authorization | 必须 | 使用AK/SK生成的请求签名 |
host | 必须 | 值固定为yuqing.bce.baidu.com |
公共响应头
头域(Header) | 说明 |
---|---|
x-bce-request-id | 舆情服务后端生成,并自动设置到响应头域中 |
公共响应码
响应码 | 说明 |
---|---|
200 | 请求成功 |
400 | 请求参数错误 |
401 | 用户身份验证失败 |
403 | 用户无相关操作权限 |
500 | 舆情服务后端内部错误 |
通用错误返回格式
当调用接口出错时,将返回通用的错误格式。HTTP的返回状态码为4xx或5xx,返回的消息体将包括全局唯一的请求、错误代码以及错误信息。调用方可根据错误码以及错误信息定位问题,当无法定位到错误原因时,可以发工单联系百度技术人员,并提供requestId以便于快速地帮助您解决问题。
消息体定义
参数名 | 类型 | 说明 |
---|---|---|
requestId | String | 请求的唯一标识 |
code | String | 错误类型代码 |
message | String | 错误的信息说明 |
错误返回示例
{
"requestId": "47e0ef1a-9bf2-11e1-9279-0100e8cf109a",
"code":"UserNotLogin",
"message":"用户未登录或登录失败"
}
通用错误码说明
code | 报错原因及解决办法 |
---|---|
UserNotLogin | 头部签名authorization不正确,请参照文档下方获取ak/sk并按指引或使用示例代码重新生成 |
UserStatusError | authorization鉴权通过,但用户账号被停用,如要继续使用,需联系舆情客服 |
UserTimeRangeError | authorization鉴权通过,但用户权限已过期,如要继续使用,需联系舆情 |
AK/SK获取方法
https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
authorization 代码示例与方法
其他语言生成authorization 请参考 百度云认证鉴定机制 ,签名生成后,可通过 签名排查工具 自查生成的签名是否正确。