百度知道OPEN API接口规范文档1.0_final
百度知道OPEN API接口规范文档V1.0
系统名称百度知道OPEN API服务接口
项目负责人
作者耿艳坤
文档提交日期2010-08-26
百度在线网络技术（北京）有限公司
(版权所有,翻版必究)
修改记录
No 修改后
版本号
修改内容简介修改日期修改人
1 1.0 百度知道OPEN API服务接口2010-08-26 耿艳坤
目录
1背景 (4)
2规范适用对象说明 (4)
3名词解释 (4)
4请求数据包格式规范 (4)
4.1URL (4)
4.2参数 (4)
4.2.1系统级参数 (4)
4.2.2业务级参数的通用约定 (5)
4.2.3参数签名算法 (5)
5响应数据包格式规范 (6)
5.1XML输出格式 (6)
5.2json输出格式 (6)
5.3错误响应输出格式 (7)
6错误码定义 (7)
7API接口细则 (8)
7.1baidu.zhidao.getQuestionList (8)
7.1.1功能 (8)
7.1.2参数 (8)
7.1.3返回值 (8)
7.2baidu.zhidao.getQuestionSearch (9)
7.2.1功能 (9)
7.2.2参数 (9)
7.2.3返回值 (9)
7.3baidu.zhidao.getQuestionInfo (10)
7.3.1功能 (10)
7.3.2参数 (10)
7.3.3返回值 (10)
7.4baidu.zhidao.getQuestionAnswer (11)
7.4.1功能 (11)
7.4.2参数 (11)
7.4.3返回值 (12)
7.5baidu.zhidao.question (12)
7.5.1功能 (12)
7.5.2参数 (12)
7.5.3返回值 (12)
7.6baidu.zhidao.answer (13)
7.6.1功能 (13)
7.6.2参数 (13)
7.6.3返回值 (13)
8第三方提供API接口细则 (14)
9附件及参考资料 (15)
1背景
本文旨在为第三方合作站点应用访问百度知道开放服务提供统一的HTTP接口调用与交互规范。
本文中描述的规范包括百度知道问题列表查询接口、检索查询接口、提问接口和回答接口。
2规范适用对象说明
本规范仅适用于由服务器端发起调用请求、POST提交数据以及GET请求文本数据结果的Open API。
3名词解释
●百度知道：https://www.360docs.net/doc/0113825170.html,
●API KEY：注册API合作时由百度的OPEN API平台分配的唯一标识一个应用的字符串，又
称应用公钥
●API SECRET：注册API合作时由百度的OPEN API平台分配的应用密钥，用于平台与合作站
点之间通信时的参数签名
4请求数据包格式规范
4.1URL
按照百度Open API规范，百度知道OPEN API提供如下REST风格的HTTP接口：
https://www.360docs.net/doc/0113825170.html,/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方式。
4.2参数
4.2.1系统级参数
以下参数是由百度Open API平台系统定义的，百度知道需要支持这些参数以便接入该平台提供
开放接口。百度知道采用应用授权认证接口方式，合作初始百度知道代第三方站点申请应用分配api_key和参数签名密钥api_secret。
表格4-1 API系统级参数
参数名类型是否必需描述
api_key string 是注册应用时分配到的api key
method string 是采取baidu.zhidao.getQuestionList这样的命名空间方式制定方法名
call_id uint 是时间戳，系统时间的秒值,同个应用的不同api请求的time值应该是递增的, 用于防replay攻击
format string 否响应包格式，可以是xml（默认）或json
ie string 否API调用请求包的编码类型，支持UTF-8和GBK
bd_sig string 是参数签名，对bd_sig外所有参数串的签名，包括业务级的参数。
4.2.2业务级参数的通用约定
百度知道遵守百度Open API规范中业务级通用参数的约定。
表格4-2 业务级参数的通用约定
参数名类型描述
page_no Int 用于支持分页的api，默认为1，表示第几页
page_size Int 用于支持分页的api，表示每页返回多少条数据，默认以及上限为25
4.2.3参数签名算法
参数签名生成算法采取如下方式（PHP版），其它语言根据注释描述完成等同功能：//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为最终的数据签名
return md5($str);
}
注：密钥是百度知道分配给第三方应用的secret_key，该算法返回的结果便是系统级参数中的bd_sig。
5响应数据包格式规范
响应数据包的格式由调用时传递的format参数指定（默认为xml格式），无论是xml格式还是json格式，输出内容都是UTF-8格式。目前，百度知道目前支持xml、json格式。
5.1XML输出格式
●文档编码格式UTF-8
●接口的返回数据中，数组对应的xml节点包含list=”true”属性，其子节点的标签名跟对应
的数据有联系，并且同个数组内的同级节点的标签名一致。例如表示问题标题列表对应的xml输出可能为：
●接口的返回数据中，对象类型和普通数据类型数据（string，int，double，bool）对应的
xml节点不包含list属性或者list属性值为false，节点标签名具有实际意义，与数据所描述的信息相符。例如，表示问题的数据对应的xml输出为：
5.2json输出格式
API调用时如果传递format参数为json（大小写不敏感），则正常响应包符合如下规范的json 字符串：
●http响应头中的Content-Type指定为application/json,charset=utf-8
●字符串编码格式是UTF-8
字符串内容是XML输出数据所对应的PHP数组的标准JSON字符串
5.3错误响应输出格式
错误响应输出内容符合以下规范：
●返回内容由error_code, error_msg, request_args这3个属性组成，分别用于描述错误
码，错误信息，以及调用Open API时所传递的所有参数的信息。
●request_args属性是一个数组，由n个包含key和value属性的对象组成
例如，假设第三方应用调用baidu.zhidao.getQuestionList接口时传递的参数api_key无效，则其对应的xml格式的错误响应包为如下格式：
Json格式的字符串内容是XML输出数据所对应的PHP数组的标准JSON字符串
6错误码定义
百度开放知道OPEN API调用过程中可能会返回的错误码定义如下表所示：
error_code error_msg Description
0 Success成功
1 Unknown error未知错误
2 Service temporarily unavailable后端服务暂时不可用
3 Unsupported openapi method Open api接口不被支持
4 Open api request limit reached
应用对open api 接口的调用请求数达到上限 5 Unauthorized client IP address:%s open api 调用端的IP 未被授权 100 Invalid parameter 参数无效或缺失 101 Invalid API key
Api key 无效
103 Invalid call_id parameter Call_id 参数无效或已被使用过 104 Incorrect signature 签名无效 105 Too many parameters
参数过多
106 Unsupported signature method 参数签名算法未被平台所支持 200 No permission to access data 没有权限访问数据 900 No such application exists 应用不存在 12001 Parameters format error 必选参数格式错误
12002
Answer for invalid question
提交回答的问题生命已结束
7 API 接口细则
以下接口返回数据均是以XML 格式为demo ，JSON 格式的字符串内容是XML 输出数据所对应的PHP 数组的标准JSON 字符串。
7.1 baidu.zhidao.getQuestionList
7.1.1 功能
基于百度知道分类ID 获取对应分类下的问题列表 URL Demo ：
https://www.360docs.net/doc/0113825170.html,/restserver/zhidao?api_key=20000&method=baidu.zhidao.getQuestionList &call_id=1276418994&format=xml&bd_sig=sig-result&cid=249&qstatus=0&page_no=2&page_size=25
7.1.2 参数
参数名
类型
描述
4.2.1 系统级参数全体 4.2.2 业务级参数全体 cid int 百度知道的分类ID
qstatus
int
问题状态 0为待解决 1为已解决
7.1.3 返回值
Response XML 示例
●Response XML 标签说明
标签名描述
id 问题ID
url 该问题在百度知道的URL
title 问题标题
content 提问内容
cid 该问题在百度知道所属的分类ID
cname 该问题在百度知道所属的分类名称
7.2baidu.zhidao.getQuestionSearch
7.2.1功能
基于检索关键字在百度知道中搜索匹配的问题列表
URL Demo：
https://www.360docs.net/doc/0113825170.html,/restserver/zhidao?api_key=20000&method=baidu.zhidao.getQuestionSear ch&call_id=12764994&format=xml&bd_sig=sig-result&keywords=北京+百度大厦&qstatus=0
&page_no=2&page_size=25
7.2.2参数
参数名类型描述
4.2.1 系统级参数全体
4.2.2 业务级参数全体
keywords string 检索关键字多个检索关键字之间使用+号连接
qstatus int 问题状态 0为待解决 1为已解决
7.2.3返回值
●Response XML 示例
●Response XML 标签说明
标签名描述
id 问题ID
url 该问题在百度知道的URL
title 问题标题
content 提问内容
cid 该问题在百度知道所属的分类ID
cname 该问题在百度知道所属的分类名称
7.3baidu.zhidao.getQuestionInfo
7.3.1功能
基于百度知道问题ID获取对应问题的数据以及回答
URL Demo：
https://www.360docs.net/doc/0113825170.html,/restserver/zhidao?api_key=20000&method=baidu.zhidao.getQuestionInfo &call_id=127323494&format=xml&bd_sig=sig-result&qid= 122727482
7.3.2参数
参数名类型描述
4.2.1 系统级参数全体
qid int 百度知道的问题ID
7.3.3返回值
●Response XML 示例
Response XML 标签说明
标签名描述
questionInfo 问题内容数据，具体明细参考7.1和7.2
bestAnswers 最佳答案列表
answers 普通答案列表
content 回答内容
cite 回答参考资料
pic_url 回答贴图URL
7.4baidu.zhidao.getQuestionAnswer
7.4.1功能
基于百度知道问题ID、回答ID获取对应问题的数据的回答
URL Demo：
https://www.360docs.net/doc/0113825170.html,/restserver/zhidao?api_key=20000&method=baidu.zhidao.getQuestionInfo &call_id=127323494&format=xml&bd_sig=sig-result&qid= 122727482&aid=1232142352
7.4.2参数
参数名类型描述
4.2.1 系统级参数全体
qid int 百度知道的问题ID
aid int 百度知道的回答ID
7.4.3返回值
●Response XML 示例
●Response XML 标签说明
标签名描述
questionInfo 问题内容数据，具体明细参考7.1和7.2
answerInfo 回答内容数据
7.5baidu.zhidao.question
7.5.1功能
向百度知道进行提问
URL Demo：
https://www.360docs.net/doc/0113825170.html,/restserver/zhidao参数全部为POST方式
7.5.2参数
参数名类型描述
4.2.1 系统级参数全体api_key method call_id format bd_sig（POST）
title string POST字段问题标题
content string POST字段问题内容
utype string POST字段用户类型，例如baidu、renren、wanmei uid int POST字段第三方账号系统uid
uname string POST字段第三方账号系统uname
7.5.3返回值
●Response XML 示例
●Response XML 标签说明
标签名描述
error_code 错误号，0为成功
error_msg 错误描述
qid 提问成功后返回的qid
7.6baidu.zhidao.answer
7.6.1功能
向百度知道的待解决问题进行回答
URL Demo：
https://www.360docs.net/doc/0113825170.html,/restserver/zhidao参数全部为POST方式
7.6.2参数
参数名类型描述
4.2.1 系统级参数全体api_key method call_id format bd_sig （POST）
qid string POST字段提供回答的问题ID
content string POST字段回答内容
cite string POST字段回答参考资料
pic_url string POST字段回答的贴图
utype string POST字段用户类型，例如baidu、renren、wanmei uid int POST字段第三方账号系统uid
uname string POST字段第三方账号系统uname
7.6.3返回值
●Response XML 示例
●Response XML 标签说明
标签名描述
error_code 错误号，0为成功
error_msg 错误描述
qid 回答成功后返回的问题id
8第三方提供API接口细则
使用提问API（baidu.zhidao.question）的第三方，其用户使用该API提交提问之后，如果知道平台上有用户对该提问进行了回答，那么是需要一种机制反馈给第三方API调用者，以便及时将回答反馈给提问的用户，解决用户的疑问。本章节描述提问下产生回答后，第三方需要提供的API 接口规范格式和要求。所有回答相关的反馈输出字符编码均是UTF-8
需要第三方提供HTTP的接口，采用POST方法，参数签名加密算法和4.2.3章节描述的算法一致，会使用第三方的密钥进行加密，第三方对之进行有效性校验，需要支持的POST参数如下：参数名类型描述
method string 值为baidu.zhidao.feedback
qid int 问题ID，知道为int型
aid int 回答ID，知道为int型
utype string 提问用户的用户类型，例如baidu、renren、飞信
uid int 第三方账号系统uid
第三方基于接收到的qid和aid向平台发起请求，调用baidu.zhidao.getQuestionAnswer API 接口获取对应提问下的回答信息。
第三方合作站点如果不采用消息提醒=》抓取回答内容的方式，可以选择下面这个直接接收回答数据的方法，仍然是HTTP接口，POST方法，参数签名加密算法和4.2.3章节描述的算法一致，会使用第三方的密钥进行加密，第三方对之进行有效性校验，需要支持的POST参数如下：参数名类型描述
method string 值为baidu.zhidao.feedAnswer
qid int 问题ID，知道为int型
aid int 回答ID，知道为int型
utype string 提问用户的用户类型，例如baidu、renren、wanmei
uid int 第三方账号系统uid
content string 回答内容
cite string 回答参考资料
pic_url string 回答的贴图URL
第三方合作接收到平台的回答反馈后，需要按指定数据格式输出数据信息，输出数据格式为UTF-8编码的XML接口。具体数据格式为：
Response XML 示例
baidu.zhidao.feedback接口返回:
baidu.zhidao.feedAnswer接口返回:
Response XML 标签说明
标签名描述
error_code 错误号，0为成功
error_msg 错误描述
上述两种POST HTTP接口，对于使用提问API的第三方，实现一种即可，应用注册申请时指明具体采用策略即可。
9附件及参考资料
API接口文档
API接口文档 最后更新日期：2013-05-16 一、添加域名接口 (6) 1、接口调用地址 (6) 2、传入参数 (6) 3、输出数据 (6) 二、删除域名接口 (7) 1、接口调用地址 (7) 2、传入参数 (7) 3、输出数据 (7) 三、添加用户接口 (8) 1、接口调用地址 (8) 2、传入参数 (8) 3、输出数据 (8) 四、获取用户信息接口 (9) 1、接口调用地址 (9) 2、传入参数 (9) 3、输出数据 (9) 五、搜索用户接口 (10) 1、接口调用地址 (10) 2、传入参数 (10) 3、输出数据 (10) 六、修改用户接口 (11) 1、接口调用地址 (11) 2、传入参数 (11) 3、输出数据 (12) 七、删除用户接口 (13) 1、接口调用地址 (13) 2、传入参数 (13) 3、输出数据 (13) 八、获取邮箱别名接口 (14) 1、接口调用地址 (14) 2、传入参数 (14) 3、输出数据 (14) 九、获取部门列表接口 (15) 1、接口调用地址 (15) 2、传入参数 (15) 3、输出数据 (15) 十、添加部门接口 (17) 1、接口调用地址 (17)
3、输出数据 (17) 十一、修改部门接口 (18) 1、接口调用地址 (18) 2、传入参数 (18) 3、输出数据 (18) 十二、删除部门接口 (19) 1、接口调用地址 (19) 2、传入参数 (19) 3、输出数据 (19) 十三、获取部门成员接口 (20) 1、接口调用地址 (20) 2、传入参数 (20) 3、输出数据 (20) 十四、添加部门成员接口 (21) 1、接口调用地址 (21) 2、传入参数 (21) 3、输出数据 (21) 十五、删除部门成员接口 (22) 1、接口调用地址 (22) 2、传入参数 (22) 3、输出数据 (22) 十六、添加别名接口 (23) 1、接口调用地址 (23) 2、传入参数 (23) 3、输出数据 (23) 十七、修改别名接口 (24) 1、接口调用地址 (24) 2、传入参数 (24) 3、输出数据 (24) 十八、删除别名接口 (25) 1、接口调用地址 (25) 2、传入参数 (25) 3、输出数据 (25) 十九、获取POP接收邮件接口 (26) 1、接口调用地址 (26) 2、传入参数 (26) 3、输出数据 (26) 二十、添加POP接收邮件接口 (27) 1、接口调用地址 (27) 2、传入参数 (27) 3、输出数据 (27) 二十一、修改POP接收邮件接口 (28) 1、接口调用地址 (28)
Web Services业务接口规范说明书
XXXX系统 Web Services业务接口规范说明书 拟制 审核 会签 批准 【公司名称】
版本历史
目录 1.范围 (1) 2.术语、定义和缩略语 (1) 2.1 术语、定义 (1) 2.2 缩略语 (1) 3.接口设计 (1) 3.1 接口公共参数 (1) 3.1.1请求参数 (1) 3.1.2返回参数 (2) 3.2 业务功能接口 (3) 3.2.1业务模块1 (3) 4.MD5加密 (6) 5.参考文献 (6)
1.范围 本规范文档主要适用于XXXX系统和其它业务系统信息数据的接入。 2.术语、定义和缩略语 2.1术语、定义 2.2缩略语 3.接口设计 3.1接口公共参数 接口服务器通过：http://IP:port/EIP/WebService/ 连接服务器，同时对外提供业务功能接口，接收的参数和返回的参数都用一定的xml格式进行封装。 3.1.1请求参数 1.请求类型为String类型
3.请求参数体param定义 参数体param中的具体请求参数，根据不同的业务而不同，详见各业务接口。 3.1.2返回参数 1.返回类型为String类型
接口调用说明文档
XXX）科技有限公司 数据接口 2015-5-26
目录 第1章引言. ......................................................... 错误!未定义书签。 背景. ........................................................... 错误!未定义书签。 第2章接口与数据定义. ................................................... 错误!未定义书签。 曝光台查询接口. ..................................................... 错误!未定义书签。 曝光台列表查询.......................... 错误!未定义书签。 曝光台详情查询.......................... 错误!未定义书签。 信用公示查询接口定义.......................... 错误!未定义书签。 守信公示列表查询.......................... 错误! 未定义书签。 守信公示详情查询.......................... 错误!未定义书签。 失信公示列表查询.......................... 错误!未定义书签。 失信公示详情查询.......................... 错误!未定义书签。 企业名称查询接口定义.......................... 错误!未定义书签。 Webservice 方法定义 ........................ 错误! 未定义书签。 请求参数. .................................................... 错误! 未定义书签。 返回数据. .................................................... 错误!未定义书签。 企业信息查询接口定义.......................... 错误!未定义书签。 Webservice 方法定义 ........................ 错误! 未定义书签。 请求参数. .................................................... 错误! 未定义书签。 返回数据. .................................................... 错误!未定义书签。
接口设计规范
目录 1接口类型 (2) 1.1人机接口 (2) 1.2软件-硬件接口 (2) 1.3软件接口 (2) 1.4通信接口 (2) 2接口设计规范 (2) 2.1基本内容 (2) 2.2规格说明 (3) 2.2.1人机接口 (3) 2.2.2软件-硬件接口 (3) 2.2.3软件接口 (3) 2.2.4通信接口 (3) 3接口设计文档提纲 (3)
1接口类型 1.1人机接口 人机接口是指计算机系统为完成人与机器之间互相传送信息而提供的功能的接口，包括硬件及程序。 1.2软件-硬件接口 软件-硬件接口是指软件系统中软件与硬件之间的接口。例如软件与接口设备之间的接口。 1.3软件接口 软件接口是软件系统中程序之间的接口。包括软件系统与其他系统或子系统之间的接口、程序模块之间的接口、程序单元之间的接口等。 1.4通信接口 通信接口是指处理机和标准通信子系统之间的接口。包括为实现数据通信用来完成接口功能的部件、装置及有关软件。 2接口设计规范 2.1基本内容 1、接口的名称标识 2、接口在该软件系统中的地位和作用 3、接口在该软件系统中与其他程序模块和接口之间的关系 4、接口的功能定义 5、接口的规格和技术要求，包括它们各自适用的标准、协议或约定 6、各个接口的数据特性 7、各个接口的资源要求，包括硬件支持、存储资源分配等 8、接口程序的数据处理要求
9、接口的特殊设计要求 10、接口对程序编制的要求 2.2规格说明 2.2.1人机接口 准确地说明人机接口的设计条件、设计特征、编程要求等技术内容。包括人机交互环境、人机接口部件、信息传输方式及传输特性、信息格式、数据处理、存储资源分配和程序编制要求等。 2.2.2软件-硬件接口 逐个描述每一个软件-硬件间接口的设计特性。包括接口硬件说明、接口功能说明、接口信息说明、接口处理方法、接口控制方式、接口时间特性、存储资源分配和程序编制要求等。 2.2.3软件接口 逐个说明本软件系统与其他软件系统间接口的设计特征。包括接口功能说明、接口约定、数据特性、数据处理方法、接口程序运行控制、接口时间特性、存储资源分配和程序编制要求等。 2.2.4通信接口 逐个描述各个通信接口的设计特性。包括硬件描述、接口功能说明、通信协议、报文处理、存储资源分配、程序接口设计和程序编制要求等。 3接口设计文档提纲 1概述........................................................................................................................................................... 错误！未定义书签。 1.1编写目的......................................................................................................................................... 错误！未定义书签。 1.2参考资料......................................................................................................................................... 错误！未定义书签。 1.3术语和缩写词................................................................................................................................ 错误！未定义书签。2软件系统综述......................................................................................................................................... 错误！未定义书签。3接口设计.................................................................................................................................................. 错误！未定义书签。 3.1接口框图......................................................................................................................................... 错误！未定义书签。 3.2接口一览表.................................................................................................................................... 错误！未定义书签。 3.3人机接口......................................................................................................................................... 错误！未定义书签。 3.4软件-硬件接口 .............................................................................................................................. 错误！未定义书签。
开发接口文档-API文档模板
XXX项目接口文档版本控制信息 获取所有字段 获取所有字段 请求地址：/session/field/findAll 请求参数 响应
请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！ ","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"","iconSize":0,"ico nStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"iconColour":"","iconSize":0,"iconSty le":"","id":7,"name":"XX"}]},"totals":0} 文件上传 文件上传（ajax） 请求地址：/session/file/upload 请求参数 响应 请求例子：var formData = new FormData(); ("file", [0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData,
processData : false, contentType : false, success : function(result) { result = (result); if == "10000"){ ('上传成功！'); $("#editHeadPortrait").val } } }); 响应例子：returnValue里包含了 fileName和filePath 字段管理-所属类型 新增所属类型 请求地址：/session/fieldType/save 请求参数 响应 请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}
接口文档规范
XXX接口说明书(版本：V1.0)
修订记录
1简介 1.1文档目的 接口文档是前端与后端交互密不可分的环节，接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性，避免对接过程中的错误率。 1.2接口规范 (1) 遵循RESTful API设计风格 (2) 数据格式采用json格式 (3) 返回统一结构数据 例如： 结构：data（数据）、errorCode（状态码）、msg（提示信息） { data:{}, // 数据类型不一定为object类型 errorCode:10001, msg:'' } (4) 枚举型参数应列举参数所有值及说明 例如： gender：性别（男：1，女：2） userInfo:{ name:'张三', age:23, gender:1 }
(5) 具有嵌套关系的参数应指明嵌套关系及子级数据结构例如： billList: 账单列表(父级) billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' } ] (6) 返回参数数据类型保持一致性 例如： billList: 账单列表（有数据） billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' } ] billList: 账单列表（无数据） billList:[] 返回的参数数据类型都为：array (7) 下拉及选择型数据以键值对的形式返回 例如： orderOperate：订单操作 orderOperate:[
帝国CMS版接口说明
帝国CMS接口使用手册 一、简介 1、本接口应用于帝国CMS 版新闻系统模型的栏目文章发布； 2、本接口可以自动生成文章、栏目、首页等静态HTML页面； 3、本接口可以生成随机点击数，详见发布接口参数说明； 4、发布时请使用管理员用户帐号； 5、在帝国CMS utf8版使用本接口时，请在发布规则中选择编码为UTF-8； 6、本接口基于帝国CMS UTF8版制作，适用于帝国CMS GBK/utf-8等版本，应用于其他版本时请自行测试调整；； 7、接口文件无须任何改动即可使用，如果你希望增加校验或其他功能，请仔细修改； 8、2个接口文件请复制在网站 /e/admin目录下使用； 二、安装接口 在接口文件夹中找到接口文件，如图： 请将、等接口文件上传到指定目录，请使用二进制方式上传，如图： 三、配置发布规则 1、将范例发布规则文本导入ET2发布配置，或使用软件内置发布规则范例，如图：
2、将检查网址和发布网址中的“您的网站”改为您要发布的网站网址，如图： 3、在检查网址填上您要发布的栏目ID，如图： 4、在参数取值页，填上您要发布的网站栏目ID，如图： 这里查看栏目ID：
4、填上您的管理账号、密码，注意格式，如图： 四、接口说明 一、检查接口 1、接口文件名，为保密，请自行修改文件名； 2、本接口文件复制在网站/e/admin目录使用，如果目录名有变更，请自行对应； 3、主要参数 keyboard 文章标题 classid 栏目ID，用于指定检查栏目，可在后台网站栏目管理处查看； vercode 校验码，请自行设定，并在检查接口文件开始处修改$vercode 使其一致； 4、发布配置-文章检查网址处，可以如下填写： 注：使用大小写敏感的服务器的用户请注意网址大小写和网站文件一致 5、接口文件无须任何改动即可使用，如果你希望增加校验或其他功能，请仔细修改； 二、发布接口 1、接口文件名，为保密，请自行修改文件名； 2、本接口文件请复制在网站/e/admin目录下使用，为保密，请自行修改文件名；
API 接口 设计文档 模板
Dream调试工具DLL接口文档 文件状态：[√] 草稿[ ] 正式发布[ ] 正在修改当前版本： 1.0 作者：ChunFeng Li 文件密级：[ ]普通[√]秘密[ ]绝密 文档版本 版本/状态作者参与者日期说明 1.0 ChunFeng Li ChunFeng Li 2016-04-13 设备只能发现串口连接的设备，指 令只能下发单条修改 一、DLL初始化 1.描述 调用所有接口之前需要先调用初始化接口。 2.接口名（dll导出名） Dream_Init() 3.请求参数说明 参数字段必选类型限制说明 _net_point True int<65535 Udp广播端口号 _com_rate True int 38400 连接串口的默认波特率 _call_back True Void* ... 异步消息回调（详细见第五条：回调函数） 4.返回参数说明 a.返回类型Int :0成功-1重复初始化 二、获取最新设备列表 1.描述 调用该接口获取所有当前在线列表。 2.接口名（dll导出名） Dream_GetDeviceList() 3.请求参数说明
char_buf True char* 1024 存放返回数据的内存指针，空间大小有调 用方分配 buf_len True int 1024 分配的空间大小 4.返回参数说明 a.返回类型Int : 返回数据长度。 b.返回数据结构:”1000,COM3\r\n1001,COM5\r\n1002,192.168.0.118\r\n”。 [ID,Name\r\n]为一个设备，以后有跟多设备详细信息，往后接。 三、发送指令消息 1.描述 下发数据和读取数据指令都通过该接口实现。(阻塞方式调用函数) 2.接口名（dll导出名） Dream_SendAction() 3.请求参数说明 参数字段必选类型限制说明 device_id True int>1000 发送消息的设备ID例如1000 _ChannelCode True int 0-0xFF 通道编码：例如0x10 _FunctionCode True int 0-0xFF 功能编码，不同的编码对应不同的功能_FunctionNumber True int 0-0xFF 功能编号，标记当前编码对应不同的功能data_msg True char* 发送指令的data，没有数据为NULL，如 果是单个数据：12.1，如果是整组数据： 12.1,1,0,...... 按顺序逗号隔开的连续字符 time_out True int 20*N 接口调用超时时间，单位毫秒 out_buf True char* 存放返回数据的内存指针，空间大小有调 用方分配 buf_max_len True int 分配的空间大小 4.返回参数说明 a.返回类型Int : 返回数据长度。如果为0,表示超时或网络异常 b.返回的数据结构：如果是下发数据，返回的是成功和失 败；”ACK”,”NAK”,”NO_CMD”,”ERROR”,”TimeOut”,如果是读取数据，返回的是数据， 例如12.1，或数据组12.1,12.2,1,1.2..... 四、DLL初始化 1.描述 下发数据和读取数据指令都通过该接口实现。(非阻塞方式调用函数) 2.接口名（dll导出名） Dream_SendAction() 3.请求参数说明
软件需求说明书编写规范
{产品名称} 软件需求规格说明书 编写人： 编写日期：年月日
目录 1.产品描述 (3) 1.1.编写目的 (3) 1.2.产品名称 (3) 1.3.名词定义（可选） (3) 2.产品需求概述 (3) 2.1.功能简介 (3) 2.2.运行环境 (3) 2.3.条件与限制（可选） (3) 3.功能需求 (3) 3.1.功能划分（可选） (3) 3.2.功能1 (4) 3.3.功能N (4) 3.4.不支持的功能 (4) 4.数据描述 (4) 5.性能需求（可选） (4) 6.运行需求（可选） (4) 6.1.用户界面 (4) 6.2.硬件接口 (4) 6.3.软件接口 (5) 6.4.通信接口 (5) 7.其它需求（可选） (5) 8.特殊需求（可选） (5) 9.不确定的问题（可选） (5) 10.编写人员及编写日期 (5) 11.附录 (5) 11.1.引用文件 (5) 11.2.参考资料 (5)
1.产品描述 1.1.编写目的 【说明编写本软件需求规格说明书的目的，指出预期的读者。】 1.2.产品名称 【本项目的名称，包括项目的全名、简称、代号、版本号。】 1.3.名词定义（可选） 【对重要的或是具有特殊意义的名词（包括词头和缩写）进行定义，以便读者可以正确地解释软件需求说明。】 2.产品需求概述 2.1.功能简介 【对产品的基本功能做一个简介，包括： 1.本产品的开发意图、应用目标及作用范围。 2．概略介绍了产品所具有的主要功能。可以用列表的方法给出，也可以用图形表示主要的需求分组以及它们之间的联系，例如数据流程图的顶层图或类图等。 3．说明本产品与其他相关产品的关系，是独立产品还是一个较大产品的组成部分。 可以用表示外部接口和数据流的系统高层次图，或者方框图说明。】 2.2.运行环境 1.硬件环境： 【详细列出本软件运行时所必须的最低硬件配置、推荐硬件配置(如主机、显示器、外部设备等)以及其它特殊设备。】 2.软件环境： 【如操作系统、网络软件、数据库系统以及其它特殊软件要求。】 2.3.条件与限制（可选） 【说明本软件在实现时所必须满足的条件和所受的限制，并给出相应的原因。 必须满足的条件包括输入数据的范围以及格式。 所受的限制包括软件环境、硬件环境等方面的内容。例如：必须使用或者避免的特定技术、工具、编程语言和数据库；企业策略、政府法规或工业标准；硬件限制，例如定时需求或存储器限制；经费限制、开发期限；项目对外部因素存在的依赖。例如其它项目开发的组件。等等】 3.功能需求 【功能需求描述系统特性，即产品所提供的主要服务。可以通过使用实例、运行模式、用户类、对象类或功能等级等不同方法来描述，还可以把它们组合起来使用。 功能需求的表述形式可以参见《需求分析和管理指南》第8.2节。】 3.1.功能划分（可选） 【此部分从用户的角度描述将软件划分成不同的部分，并给出总体功能结构。对于复杂
SPDIF接口规范详解
S/PDIF接口规范详解，S/PDIF Specification （Sony/Philips Digital Interface Format）是一种数字音频传输接口，普遍使用光纤和同轴线输出，将音频信号输出值解码器上，能保持高保真度的输出结果，广泛应用在DTS（Digital Theatre System，数字化影院系统）和杜比数字中。 基本上是以AES/EBU(也称为AES3)专业用数字接口为参考然后做了一些小变动而成的家用版本，可以使用成本比较低的硬件来实现数字讯号传输。为了定制一个统一的接口规格，在现今以IEC 60958标准规范来囊括取代AES/EBU 与规范，而IEC 60958定义了三种主要型态： ?IEC 60958 TYPE 1 Balanced ─ 三线式传输，使用110 Ohm阻抗的线材以及XLR接头，使用于专业场合 ?IEC 60958 TYPE 2 Unbalanced ─ 使用75 Ohm阻抗的铜轴线以及RCA 接头，使用于一般家用场合 ?IEC 60958 TYPE 2 Optical ─ 使用光纤传输以及F05光纤接头，也是使用于一般家用场合 事实上，IEC 60958有时会简称为，而IEC 60958 TYPE 1即为AES/EBU(或着称为AES3)接口，而IEC 60958 TYPE 2即为接口，而虽然在IEC 60958 TYPE 2的接头规范里是使用RCA或着光纤接头，不过近年来一些使用的专业器材
改用BNC接头搭配上75 Ohm的同轴线以得到比较好的传输质量，下表为AES/EBU与的比较表。 使用的编码方法 在传输数据时使用双相符号编码(Biphase Mark Code)，简称BMC，属于一种相位调制(phase modulation)的编码方法，是将时钟讯号和数据讯号混合在一起传输的编码方法。 其原理是使用一个两倍于传输位率(Bit Rate)的时钟频率做为基准，把原本一位数据拆成两部份，当数据为1的时后在其时钟周期内转变一次电位(0->1或1->0)让数据变成两个不同电位的资料，变成10或01，而当数据为0时则不转变电位，变成11或00。同时每一个位开头的电平与前一个位结尾电平要不同，这样接收端才能判别每一个位的边界，如下图所示。 通信协议架构 与AES/EBU主要是做为传递PCM格式的信号，例如48kHz的DAT以及的CD，不过现在也有用来传递压缩过的多声道讯号。 标准传递两声道讯号的架构如下图所示，最上面为由192个框架(Frame)构成的区块(Block)。而每个Frame储存了两个声道的一组采样信号(Sample)，分为Channel A与Channel B两个声道。而每组Sample由一个子框架(Sub
完整的接口解决方案说明书
文档编号：T-JKJS 文档版本：0.01 项目编号：XX-DX- PECS 《XX电信工程外部协作系统》 Project Exterior Cooperation System 施工单位接口技术解决方案 编写人：南疯日期：2006-10-30 审核人：日期： 批准人：日期： XXXXXX信息科技股份有限公司 地址：XXXXXXX 邮编：XXXXXX 电话：XXXXXXXX传真：XXXXXX 网站：XXXXXXXXX 修改记录（Revision Chart） 版本号批准人修改人修改0.01南疯2006-10-30 0.02详细修改记录： 序号
1引言 1.1编写目的 1.2覆盖范围 1.3预期读者与阅读建议 1.4文档约定 1.5术语与缩略语 1.6参考文献 2概述 3接口方式 4接口安全 4.1接口认证 4.2数据安全 5事务处理 6性能考虑 7容错处理 8数据格式 8.1约定 8.2施工系统向外协系统发送请求 8.2.1请求查询一个业务数据 8.2.2新增一条记录，得到记录的键值 8.2.3修改一条记录 8.2.4删除一条记录 8.2.5文档上传 8.2.6一条记录中一个文档字段上传多个文件 8.2.7补充上传文档 8.2.8在记录中删除一个文档 8.2.9获得文档的基本信息 8.2.10获得文档的所有兄弟信息 8.2.11获得文档的所有父亲信息 8.2.12下载一个文档 8.2.13获得字典 8.3外协系统向施工系统发送请求 8.3.1发送变更后的数据 8.3.2发送变更后的字典 8.3.3文档发送请求 9信息数据项 9.1数据表 9.2字段信息 9.3字典类型
接口设计规范V1.0 - 参考
服务端与手机平台 接口协议 BespRout 2014年11月
文档修改/审批记录
目录 1.概述 (4) 2.涉及接口 (4) 3.接口总体要求 (4) 3.1.系统间接口的原则 (4) 3.2.处理流程 (4) 3.3.接口实现方式 (5) 4.XXX服务端接口 (5) 4.1.XX模块-根据XX下载相关的配置文件 (5) 4.2.XX模块-生成指定XX的文件配置 (6) 4.3.APP启动-初使化参数 (7) 5.附件 (8) 5.1.备注说明 (8)
1. 概述 本文档提供接口给手机端使用，为手机端提供业务平台数据 2. 涉及接口 本文档涉及的外围系统接口包括：无 3. 接口总体要求 3.1.系统间接口的原则 接口设计遵循如下原则： ?安全可靠性原则：系统应提供良好的安全性和可靠性策略，支持多种安全而 可靠的技术手段，制定严格的安全可靠的管理措施； ?开放性原则：提供开放式标准接口，提供与其它系统的互联互通； ?灵活性原则：提供灵活的接口设计，便于接口的变动。 ?可扩展性原则：支持新业务的扩展以及接口容量与接口性能的提高； ?可管理性原则：提供良好的管理机制，保证在运行过程中提供给管理员方便 的管理方式以处理各种情况； ?统一性原则：应当保证系统的接口方式、接口形式、使用的协议等标准、统 一。 3.2.处理流程 接口处理流程
3.3. 接口实现方式 手机APP 应用 与服务端采用基于HTTP 的REST 协议完成，数据传输默认为JSON 4. XXX 服务端接口 测试地址前缀: http://192.168.3.208:8088/xxx/xxx 4.1. XX 模块-根据XX 下载相关的配置文件
京东API接口整理
1、类目API 获取商家类目信息 获取类目属性 通过类目属性ID获取属性值列表 设置商家级别的类目销售属性值 添加商家商品销售属性 更新商家商品销售属性 获取类目属性列表 获取类目属性值 获取单个类目信息 查找子类目列表 查询商家已授权的品牌 数据结构 item_cat categoryAttr类目属性对象 attrFeature类目属性特殊属性 categoryAttrGroup属性分组 attrGroupFeature属性分组特殊属性 categoryAttrValue类目属性值对象 attrValueFeature类目属性特殊属性 feature特殊属性 wareaddvender_sellsku添加商家商品销售属性
wareupdatevender_sellsku更新商家商品销售属性 brandList商家品牌List集合 2、店铺API 京东店铺API，包含提供商家、商家店铺基本信息及店内分类操作查询等功能。 添加卖家自定义店内分类 更新商家自定义店内分类 删除商家自定义店内分类 获取前台展示的商家自定义店内分类 查询商家基本信息 店铺信息查询 查询退货地址列表 查询发货地址列表 3、商品API 提供网站商品信息更新、查询API,该组下所有接口均不支持自营店铺业务 1. 新增商品 修改商品 商品上架 商品下架 删除商品信息 根据商品ID查询单个商品的详细信息 批量获取商品信息 检索商品信息
获取商品上架的商品信息 获取商品下架的商品信息 根据商品Id，销售属性值Id查询图片根据商品Id，销售属性值Id增加图片根据商品Id，销售属性值Id删除图片根据商品Id，销售属性值Id设置图片根据商品Id，检索商品图片 设置商品限购区域 查询商品限购区域 添加商品关联版式 修改商品关联版式 删除商品关联版式 查询关联版式id以及名称 查询关联版式详情 设置关联版式到商品 增加SKU信息 修改SKU信息 修改SKU库存信息 修改SKU价格信息 删除SKU 信息 根据外部ID获取商品SKU 根据商品ID列表获取商品SKU信息 获取单个SKU信息 回复商品评价 查询商品评价信息列表
API接口设计说明书
XXAPI 接口设计说明书 公司 2016年11月25日 文档管理信息表 主题XX api接口设计说明书 版本V0.1 内容 关键字 参考文档 创建时间 创建人 最新发布日期 文档变更记录表 修改人修改时间修改内容 创建
目录 文档变更记录表 .................................................................................................................................................................................. 目录 .................................................................................................................................................................................................... 引言 ...................................................................................................................................................................................................... 编写目的 背景 定义 参考资料 综述 ...................................................................................................................................................................................................... 统一的输入输出参数 必须登录才能访问的接口 错误返回码列表 用户接口 .............................................................................................................................................................................................. 用户注册（user/signup） 用户登录（user/signin） 优惠券接口 .......................................................................................................................................................................................... 我的优惠券（coupon/mycoupon）
接口使用说明文档
中国移动短信网关 SP端接口使用手册 China Mobile Shot Message Gateway Interface for SP Manual 作者：沈岗 日期：2004年1月 版本：V1.2
一、CMSMIF.CMPPApp 简要说明： 该类采用CMPP协议(V2.0)实现了SP端与移动短信网关的连接处理。 本类中，采用长连接方式与ISMG通讯。通信双方以客户-服务器方式建立TCP连接，用于双方信息的相互提交。当信道上没有数据传输时，通信双方应每隔时间C发送链路检测包以维持此连接，当链路检测包发出超过时间T后未收到响应，立即再发送链路检测包，再连续发送N-1次后仍未得到响应则断开此连接。参数C、T、N可通过属性配置。 消息发送时采用并发方式，即发送一条消息不等待网关回复确认，继续向网关发送短信，这样发送消息速度非常快，完全取决于网关的处理速度及网络速度。为避免消息丢失，同时采用了滑动窗口流量控制，窗口大小可通过属性设置。 消息接收、网络断开等采用事件触发方式，不需应用程序轮询，在此接口基础之上编程方便。 类中运用了多线程技术，如一条线程处理发送网络包，而另一条线程处理从网关上接收网络包，其他还有一些线程处理检测包、网络连接情况监测等，使程序思路明确、执行效率很高、运行非常稳定。 （一）属性 1.ActiveInterval 说明：检测包发送时间间隔，单位：毫秒。默认值为120000，即120秒。为上 述类说明中的C参数。 2.MaxNetworkPackSize 说明：与ISMG通讯时最大网络包大小，单位：字节。默认值为512Byte。 3.MaxRetryTimes 说明：网络超时最大重发次数,单位：次。默认值为3次。为类说明中的N。 4.OverTime 说明：网络包发送超时时间,单位:毫秒,超过此值还未收到回复则重发。默认值 为60000，即60秒。为类说明中的T。 5.QueueLength 说明：网络队列大小，单位：个，默认值为20。为类说明中的滑动窗口大小， 以控制发送流量。 （二）方法 1.ConnectToIsmg 方法说明： 连接到远程短信网关ISMG上，只有连接到远程短信网关上，才可进行短信收发操作。 在本操作中，自动初始化本地Socket，以连接到指定IP服务器的指定端口上。 声明原型：int ConnectToIsmg(string ServerIP,int Port,string SP_ID,string Secret，string SN) 参数说明： ServerIP：远程短信网关服务器的IP地址，如211.138.200.51 Port：远程短信网关服务器的端口号，如7890 SP_ID：企业服务代码
通用接口标准规范v1
接口标准规范 目录 接口标准规范 (1) 第1章概述 (3) 第2章基本要求 (4) 2.1信息通讯安全 (4) 2.1.1 安全评估 (4) 2.1.2 访问控制 (4) 2.1.3 防恶意代码 (4) 2.1.4 加密 (5) 2.2支持高并发 (6) 2.3可监控 (6) 2.3.1 日志全覆盖 (6) 2.4系统资源的动态扩展 (6) 2.5异常处理机制 (7) 2.6业务扩展 (7) 第3章接口通讯方式 (7) 3.1同步请求/应答方式 (7) 3.2异步请求/应答方式 (7) 3.3会话方式 (7) 3.4广播通知方式 (7) 3.5事件订阅方式 (7)
3.7可靠消息传输 (8) 第4章传输控制要求 (8) 4.1负载均衡 (8) 4.2伸缩性与动态配置管理 (8) 4.3网络调度 (9) 4.4充分理由 (9) 4.5单一职责 (9) 4.6高内聚低耦合 (9) 4.7状态及消息 (10) 4.8控制数据量 (10) 4.9禁止随意拓展参数 (10) 第5章接口技术 (10) 第6章接口规范 (11) 6.1域名规范 (11) 6.1.1 http接口 (11) 6.1.2 webservice接口 (11) 6.2 API路径规范 (11) 6.2.1 http接口 (11) 6.2.2 webservice接口 (11) 6.3版本控制规范 (12) 6.3.1 http接口 (12) 6.3.2 webservice接口 (12) 6.4 API命名规范 (12) 6.4.1 新增方法 (13) 6.4.2 删除方法 (13) 6.4.3 修改方法 (13) 6.4.4 获取方法 (13) 6.4.5 获取列表方法 (13)
api接口文档
API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。API除了有应用“应用程序接口”的意思外，还特指API的说明文档，也称为帮助文档。 API：应用程序接口（API：Application Program Interface） 应用程序接口（是一组定义、程序及协议的集合，通过API 接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。程序员通过调用API 函数对应用程序进行开发，可以减轻编程任务。API 同时也是一种中间件，为各种不同平台提供数据共享。 根据单个或分布式平台上不同软件应用程序间的数据共享性能，可以将API 分为四种类型： 远程过程调用（RPC）：通过作用在共享数据缓存器上的过程（或任务）实现程序间的通信。 标准查询语言（SQL）：是标准的访问数据的查询语言，通过数据库实现应用程序间的数据共享。 文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。
信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。 当前应用于API 的标准包括ANSI 标准SQL API。另外还有一些应用于其它类型的标准尚在制定之中。API 可以应用于所有计算机平台和操作系统。这些API 以不同的格式连接数据（如共享数据缓存器、数据库结构、文件框架）。每种数据格式要求以不同的数据命令和参数实现正确的数据通信，但同时也会产生不同类型的错误。因此，除了具备执行数据共享任务所需的知识以外，这些类型的API 还必须解决很多网络参数问题和可能的差错条件，即每个应用程序都必须清楚自身是否有强大的性能支持程序间通信。相反由于这种API 只处理一种信息格式，所以该情形下的信息交付API 只提供较小的命令、网络参数以及差错条件子集。正因为如此，交付API 方式大大降低了系统复杂性，所以当应用程序需要通过多个平台实现数据共享时，采用信息交付API 类型是比较理想的选择。 API 与图形用户接口（GUI）或命令接口有着鲜明的差别：API 接口属于一种操作系统或程序接口，而后两者都属于直接用户接口。 有时公司会将API 作为其公共开放系统。也就是说，公司制定自己的系统接口标准，当需要执行系统整合、自定义和程序应用等操作时，公司所有成员都可以通过该接口标准调用源代码，该接口标准被称之为开放式API。