《百度开放知道OPEN API接口规范文档.doc》由会员分享，可在线阅读，更多相关《百度开放知道OPEN API接口规范文档.doc（14页珍藏版）》请在三一文库上搜索。
1、百度知道OPEN API接口规范文档v1.0 百度知道OPEN API接口规范文档V1.0系统名称百度知道OPEN API服务接口项目负责人作者耿艳坤文档提交日期2010-08-26百度在线网络技术（北京）有限公司(版权所有,翻版必究)百度在线网络技术（北京）有限公司 - 1 -百度知道OPEN API接口规范文档v1.0 修改记录No修改后版本号修改内容简介修改日期修改人11.0百度知道OPEN API服务接口2010-08-26耿艳坤目 录The table of contents is empty because none of the paragraph styles selected
2、 in the Document Inspector are used in the document.百度在线网络技术（北京）有限公司 - 3 -a003c3b0e009f8d86a48e3c8dd3b4297.pdf 1 背景本文旨在为第三方合作站点应用访问百度知道开放服务提供统一的HTTP接口调用与交互规范。本文中描述的规范包括百度知道问题列表查询接口、检索查询接口、提问接口和回答接口。2 规范适用对象说明本规范仅适用于由服务器端发起调用请求、POST提交数据以及GET请求文本数据结果的Open API。3 名词解释l 百度知道：http:/ l API KEY：注册API合作时由百度的
3、OPEN API平台分配的唯一标识一个应用的字符串，又称应用公钥l API SECRET：注册API合作时由百度的OPEN API平台分配的应用密钥，用于平台与合作站点之间通信时的参数签名4 请求数据包格式规范4.1 URL按照百度Open API规范，百度知道OPEN API提供如下REST风格的HTTP接口：http:/ API调用参数部分组成，以key1=value&key2=value2&表示，对于采用POST请求的Open API，query_string部分则是在POST请求体里。所有查询类的Open API接口既支持POST，也支持GET方式，提交类的OPEN API接口仅支持P
4、OST方式。4.2 参数4.2.1 系统级参数以下参数是由百度Open API平台系统定义的，百度知道需要支持这些参数以便接入该平台提供开放接口。百度知道采用应用授权认证接口方式，合作初始百度知道代第三方站点申请应用分配api_key和参数签名密钥api_secret。表格 41 API系统级参数参数名类型是否必需描述api_keystring是注册应用时分配到的api keymethodstring是采取baidu.zhidao.getQuestionList这样的命名空间方式制定方法名call_iduint是时间戳，系统时间的秒值,同个应用的不同api请求的time值应该是递增的, 用于防
5、replay攻击formatstring否响应包格式，可以是xml（默认）或jsoniestring否API调用请求包的编码类型，支持UTF-8和GBKbd_sigstring是参数签名，对bd_sig外所有参数串的签名，包括业务级的参数。4.2.2 业务级参数的通用约定百度知道遵守百度Open API规范中业务级通用参数的约定。表格 42 业务级参数的通用约定参数名类型描述page_noInt用于支持分页的api，默认为1，表示第几页page_sizeInt用于支持分页的api，表示每页返回多少条数据，默认以及上限为254.2.3 参数签名算法参数签名生成算法采取如下方式（PHP版），其它语
6、言根据注释描述完成等同功能：/param_array是key-value形式的参数数组，不包括api_secret密钥本身/secret是合作申请成功后分配的api_secret密钥function generate_sig($param_array, $secret) $str = ;/对param_array中的参数名称进行升序排序ksort($param_array);/按照如下格式转换数组为string格式foreach ($param_array as $k=$v) $str .= $k=$v;/string末端补充api_secret密钥$str .= $secret;/生成MD5
7、为最终的数据签名return md5($str);注：密钥是百度知道分配给第三方应用的secret_key，该算法返回的结果便是系统级参数中的bd_sig。5 响应数据包格式规范响应数据包的格式由调用时传递的format参数指定（默认为xml格式），无论是xml格式还是json格式，输出内容都是UTF-8格式。目前，百度知道目前支持xml、json格式。5.1 XML输出格式l 文档编码格式UTF-8l 接口的返回数据中，数组对应的xml节点包含list=”true”属性，其子节点的标签名跟对应的数据有联系，并且同个数组内的同级节点的标签名一致。例如表示问题标题列表对应的xml输出可能为：l
8、接口的返回数据中，对象类型和普通数据类型数据（string，int，double，bool）对应的xml节点不包含list属性或者list属性值为false，节点标签名具有实际意义，与数据所描述的信息相符。例如，表示问题的数据对应的xml输出为：!CDATAhttp:/ json输出格式API调用时如果传递format参数为json（大小写不敏感），则正常响应包符合如下规范的json字符串：l http响应头中的Content-Type指定为application/json, charset=utf-8l 字符串编码格式是UTF-8字符串内容是XML输出数据所对应的PHP数组的标准JSON字符
9、串5.3 错误响应输出格式错误响应输出内容符合以下规范：l 返回内容由error_code, error_msg, request_args这3个属性组成，分别用于描述错误码，错误信息，以及调用Open API时所传递的所有参数的信息。l request_args属性是一个数组，由n个包含key和value属性的对象组成例如，假设第三方应用调用baidu.zhidao.getQuestionList接口时传递的参数api_key无效，则其对应的xml格式的错误响应包为如下格式：101Invalid API keyJson格式的字符串内容是XML输出数据所对应的PHP数组的标准JSON字符串6
10、错误码定义百度开放知道OPEN API调用过程中可能会返回的错误码定义如下表所示：error_codeerror_msgDescription0Success成功1Unknown error未知错误2Service temporarily unavailable后端服务暂时不可用3Unsupported openapi methodOpen api接口不被支持4Open api request limit reached应用对open api接口的调用请求数达到上限5Unauthorized client IP address:%sopen api调用端的IP未被授权100Invalid pa
11、rameter参数无效或缺失101Invalid API keyApi key无效103Invalid call_id parameterCall_id参数无效或已被使用过104Incorrect signature签名无效105Too many parameters参数过多106Unsupported signature method参数签名算法未被平台所支持200No permission to access data没有权限访问数据900No such application exists应用不存在12001Parameters format error必选参数格式错误12002Answ
12、er for invalid question提交回答的问题生命已结束7 API接口细则以下接口返回数据均是以XML格式为demo，JSON格式的字符串内容是XML输出数据所对应的PHP数组的标准JSON字符串。7.1 baidu.zhidao.getQuestionList7.1.1 功能基于百度知道分类ID获取对应分类下的问题列表URL Demo：http:/ &call_id=1276418994&format=xml&bd_sig=sig-result&cid=249&qstatus=0&page_no=2&page_size=257.1.2 参数参数名类型描述4.2.1 系统级参数全
13、体4.2.2 业务级参数全体cidint百度知道的分类IDqstatusint问题状态 0为待解决 1为已解决7.1.3 返回值l Response XML 示例l Response XML 标签说明标签名描述id问题IDurl该问题在百度知道的URLtitle问题标题content提问内容cid该问题在百度知道所属的分类IDcname该问题在百度知道所属的分类名称7.2 baidu.zhidao.getQuestionSearch7.2.1 功能基于检索关键字在百度知道中搜索匹配的问题列表URL Demo：http:/ 参数参数名类型描述4.2.1 系统级参数全体4.2.2 业务级参数全体k
14、eywordsstring检索关键字 多个检索关键字之间使用+号连接qstatusint问题状态 0为待解决 1为已解决7.2.3 返回值l Response XML 示例l Response XML 标签说明标签名描述id问题IDurl该问题在百度知道的URLtitle问题标题content提问内容cid该问题在百度知道所属的分类IDcname该问题在百度知道所属的分类名称7.3 baidu.zhidao.getQuestionInfo7.3.1 功能基于百度知道问题ID获取对应问题的数据以及回答URL Demo：http:/ &call_id=127323494&format=xml&bd
15、_sig=sig-result&qid= 1227274827.3.2 参数参数名类型描述4.2.1 系统级参数全体qidint百度知道的问题ID7.3.3 返回值l Response XML 示例l Response XML 标签说明标签名描述questionInfo问题内容数据，具体明细参考7.1和7.2bestAnswers最佳答案列表answers普通答案列表content回答内容cite回答参考资料pic_url回答贴图URL7.4 baidu.zhidao.getQuestionAnswer7.4.1 功能基于百度知道问题ID、回答ID获取对应问题的数据的回答URL Demo：ht
16、tp:/ &call_id=127323494&format=xml&bd_sig=sig-result&qid= 122727482&aid=12321423527.4.2 参数参数名类型描述4.2.1 系统级参数全体qidint百度知道的问题IDaidint百度知道的回答ID7.4.3 返回值l Response XML 示例l Response XML 标签说明标签名描述questionInfo问题内容数据，具体明细参考7.1和7.2answerInfo回答内容数据7.5 baidu.zhidao.question7.5.1 功能向百度知道进行提问URL Demo：http:/ 参数全部
17、为POST方式7.5.2 参数参数名类型描述4.2.1 系统级参数全体api_key method call_id format bd_sig（POST）titlestringPOST字段问题标题contentstringPOST字段问题内容utypestringPOST字段用户类型，例如baidu、renren、wanmeiuidintPOST字段第三方账号系统uidunamestringPOST字段第三方账号系统uname7.5.3 返回值l Response XML 示例l Response XML 标签说明标签名描述error_code错误号，0为成功error_msg错误描述qid提
18、问成功后返回的qid7.6 baidu.zhidao.answer7.6.1 功能向百度知道的待解决问题进行回答URL Demo：http:/ 参数全部为POST方式7.6.2 参数参数名类型描述4.2.1 系统级参数全体api_key method call_id format bd_sig （POST）qidstringPOST字段提供回答的问题IDcontentstringPOST字段回答内容citestringPOST字段回答参考资料pic_urlstringPOST字段回答的贴图utypestringPOST字段用户类型，例如baidu、renren、wanmeiuidintPOST
19、字段第三方账号系统uidunamestringPOST字段第三方账号系统uname7.6.3 返回值l Response XML 示例l Response XML 标签说明标签名描述error_code错误号，0为成功error_msg错误描述qid回答成功后返回的问题id8 第三方提供API接口细则使用提问API（baidu.zhidao.question）的第三方，其用户使用该API提交提问之后，如果知道平台上有用户对该提问进行了回答，那么是需要一种机制反馈给第三方API调用者，以便及时将回答反馈给提问的用户，解决用户的疑问。本章节描述提问下产生回答后，第三方需要提供的API接口规范格式和
20、要求。所有回答相关的反馈输出字符编码均是UTF-8需要第三方提供HTTP的接口，采用POST方法，参数签名加密算法和4.2.3章节描述的算法一致，会使用第三方的密钥进行加密，第三方对之进行有效性校验，需要支持的POST参数如下：参数名类型描述methodstring值为baidu.zhidao.feedbackqidint问题ID，知道为int型aidint回答ID，知道为int型utypestring提问用户的用户类型，例如baidu、renren、飞信uidint第三方账号系统uid第三方基于接收到的qid和aid向平台发起请求，调用baidu.zhidao.getQuestionAnsw
21、er API接口获取对应提问下的回答信息。第三方合作站点如果不采用消息提醒=抓取回答内容的方式，可以选择下面这个直接接收回答数据的方法，仍然是HTTP接口，POST方法，参数签名加密算法和4.2.3章节描述的算法一致，会使用第三方的密钥进行加密，第三方对之进行有效性校验，需要支持的POST参数如下：参数名类型描述methodstring值为baidu.zhidao.feedAnswerqidint问题ID，知道为int型aidint回答ID，知道为int型utypestring提问用户的用户类型，例如baidu、renren、wanmeiuidint第三方账号系统uidcontentstrin
22、g回答内容citestring回答参考资料pic_urlstring回答的贴图URL第三方合作接收到平台的回答反馈后，需要按指定数据格式输出数据信息，输出数据格式为UTF-8编码的XML接口。具体数据格式为：l Response XML 示例baidu.zhidao.feedback接口返回:baidu.zhidao.feedAnswer接口返回:l Response XML 标签说明标签名描述error_code错误号，0为成功error_msg错误描述上述两种POST HTTP接口，对于使用提问API的第三方，实现一种即可，应用注册申请时指明具体采用策略即可。9 附件及参考资料百度在线网络技术（北京）有限公司 - 13 -