[应用]知道openapi接口规范文档10_final.doc

百度知道OF田API接口规范文档VI 0系统名称百度知道OTO4API服务接口项目负责人作者耿艳坤文档提交日期2010-08-26百度网络技术（北京）有限公司版权所有，翻版必究）修改记录No修改后 版本号修改内容简介修改日期修改人11. 0ri■度知道OPEN API服务接口2010-08-26耿艳坤1背景 52 规范适用对象说明 53 名词解释 54 请求数据包格式规范 54 1 URL 54 2 参数 64 2 1 系统级参数 64 2 2 业务级参数的通用约定 64 2 3 参数签名算法 65 响应数据包格式规范 75 1 沁输出格式 75 2 json输出格式 85 3 错误响应输出格式 86 错误码定义 97 API接口细则 97. 1 baidu zhidaQ getQuestionList 97.1.1 功自呂 97」.2 参数 97.1.3 返回值 107. 2 baidu zhidao getQuestionScarch 10721 功能 107.2.2 参数 107.2.3 返回值 117. 3 baidu zhidaQ getQuestionlnfQ 117.3.1 功能 117.3.2 参数 117.3.3 返回值 127. 4 baidu zhidaa getQuestionAiiswer 127.4.1 功能 127.4.2 参数 137.4.3 返回值 137. 5 baidu zhidaQ question 13751 功能 137.5.2 参数 137.5.3 返回值 147. 6 baidu zhidaQ answer 147.6.1 功能 147.6.2 参数 147.6.3 返回值 148 第三方提供API接口细则 159 附件及参考资料 161背景本文旨在为第三方合作站点应用访问百度知道开放服务提供统一的HHP接口调用与交互规范。

本文中描述的规范包括百度知道问题列表杳询接口、检索查询接口、提问接口和回答接口2规范适用对象说明本规范仅适川于由服务器端发起调用请求、RHT提交数据以及 时请求文木数据结果的OpenAPL名词解释• 百度矢口道： http //zhidaQ baidu can• API KE^注册API合作时由百度的OP吐I API平台分配的唯一标识一个应用的字符串，又称应用公钥• API SECREE注册API合作时由百度的0P取API平台分恥的应用密钥，用于平台与合作站点之间通信时的参数签名4请求数据包格式规范4 1URL按照百度Open API规范，百度知道OPd API提供如下REST风格的HHP接口:http //open zhidaa beidu ccm/rcstserver/zhidad? {query string}querj^_string由系统级参数部分和具体 Open API调用参数部分纟fl成，以 key l=va 1 ue&key2=va 1 ue2& ..表示，对于采丿 IJ POST请求的 Open API, query_sLring 部分则是在 FC6T 请求体里所有查询类的Open API接I I既支持P0CT 也支持GET力式，提交类的0P取API接口仅 支持RST方式。

4 2参数4 2 1系统级参数以下参数是由百度Open API平台系统定义的，百度知道需要支持这些参数以便接入该平台提供 开放接口百度知道采用应用授权认证接口方式，合作初始百度知道代第三方站点中请应用分配 api_J

目前，百度知道目前支持xml、j son格式5 1血L输出格式• 文档编码格式UI^-8• 接口的返I叫数据中，数组对应的xml节点包含lisUtrub属性，其子节点的标签名跟对应 的数据有联系，并且同个数组内的同级节点的标签名一致例如表示问题标题列表对应的 xml输出可能为：• 接口的返回数据中，对象类型和普通数据类型数据(string inL double bool)对应的xml节点不包含list局性或者list属性值为fals巳节点标签名具有实际意义，与数据所 描述的信息相符例如，表示问题的数据对应的 输出为：VtitlQV MAE"度大厦的地址是什么？ ]]Rtitle> 5 2 j son输出格式API调用时如果传递format参数为json（大小写不敏感），则正常响应包符合如下规范的j son字符串：• http响丿应头中的 Content-^Type指定为 appl icat ion/j son charset=utP-8• 字符串编码格式是UH字符串内容是 沁输出数据所对应的FHP数组的标准JSCN字符串5 3错误响应输出格式错误响应输出内容符合以下规范：• 返1叫内容由erroi_code error_ms& request_^rgs这3个属性组成，分别用于描述错谋码，错误信息，以及调用Open API吋所传递的所有参数的信息。

• rcqucsL_args属性是一个数组，由n个包含key和value属性的对象组成例如，假设第三方应用调用baidu zhidaa getQuestionList接口时传递的参数api_key无效,则其对应的xml格式的错i吴响应包为如卜•格式：101Inval id API key' >>Json格式的字符串内容是0L输出数据所对应的FHP数纽的标准JSCN字符串6错误码定义百度开放知道QP取API调用过程中可能会返回的错误码定义如下表所示:erroii codeerrorjpsgDescription0Success成功1Unknown error未知错误2Service temporarily unavailable后端服务暂时不可用3Unsupported openapi methodOpen api接口不被支持4Open api request limit reached应用对openapi接口的调用请求数 达到上限5Unauthorized client IP address : %sopen api调用端的IP未被授权100Invalid parameter参数无效或缺失101Invalid API keyApi key无效103Invalid call_id parameterCal l id参数无效或已被使用过104Incorrect signature签名无效105Too many parameters参数过多106Unsupported signature method参数签名算法耒被平台所支持200No permission to access data没有权限访问数据900No such application exists应用不存在12001Parameters format error。