腾讯对外接口API文档
打开以下网址，输入您的腾讯绑定帐号以及密码：
https://www.360docs.net/doc/7918084325.html,/index.php/API%E6%96%87%E6%A1%A3
类似这样的：
API文档
返回
出自腾讯微博开放平台
跳转到：导航, 搜索
OAuth授权时间线微博相关帐户相关关系链相关私信相关搜索相关热度，趋势数据更新相关数据收藏
话题相关标签相关名单微群相关邀请相关LBS相关其他文档更新历史API问题QA错误码说明表情列表下载
OAuth授权
request_token 获取request_token
authorize 用户授权request_token
access_token 交换access_token
access_token 交换access_token
点击查看示例API请求示例说明
auth/get_oauth2_token 通过oAuth1.0的token获取oAuth2.0的token
时间线
statuses/home_timeline 主页时间线
statuses/public_timeline 广播大厅时间线
statuses/user_timeline 其他用户发表时间线
statuses/mentions_timeline 用户提及时间线
statuses/ht_timeline 话题时间线(建议使用新话题时间线接口ht_timeline_ext) statuses/broadcast_timeline 我发表时间线
statuses/special_timeline 特别收听的人发表时间线
statuses/area_timeline 地区发表时间线
statuses/home_timeline_ids 主页时间线索引
statuses/user_timeline_ids 其他用户发表时间线索引
statuses/broadcast_timeline_ids 我发表时间线索引
statuses/mentions_timeline_ids 用户提及时间线索引
statuses/users_timeline 多用户发表时间线
statuses/users_timeline_ids 多用户发表时间线索引
statuses/ht_timeline_ext 话题时间线
statuses/home_timeline_vip 拉取vip用户发表微博消息接口
statuses/sub_re_list 获取二传手列表（获取转播或评论的再次转播或评论列表）微博相关
t/show 获取一条微博数据
t/add 发表一条微博
t/del 删除一条微博
t/re_add 转播一条微博
t/reply 回复一条微博（即对话）
t/add_pic 发表一条带图片的微博
t/re_count 转播数或点评数
t/re_list 获取单条微博的转发或点评列表
t/comment 点评一条微博
t/add_music 发表音乐微博
t/add_video 发表视频微博
t/getvideoinfo 获取视频信息
t/list 根据微博id批量获取微博内容（与索引合起来用）
t/sub_re_count 获取转播的再次转播数（二次转发次数)
t/add_emotion 发表心情帖子
t/add_pic_url 用图片URL发表带图片的微博
t/add_multi 多类型发表（可同时发表带音频、视频、图片的微博）
帐户相关
user/info 获取自己的详细资料
user/update 更新用户信息
user/update_head 更新用户头像信息
user/update_edu 更新用户教育信息
user/other_info 获取其他人资料
user/infos 获取一批人的简单资料
user/verify 验证账户是否合法（是否注册微博）
user/emotion 获取心情微博
关系链相关
friends/fanslist 我的听众列表
friends/fanslist_name 我的听众列表，只输出name
friends/idollist 我收听的人列表
friends/idollist_name 我收听的人列表，只输出name
friends/blacklist 黑名单列表
friends/speciallist 特别收听列表
friends/add 收听某个用户
friends/del 取消收听某个用户
friends/addspecial 特别收听某个用户
friends/delspecial 取消特别收听某个用户
friends/addblacklist 添加某个用户到黑名单
friends/delblacklist 从黑名单中删除某个用户
friends/check 检测是否我的听众或收听的人friends/user_fanslist 其他帐户听众列表
friends/user_idollist 其他帐户收听的人列表
friends/user_speciallist 其他帐户特别收听的人列表friends/fanslist_s 我的听众列表，简单信息（200个）friends/idollist_s 我的收听列表，简单信息（200个）friends/mutual_list 互听关系链列表
friends/match_nick_tips 好友账号及昵称输入提示
私信相关
private/add 发私信
private/del 删除一条私信
private/recv 收件箱
private/send 发件箱
搜索相关
search/user 搜索用户
search/t 搜索微博
search/userbytag 通过标签搜索用户
热度，趋势
trends/ht 话题热榜
trends/t 转播热榜
trends/famouslist 推荐名人列表
数据更新相关
info/update 查看数据更新条数
数据收藏
fav/addt 收藏一条微博
fav/delt 取消收藏一条微博
fav/list_t 收藏的微博列表
fav/addht 订阅话题
fav/delht 取消订阅话题
fav/list_ht 获取已订阅话题列表
话题相关
ht/ids 根据话题名称查询话题id
ht/info 根据话题id获取话题相关信息
标签相关
tag/add 添加标签
tag/del 删除标签
名单
list/list_followers 名单订阅成员列表信息
list/myfollowlist 我订阅的名单信息
list/create 创建名单
list/delete 删除名单
list/edit 修改名单
list/get_list 查询我创建的名单
list/check_user_in_list 筛选指定的用户是否在名单中
list/list_attr 名单属性信息
list/follow 订阅多个名单
list/undo_follow 取消订阅多个名单
list/add_to_list 收录指定用户到名单
list/del_from_list 从名单中删除指定用户
list/get_other_in_list 查询指定用户所在的所有list
list/listusers 查询名单成员列表
list/list_info 查询指定微博用户的名单相关信息微群相关
weiqun/add 在微群中发表微博消息
weiqun/apply4group 申请加入微群
weiqun/bindqqgroup 微群与Q群互绑定
weiqun/del 删除微群中的微博
weiqun/home_timeline 微群主页时间线
weiqun/multihome_timeline 多微群主页时间线
weiqun/quitgroup 退出微群
weiqun/setbulletin 设置微群公告
weiqun/setmemattr 设置微群成员属性
邀请相关
invite/get_invite_list 获取好友列表
invite/event_invite 发送好友邀请
LBS相关LBS相关接口使用说明文档
lbs/update_pos 更新地理位置
lbs/del_pos 删除最后更新位置
lbs/get_poi 获取POI(Point of Interest)
lbs/get_around_new 获取身边最新的微博
lbs/get_around_people 获取身边的人
其他
other/kownperson 我可能认识的人
other/shorturl 短url变长url
other/videokey 获取视频上传的key
other/get_emotions 获取表情接口
other/gettopreadd 一键转播热门排行
other/follower_trans_conv 拉取我收听的用户的转播消息接口other/quality_trans_conv 拉取精华转播消息接口
other/vip_trans_conv 拉取vip用户的转播消息接口
other/url_converge 短url聚合
other/gettopiczbrank 同话题热门转播排行
文档更新历史
API问题QA
错误码说明
表情列表下载
取自“https://www.360docs.net/doc/7918084325.html,/index.php/API%E6%96%87%E6%A1%A3”帐户相关/取消收听某个用户返回
出自腾讯微博开放平台
跳转到：导航, 搜索
目录
[隐藏]
? 1 请求说明
? 2 参数说明
? 3 使用说明
? 4 返回结果
? 5 字段说明
请求说明
url https://www.360docs.net/doc/7918084325.html,/api/friends/del
格式xml,json
http请求方式post
是否需要鉴权true
请求数限制true
关于请求数限制，参见接口访问权限说明
参数说明
请求参数：oauth或openid&openkey标准参数，并带上以下参数
format 返回数据的格式（json或xml）
name 他人的帐户名（可选）
他人的openid（可选）
fopenid
name和fopenid至少选一个，若同时存在则以name值为主
使用说明
https://www.360docs.net/doc/7918084325.html,/api/friends/del
post包体格式为：
format=json&name=xxxx&fopenid=xxxx
返回结果
{
ret:0,
msg:"ok",
errcode:0
}
字段说明
ret: 返回值，0-成功，非0-失败
msg:错误信息
errcode:返回错误码
errcode:发表失败错误码参看文档最后说明，点击此处查看
取自“https://www.360docs.net/doc/7918084325.html,/index.php/%E5%B8%90%E6%88%B7%E7%9B%B8%E5%85%B3/%E5 %8F%96%E6%B6%88%E6%94%B6%E5%90%AC%E6%9F%90%E4%B8%AA%E7%94%A8%E6%88%B 7”
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)
百度知道开放平台openAPI接口规范文档 V1.0
百度知道开放平台OPEN API接口规范文档 V 1.0 系统名称百度知道开放平台OPEN API服务接口 项目负责人 作者陈霖 文档提交日期2010-11-04 百度在线网络技术（北京）有限公司 (版权所有,翻版必究)
修改记录 No 修改后 版本号 修改内容简介修改日期修改人 1 1.0 百度知道OPEN API服务接口2010-11-04 陈霖
目录 1背景 (6) 2规范适用对象说明 (6) 3名词解释 (6) 4请求数据包格式规范 (6) 4.1URL (6) 4.2参数 (7) 4.2.1系统级参数 (7) 4.2.2业务级参数的通用约定 (7) 4.2.3参数签名算法 (7) 5响应数据包格式规范 (8) 5.1XML输出格式 (8) 5.2json输出格式 (9) 5.3错误响应输出格式 (9) 6错误码定义 (10) 7API接口细则 (10) 7.1baidu.zhidao.getCatalogInfo (10) 7.1.1功能 (10) 7.1.2参数 (11) 7.1.3返回值 (11) 7.2baidu.zhidao.getQuestionList (11) 7.2.1功能 (11) 7.2.2参数 (11) 7.2.3返回值 (12) 7.3baidu.zhidao.getQuestionSearch (12) 7.3.1功能 (12) 7.3.2参数 (12) 7.3.3返回值 (13) 7.4baidu.zhidao.getQuestionInfo (13) 7.4.1功能 (13) 7.4.2参数 (13) 7.4.3返回值 (14) 7.5baidu.zhidao.getQuestionAnswer (14) 7.5.1功能 (14) 7.5.2参数 (14) 7.5.3返回值 (15) 7.6baidu.zhidao.getUserInfo (15) 7.6.1功能 (15) 7.6.2参数 (15) 7.6.3返回值 (15) 7.7baidu.zhidao.getUserQuestionList (16) 7.7.1功能 (16) 7.7.2参数 (16)
开发接口文档-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}
软件开发文档模板
软件开发文档模板 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案 1 1.5.2 可选择的系统方案 2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资
1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题 2.4 支持条件 2.4.1 计算机系统支持 2.4.2 需要用户承担的工作 2.4.3 需由外单位提供的条件 2.5 专题计划要点
百度知道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)
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.请求参数说明
共享平台API接口规范文档V0.7s
共享平台API接口规范 版本: 0.7s 携程旅行网
目录 1.前言 (4) 1.1功能描述 (4) 1.2阅读对象 (4) 1.3业务术语 (4) 1.4技术服务............................................................................................................... 错误!未定义书签。 2.接口参数说明 (5) 2.1普通政策请求参数 (5) 2.2特惠政策请求参数 (5) 2.3特价政策请求参数 (16) 3.示例Xml请求 (16) 3.1普通政策 (16) 3.2特惠政策 (16) 3.3特价政策 (19) 4.错误代码整理 (21) 4.1错误代码规则说明 (21) 4.2错误固定标识及错误代码分类说明 (21) 4.3目前已知错误代码列表 (21)
版本历史
1.前言 1.1 功能描述 为了提高代理商在携程网的政策投放效率，满足其业务需求，由携程机票研发部门开发了一套代理商政策导入接入API。本文档是为了描述相应的接口规范。 1.2 阅读对象 面向具有一定技术实力的代理商公司相应的技术人员 1.3 业务术语 1.4 接口API导入必读 API导入入口： https://www.360docs.net/doc/7918084325.html,/Flight-Product-TradeAPI/PolicyWS.asmx
接口参数： username: 用户名 password: 密码（格式: MD5(UTF-8(“username#password”)）) execType: 执行类型，只支持FullADD(全量上传), ADD(增量上传) gzipRequestBytes: 请求报文字节数组，是对报文进行GZIP后产生的字节流 接口响应格式：返回的是对报文GZIP后的base64位格式的文本编码 目前每日最大请求次数是500次 1.5 技术服务 前期请直接联系相应的票台关联业务人员 2.接口参数说明 2.1 普通政策请求参数
软件项目开发各阶段文档模板(参考)
目录 1. 范围 (1) 2. 总体要求 (1) 2.1总体功能要求 (1) 2.2软件开发平台要求 (1) 2.3软件项目的开发实施过程管理要求 (2) 2.3.1 软件项目实施过程总体要求 (2) 2.3.2 软件项目实施变更要求 (2) 2.3.3 软件项目实施里程碑控制 (3) 3. 软件开发 (4) 3.1软件的需求分析 (4) 3.1.1 需求分析 (4) 3.1.2 需求分析报告的编制者 (5) 3.1.3 需求报告评审 (5) 3.1.4 需求报告格式 (5) 3.2软件的概要设计 (5) 3.2.1 概要设计 (5) 3.2.2 编写概要设计的要求 (6) 3.2.3 概要设计报告的编写者 (6) 3.2.4 概要设计和需求分析、详细设计之间的关系和区别 (6) 3.2.5 概要设计的评审 (6) 3.2.6 概要设计格式 (6) 3.3软件的详细设计 (7) 3.3.1 详细设计 (7) 3.3.2 特例 (7) 3.3.3 详细设计的要求 (7) 3.3.4 数据库设计 (7) 3.3.5 详细设计的评审 (7) 3.3.6 详细设计格式 (8) 3.4软件的编码 (8) 3.4.1 软件编码 (8) 3.4.2 软件编码的要求 (8) 3.4.3 编码的评审 (8) 3.4.4 编程规范及要求 (8) 3.5软件的测试 (9) 3.5.1 软件测试 (9) 3.5.2 测试计划 (9)
3.6.1 交付清单 (9) 3.7软件的鉴定验收 (10) 3.7.1 软件的鉴定验收 (10) 3.7.2 验收人员 (10) 3.7.3 验收具体内容 (10) 3.7.4 软件验收测试大纲 (11) 3.8培训 (11) 3.8.1 系统应用培训 (11) 3.8.2 系统管理的培训（可选） (11) 1. 引言 (19) 1.1编写目的 (19) 1.2项目风险 (19) 1.3文档约定 (19) 1.4预期读者和阅读建议 (20) 1.5产品范围 (20) 1.6参考文献 (20) 2. 综合描述 (21) 2.1产品的状况 (21) 2.2产品的功能 (22) 2.3用户类和特性 (22) 2.4运行环境 (22) 2.5设计和实现上的限制 (23) 2.6假设和约束(依赖) (23) 3. 外部接口需求 (24) 3.1用户界面 (24) 3.2硬件接口 (25) 3.3软件接口 (25) 3.4通讯接口 (26) 4. 系统功能需求 (26) 4.1说明和优先级 (27) 4.2激励／响应序列 (27) 4.3输入／输出数据 (28) 5. 其它非功能需求 (28) 5.1性能需求 (28) 5.2安全措施需求 (29) 5.3安全性需求 (29) 5.4软件质量属性 (29) 5.5业务规则 (29) 5.6用户文档 (30)
京东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接口文档
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。
软件开发文档模板库
软件开发文档模板库 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。 可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案1
1.5.2 可选择的系统方案2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资 1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题
开发接口API模板
XXX项目接口文档 版本控制信息 1获取所有字段 1.1获取所有字段 请求地址：/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,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"icon Colour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0} 2文件上传 2.1文件上传（ajax） 请求地址：/session/file/upload 请求参数 响应 请求例子：var formData = new FormData(); formData.append("file", this.files[0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData, processData : false, contentType : false, success : function(result) { result = JSON.parse(result); if(result.code == "10000"){
api接口文档
接口： 接口泛指实体把自己提供给外界的一种抽象化物，用以由内部操作分离出外部沟通方法，使其能被内部修改而不影响外界其他实体与其交互的方式。 在计算机中，接口是计算机系统中两个独立的部件进行信息交换的共享边界。这种交换可以发生在计算机软、硬件，外部设备或进行操作的人之间，也可以是它们的结合。 API： API是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程，而又无需访问源码，或理解内部工作机制的细节。 简介： 操作系统是用户与计算机硬件系统之间的接口，用户通过操作系统的帮助，可以快速、有效和安全、可靠地操纵计算机系统中的各类资源，以处理自己的程序。为使用户能方便地使用操作系统，OS 又向用户提供了如下两类接口： 用户接口：操作系统专门为用户提供了“用户与操作系统的接口” ，通常称为用户接口。该接口支持用户与OS 之间进行交互，即由用户向OS 请求提供特定的服务，而系统则把服务的结果返回给用户。 程序接口：操作系统向编程人员提供了“程序与操作系统的接口” ，简称程序接口，又称应用程序接口API。该接口是为程序员
在编程时使用的，系统和应用程序通过这个接口，可在执行中访问系统中的资源和取得OS 的服务，它也是程序能取得操作系统服务的唯一途径。大多数操作系统的程序接口是由一组系统调用(system call)组成，每一个系统调用都是一个能完成特定功能的子程序。 应用程序接口又称为应用编程接口，是一组定义、程序及协议的集合，通过API接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。API同时也是一种中间件，为各种不同平台提供数据共享。程序设计的实践中，编程接口的设计首先要使软件系统的职责得到合理划分。良好的接口设计可以降低系统各部分的相互依赖，提高组成单元的内聚性，降低组成单元间的耦合程度，从而提高系统的可维护性和可扩展性。
java开发接口文档模板
竭诚为您提供优质文档/双击可除java开发接口文档模板 篇一：java的接口与实例 一、定义 java接口（interface），是一系列方法的声明，是一些方法特征的集合，一个接口只有方法的特征没有方法的实现，因此这些方法可以在不同的地方被不同的类实现，而这些实现可以具有不同的行为（功能）。 接口定义的一般形式为： [访问控制符]interface{ 类型标识符final符号常量名n=常数； 返回值类型方法名([参数列表]); … } 二、接口的特点 1、java接口中的成员变量默认都是 public,static,final类型的(都可省略),必须被显示初始化,即接口中的成员变量为常量(大写,单词之间用"_"分隔) 2、java接口中的方法默认都是public,abstract类型
的(都可省略),没有方法体,不能被实例化 3、java接口中只能包含public,static,final类型的成员变量和public,abstract类型的成员方法 4、接口中没有构造方法,不能被实例化 5、一个接口不能实现(implements)另一个接口,但它可以继承多个其它的接口 6、java接口必须通过类来实现它的抽象方法 7、当类实现了某个java接口时,它必须实现接口中的所有抽象方法,否则这个类必须声明为抽象类 8、不允许创建接口的实例(实例化),但允许定义接口类型的引用变量,该引用变量引用实现了这个接口的类的实例 9、一个类只能继承一个直接的父类,但可以实现多个接口,间接的实现了多继承. 三、接口的用法 1、精简程序结构，免除重复定义 比如，有两个及上的的类拥有相同的方法，但是实现功能不一样，就可以定义一个接口，将这个方法提炼出来，在需要使用该方法的类中去实现，就免除了多个类定义系统方法的麻烦。举例：鸟类和昆虫类都具有飞行的功能，这个功能是相同的，但是其它功能是不同的，在程序实现的过程中，就可以定义一个接口，专门描述飞行。 下图是分别定义鸟类和昆虫类，其都有飞行的方法。
restfu接口文档模板
XXXX公司接口协议说明书接口协议说明书 受控状态： 发放号： 2017-07-13发布2017-07-13实施
版权说明
修订页
目录 通信协议说明书 (1) 目录 (4) 1引言 (5) 1.1Restful介绍 (5) 2中心服务器与播放控制器间通信协议 (5) 2.1概述 (5) 2.2用户管理 (5) 2.2.1登录 (5)
1引言 1.1Restful介绍 REpresentational State Transfer (REST) 是一种架构原则，其中将web 服务视为资源，可以由其URL 唯一标识。RESTful Web 服务的关键特点是明确使用HTTP 方法来表示不同的操作的调用。REST 的基本设计原则对典型CRUD 操作使用HTTP 协议方法：POST - 创建资源GET - 检索资源PUT –更新资源DELETE - 删除资源. REST 服务的主要优势在于：它们是跨平台(Java、.net、PHP 等）高度可重用的，因为它们都依赖基本HTTP 协议。它们使用基本的XML/JSON，而不是复杂的SOAP XML，使用非常方便。 2中心服务器与播放控制器间通信协议 2.1概述 云平台中心服务器与播放控制器间的通信采用restful通信协议框架，云平台作为restful服务器，播放控制器作为restful客户端。 登录 2.2用户管理 2.2.1登录 2.2.1.1请求API POST /api/v1/login 2.2.1.2请求参数描述 2.2.1.3请求参数示例 { "account": "admin", "password": "md5(admin)" }
开心网API接口说明文档
开心网API接口说明文档 以下是为大家整理的开心网ApI接口说明文档的相关范文，本文关键词为开心,ApI,接口,说明,文档,oauth,认证,获取,授权，您可以从右上方搜索框检索更多相关文章，如果您觉得有用，请继续关注我们并推荐给您的好友，您可以在综合文库中查看更多范文。 1.oauth认证 ①获取未授权的Requesttoken 需要第三方应用程序的ApIKey和ApIsecrect才能在相应的接口地址申请未授权的Requesttoken。ApIKey和ApIsecrect是第三方应用与
开心网申请获得的，在使用Kaixin_android_sdk之前，先要把/kaixin_android_sdk/src/com/kaixin/connect/Kainxin.java中的consumeR_KeY和consumeR_secRecT替换成为你申请的ApIKey和ApIsecretKey。示例代码： Kaixinkaixin=Kaixin.getInstance();Try{ //获取未授权的RequestToken If(kaixin.getRequsetToken(context,”….”)){uriuri= uri(Kaixin.Kx_AuThoRIZe_uRL+”?oauth_token”+kaixin,getRequestToken() ); startActivity(newIntent(…),uri);}} ApI提供了获得未授权的RequestToken的方法，就是getRequestToken();传两个参数，第一个是当前的上下文，第二个是callbackuRL(重定向的uRL地址)。返回类型是boolean值，false就是没有申请成功。 ②请求用户授权RequestToken uri中的保存的是请求用户授权的接口地址。 （1）此页面中会要求用户登录，然后选择同意或者拒绝对应用授权。（2）授权成功后: A:web应用会重定向到oauth_callback所指定的uRL（含返回参数）b:客户端应用(oauth_callback=oob)会在网页中给出授权码，用户需要手工将验证码输入到应用中才能完成授权流程。
ISO26262 开发接口协议DIA
Development Interface Agreement - DIA
1 Table of Contents 1T ABLE OF C ONTENTS (2) 2R EVISION H ISTORY (3) 3I NTRODUCTION (4) 3.1G ENERAL OVERVIEW (4) 3.2A BOUT THIS DOCUMENT (4) 3.3A BBREVIATIONS (4) 4R EFERENCES (6) 5B ACKGROUND TO DIA (7) 6R EFERENCE TO NDA (7) 7P ROCESSES (7) 8W ORK P RODUCTS (7) 9R ESPONSIBILITIES (8) 10I NTERFACES (8) 10.1M ILESTONES (9) 11C OMBINED ACTIVITIES (9) 11.1C OMBINED CONFIRMATION REVIEWS (9) 11.2P LANNING OF S AFETY A SSESSMENTS (9) 12C OMMUNICATION (9) 13R ESPONSIBILITIES AFTER SOP (9)
2 Revision History Blue text in italic is information/explanation directed to the issuer of the document.Before releasing the Work Product (document) all blue italic text must be removed. Mark unused sections of this document as “NOT APPLICABLE”, do not remove the paragraph heading. Text marked with a
软件开发设计文档模板
软件文档编写指南 封面格式： 文档编号 版本号 文档名称： 项目名称： 项目负责人： 编写年月日 校对年月日 审核年月日 批准年月日 开发单位 系统规约说明书（System Specification） 一．引言 A.文档的范围和目的 B.概述 1．目标 2．约束 二．功能和数据描述 A.系统结构 1．结构关系图 2．结构关系图描述 三．子系统描述 A.子系统N的结构图规约说明 B.结构字典 C.结构连接图和说明 四．系统建模和模拟结构 A.用于模拟的系统模型
B.模拟结果 C.特殊性能 五．软件项目问题 A.软件项目可行性研究报告 B.软件项目计划 六．附录 软件项目可行性研究报告（Report for Feasibility Study） 一．引言 1．编写目的（阐明编写可行性研究报告的目的，指出读者对象） 2．项目背景（应包括：（1）所建议开发的软件名称；（2）项目的任务提出者、开发者、用户及实现单位；（3）项目与其他软件或其他系统的关系。） 3．定义（列出文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．可行性研究的前提 1．要求（列出并说明建议开发软件的基本要求，如（1）功能；（2）性能；（3）输出；（4）输入；（5）基本的数据流程和处理流程；（6）安全与保密要求；（7）与软件相关的其他系统；（8）完成期限。） 2．目标（可包括：（1）人力与设备费用的节省；（2）处理速度的提高；（3）控制精度和生产能力的提高；（4）管理信息服务的改进；（5）决策系统的改进；（6）人员工作效率的提高，等等。） 3．条件、假定和限制（可包括：（1）建议开发软件运行的最短寿命；（2）进行系统方案选择比较的期限；（3）经费来源和使用限制；（4）法律和政策方面的限制；（5）硬件、软件、运行环境和开发环境的条件和限制；（6）可利用的信息和资源；（7）建议开发软件投入使用的最迟时间。） 4．可行性研究方法 5．决定可行性的主要因素 三．对现有系统的分析 1．处理流程和数据流程 2．工作负荷 3．费用支出（如人力、设备、空间、支持性服务、材料等项开支。） 4．人员（列出所需人员的专业技术类别和数量。） 5．设备 6．局限性（说明现有系统存在的问题以及为什么需要开发新的系统。） 四．所建议技术可行性分析 1．对系统的简要描述 2．处理流程和数据流程 3．与现有系统比较的优越性 4．采用建议系统可能带来的影响 （1）对设备的影响 （2）对现有软件的影响