文档介绍：百度知道OPEN
系统名称
百度知道OPEN API服务接口
项目负责人
作者
耿艳坤
文档提交日期
2010-08-26
百度在线网络技术(北京)有限公司
(版权所有,翻版必究)
修改记录
No
修改后
版本号
修改内容简介
修改日期
修改人
1
百度知道OPEN API服务接口
2010-08-26
耿艳坤
目录
1 背景 4
2 规范适用对象说明 4
3 名词解释 4
4 请求数据包格式规范 4
URL 4
参数 4
系统级参数 4
业务级参数的通用约定 5
参数签名算法 5
5 响应数据包格式规范 6
XML输出格式 6
json输出格式 6
错误响应输出格式 7
6 错误码定义 7
7 API接口细则 8
8
功能 8
参数 8
返回值 8
9
功能 9
参数 9
返回值 9
10
功能 10
参数 10
返回值 10
11
功能 11
参数 11
返回值 12
12
功能 12
参数 12
返回值 12
13
功能 13
参数 13
返回值 13
8 第三方提供API接口细则 14
9 附件及参考资料 14
背景
本文旨在为第三方合作站点应用访问百度知道开放服务提供统一的HTTP接口调用与交互规范。
本文中描述的规范包括百度知道问题列表查询接口、检索查询接口、提问接口和回答接口。
规范适用对象说明
本规范仅适用于由服务器端发起调用请求、POST提交数据以及GET请求文本数据结果的Open API。
名词解释
百度知道:http://zhidao.
API KEY:注册API合作时由百度的OPEN API平台分配的唯一标识一个应用的字符串,又称应用公钥
API SECRET:注册API合作时由百度的OPEN API平台分配的应用密钥,用于平台与合作站点之间通信时的参数签名
请求数据包格式规范
URL
按照百度Open API规范,百度知道OPEN API提供如下REST风格的HTTP接口:
./restserver/zhidao?{query_string}
query_string由系统级参数部分和具体Open API调用参数部分组成,以key1=value&key2=value2&…表示,对于采用POST请求的Open API,query_string部分则是在POST请求体里。所有查询类的Open API接口既支持POST,也支持GET方式,提交类的OPEN API接口仅支持POST方式。
参数
系统级参数
以下参数是由百度Open API平台系统定义的,百度知道需要支持这些参数以便接入该平台提供开放接口。百度知道采用应用授权认证接口方式,合作初始百度知道代第三方站点申请应用分配api_key和参数签名密钥api_secret。
表格 4 1 API系统级参数
参数名
类型
是否必需
描述
api_key
string
是
注册应用时分配到的api key
method
string
是
call_id
uint
是
时间戳,系统时间的秒值,同个应用的不同api请求的time值应该是递增的, 用于防replay攻击
format
string
否
响应包格式,可以是xml(默认)或json
ie
string
否
API调用请求包的编码类型,支持UTF-8和GBK
bd_sig
string
是
参数签名,对bd_sig外所有参数串的签名,包括业务级的参数。
业务级参数的通用约定
百度知道遵守百度Open API规范中业务级通用参数的约定。
表格 4 2 业务级参数的通用约定