app接口文档模板

美团外卖回调接口说明文档

美团
回调API使用式样书
第0.4版
2015年9月18日
案例
A:美团外卖
1，推送订单API,
2，美团用户或客服取消API,
3，美团用户或客服退款流程操作API.
B:门店
1,获取门店订单详情API,
2,确认订单已经下载API,
3,获取申请退款信息API.
目录
一、接口说明 (3)
1．推送订单API (3)
2. 获取门店订单详情 (5)
3. 确认订单已经下载 (7)
4.用户或客服取消订单API (7)
5.美团用户或客服进行退款流程操作 (8)
6.商家获取申请退款信息 (8)
一、接口说明
1．推送订单API
①post的Content-Type字段为text，所有参数均为普通post参数，不是json ②美团推送的参数未排序，请将参数排序后再计算sig
2. 获取门店订单详情
3. 确认订单已经下载
4.用户或客服取消订单API
5.美团用户或客服进行退款流程操作
6.商家获取申请退款信息
注：计算签名方式同美团计算签名。

阿里云市场接入大鱼服务API文档

阿里云大鱼服务 API 使用文档 1. 简介本文档描述了阿里云用户开通大鱼服务后可通过开发者平台提供的 API 接口使用大鱼通信服务能力，从而实现短信验用大鱼服务 API 条件如下： ! ! ! ! ! ! 通过阿里云实名认证绑定手机号入驻阿里云开发者平台成为阿里云开发者，平台地址：绑定并激活阿里云账户对应的淘宝账号通过对应支付宝账号的实名认证开通大鱼服务
系统异常返回结果示例 { errorCode: API 调用异常码，如参数出错，流控限制等 errorMessage: API 调用具体异常信息 }
2
阿里云大鱼服务 API 使用文档 5. API 列表短信发送 API 描述
" "
API 英文名：sendSms 向指定手机号码发送模板短信，模板内可设置部分变量。使用前需要在阿里大鱼管理中心添加短信签名与短信模板。测试时请直接使用正式环境请求地址。
3.
安全&Key 服务端针对每次 API 调用都会做安全校验，阿里云开发者在每次 API 调用时需要附带一对 Key 和 Secret。阿里云开发者在开通
大鱼服务后，可以通过创建大鱼应用获取应用对应的 Key 和 Secret，每个应用对应一对 Key 和 Secret。阿里云开发者每次 API 请求都必须附带 Key 和 Secret，详见具体 API 调用示例。
请求结果处理当 API 调用返回的 HTTP Status Code 为 200 时，表示 API 调用成功，请求返回内容即 API 定义的返回结果，请按照具体 API 返回结果示例处理 API 调用结果；当 HTTP Status Code 为非 200 时，表示 API 调用出现系统异常，请按照具体异常信息进行处理。

汉印云打印开放API 接口文档使用说明书

【汉印云打印】开放API接口文档版本(1.1)2018年10月汉印云打印平台.接口文档V1.1目录1.概述： (1)2.打印接口： (1)2.1API接口地址 (1)2.2API请求方式 (1)2.3API调用方法 (1)2.4系统级和应用级的参数 (2)2.5签名加密算法如下： (3)2.6加密示例： (3)2.7需要传递给API的参数是： (3)3.APP调用功能： (4)3.1添加打印机 (4)3.2删除打印机 (5)3.3打印订单 (6)3.4查询打印机状态 (7)3.5查询打印完成情况 (8)4.内容排版标记参数 (10)5.注意事项 (13)6.版本信息： (14)1.概述：汉印云打印平台是以互联网为基础，整合云打印机资源，构建漫游共享的打印平台，向所有用户提供随时随地高质量、标准化的打印服务，包含了云平台、API、云打印服务器、云打印机等，产品广泛应用于快递业、超市、餐饮、社区店、生鲜店等，并致力于成为国内一线互联网云平台。

本文档提供了面向互联网开放的API接口，可有效的实现汉印云打印平台和应用开发者之间的对接，帮助用户和开发者方便地使用云平台的架构和功能。

2.打印接口：本节介绍如何发送数据到汉印云API并通过云平台输出打印指令，以及对应的状态返回码。

2.1API接口地址/api/values2.2API请求方式POST2.3API调用方法发送打印数据到汉印云API请求以及参数应该用POST方法发送。

汉印云API将根据收到的信息验证请求的有效性反馈对应的状态码。

2.4系统级和应用级的参数发送打印数据到汉印云请求必须包含以下参数（系统级参数和应用级参数）。

系统级参数应用级参数2.5签名加密算法如下：Sign=MD5（UserID+PrinterNo+TimeStamp+ApiKey)，串在一起后进行MD5加密然后再转成大写，括号里面的参数只需要传入值。

2.6加密示例：000001hcs100171600521498469357ED93DC463FA44A7F8BD1919AE282C 310这是未加密前串在一起的排列，然后把这串字符进行MD5加密得到的结果就是sign的值Sign=MD5（UserID+PrinterNo+TimeStamp+ApiKey)2.7需要传递给API的参数是：UserID、PrinterNo、TimeStamp这3个参数是需要提交给API的。

APP开发规范APP接口开发规范文档V10

APP开发规范APP接口开发规范文档V10 APP开发规范APP接口开发规范文档V101.概述本文档旨在规范APP接口开发流程，确保开发人员按照统一的规范进行接口开发，提高开发效率和代码质量。

2.接口定义2.1接口命名接口命名应具有描述性，采用小写字母和下划线的组合。

例如：get_user_info。

2.2接口路径接口路径应具有语义化，采用RESTful风格，使用英文单词和斜杠的组合。

例如：/api/users。

2.3请求方法常用的HTTP请求方法有GET、POST、PUT、DELETE。

根据接口的功能和业务需求选择合适的请求方法。

3.请求与响应3.1请求参数接口的请求参数应使用POST、PUT等方法发送，尽量避免使用GET方法传递敏感信息。

3.2响应格式接口的响应应使用JSON格式返回，同时应该包含状态码、状态信息和数据。

例如：```"code": 200,"message": "success","data":"user_id": 123,"username": "test"}```4.接口设计4.1接口功能接口应具有明确的功能，实现单一的业务逻辑，并且避免实现过多的复杂逻辑。

4.2接口权限接口应根据用户的权限进行访问控制，通过合适的认证方式确保只有经过授权的用户可以访问敏感接口。

4.3接口版本为了保持接口的兼容性，应该为每个接口定义一个版本号，将版本号添加到接口路径中。

例如：/api/v1/users。

5.异常处理5.1错误码5.2错误提示接口应提供清晰的错误提示，将错误码和错误信息返回给客户端，以便于客户端进行错误处理。

6.安全性6.1数据加密敏感数据在传输过程中应该使用合适的加密算法进行加密，确保数据的安全性。

6.2参数校验接口应对参数进行校验，避免输入非法参数导致的安全漏洞。

聚合云数据开放平台API接口文档 V1.0

类型 int string int string int
说明返回码返回说明返回结果集分类ID 分类名称父类ID，0则为一级分类
返回码
名称 101 200
说明 appKey错误成功的返回
备注
2ML http请求：POST/GET
40
7.2、暂停基金
40
7.2.1、暂停申购的基金
40
7.2.2、暂停赎回的基金
41
7.3、重仓股基金
41
7.3.1、重仓股基金
41
7.4、基金财务数据
42
7.4.1、主要财务指标
42
7.4.2、基金规模
43
7.4.3、资产配置
43
1、基站数据
1.1、移动联通基站
1.1.1、查询基站数据基本信息
是否必须是是否
key
string
是
说明小区号基站号传递的LAC/CELL进制类型 ,十进制：10 十六进制：16 默认：10 APPKEY
返回参数
名称 resultcode reason data LAC CELL LNG LAT O_LNG
O_LAT
PRECISION
ADDRESS
类型 int string string string string string string
请求参数
名称 key fid
dtype
类型 string string
string
是否必须是否
否
说明应用APPKEY(应用详细页查询) 分类父ID，默认空，即全部分类，否则返回指定分类下的子类返回数据的格式,xml或json ，默认json

开心网开放API说明文档

开心网开放API 说明文档V1.02011-01-14开心网开放API说明文档开放API是开心网为第三方开发者提供的一组功能强大的外部接口，它支持Java、PHP、.NET等多种编程语言。

借助开放API，第三方开发者可以在开心网平台上方便的开发组件或实现连接功能。

一、已开放的API列表开心网开放平台API是采用REST基础的接口规范。

所有的开心网开放平台API都是通过HTTP POST向/api/rest.php发送请求来实现的。

用户信息调用接口（users API）●身份信息调用接口（users.getInfo）：获取已安装本组件的某一用户的身份信息，包括UID、姓名、性别、头像以及该用户是否在线；●UID调用接口（users.getLoggedInUser）：获取当前用户（正在使用该组件的用户）的UID；●组件用户判断接口（users.isAppUser）：判断某一用户是否安装了本组件；●获取调用开心币接口verify（users.getEncodeSessionKey）：获取调用开心币接口需要的verify参数；●邀请成功的好友UID接口（users.getInvitationSucList）：获取某用户邀请成功的好友UID列表。

好友信息调用接口（friends API）●好友列表调用接口（friends.get）：获取当前登录用户的好友UID列表；●好友身份信息调用接口（friends.getFriends）：获取当前登录用户的好友身份信息，包括UID、姓名、性别、头像以及该用户是否在线；●添加了当前组件的好友调用接口（friends.getAppFriends）：获取添加了当前组件好友的UID列表。

功能调用接口（actions API）●好友动态调用接口（actions.sendNewsFeed）：发送好友动态接口，即把组件内的动态发送给全部开心网好友；●系统消息调用接口（actions.sendSysNews）：发送系统消息接口，即把组件内的信息通过系统消息发送给部分开心网好友；●好友邀请调用接口（actions.sendInvitation）：发送组件邀请接口，即以系统消息的形式从组件内发出邀请，邀请好友添加该组件。

【微信支付】APP支付(Android)接口文档V3

微信 APP 支付接口文档 V3
（Android ） APP 支付接口文档支付接口文档（ Android） V3
信支付简介................................................................................................................................4 1.1 功能简介............................................................................................................................. 4 1.2 平台帐号注册..................................................................................................................... 4 1.2.1 申请流程指引图...................................................................................................... 4 1.2.2 申请接入步骤详细说明......................................................................................... 4 1.3 支付账户............................................................................................................................. 5 2.微信 APP 支付接入.......................................................................................................................6 2.1 系统架构............................................................................................................................. 6 2.2 基本交互............................................................................................................................. 7 2.3 支付功能开发介绍............................................................................................................. 7 3.接口介绍........................................................................................................................................8 3.1.接口调用规则..................................................................................................................... 8 3.2.Sign 签名生成方法.............................................................................................................8 3.3.代码实例............................................................................................................................. 9 4.API 说明...................................................................................................................................... 11 4.1.统一支付接口................................................................................................................... 11 4.2.通用通知接口................................................................................................................... 12 4.3.订单查询接口................................................................................................................... 14 4.4. APP 端开发说明.............................................................................................................. 16 4.4.1 初始化设置............................................................................................................ 16 4.4.2 注册您的 APPID................................................................................................... 17 4.4.3 用服务器返回的参数调起支付............................................................................ 17

收银系统开放接口文档v1.2.1

收银系统开放接口文档(V1.2.1)目录收银系统开放接口文档 (1)目录 (2)文档版本更新说明 (4)账号说明 (5)1.下单接口 (5)1.1.接口说明： (5)1.2.参数： (6)1.3.返回字段说明： (8)1.4.返回实例结果： (8)2.APP同步返回接口 (9)2.1.接口说明： (9)2.2.参数： (9)2.3.返回字段说明： (10)2.4.返回实例结果： (10)3.异步通知接口 (11)3.1.接口说明： (11)3.2.参数： (11)3.3.返回字段说明： (12)3.4.返回实例结果： (13)4.订单查询接口 (13)4.1.接口说明： (13)4.2.参数： (13)4.3.返回字段说明： (14)4.4.返回实例结果： (17)5.签名机制 (18)5.1.生成签名字符串sign (18)5.2.签名注意事项 (20)6.附录 (20)6.1.交易状态： (20)6.2.请求错误码 (21)文档版本更新说明账号说明账号作用1.下单接口1.1.接口说明：通过WEB、USB、蓝牙、APP等通讯，调起旺POS收银app，并创建订单，收银app将显示支付页面，等待用户支付使用WEB、USB、蓝牙、APP进行下单时，下单接口本身不提供接口访问地址，只提供接口访问参数，调用者在需要使用下单接口时，需使用平台相关api（详见BP服务端开发文档）及近场通讯协议（USB、蓝牙、APP）并传递此接口的所定义的参数（1.2参数），即可调起旺POS收银app支付页面值得注意的是，当使用APP间调用收银下单接口进行下单时，需要APP将1.2参数进行组装成JSON字符串，并以UTF-8编码成byte[]格式，将此byte[]作为参数项传递给sdk的params参数（详见微POS SDK文档），同时，收银app在支付完成后，也会将相应返回字段组装成JSON字符串，并以UTF-8编码成byte[]格式，返回给调用方。

【微信APP支付】接口文档V1.2_For_IOS

3
[package appendString:"&"]; } [package appendString:"key="]; [package appendString:PARTNERKEY]; // 注意：不能hardcode在客户端，建议genPackage这个过程都由服务器端完成 // 进行md5摘要前，params内容为原始内容，未经过url encode处理 String packageSign = package.md5.uppercaseString; return [NSString stringWithFormat:@"%@&sign=%@",paragramString,packageSigSMutableString *signText = [NSMutableString string]; for (NSString *key in [params allKeys]) { [signText appendString:key]; [signText appendString:@"="]; [signText appendString:[params objectForKey:key]]; [signText appendString:"&"]; } NSString *signResult = signText.sha1; // 注意：不能hardcode在客户端，这个过程都由服务器端完成
参数 appid
traceid noncestr package timestamp app_signature
是否必须是否是是是是
说明应用唯一标识，在微信开放平台提交应用审核通过后获得

系统接口需求：产品经理不一定要写,但一定要会

接口需求：产品经理不一定要写，但一定要会一、为什么产品经理要写接口需求？我目前就职的公司，整个集团的产、研人员多大上千人，业务庞大且复杂。

在这样的环境，当某个需求涉及到与其他业务线有数据上的交互时，需要产品经理经理去调研需求、并输出接口需求文档。

这样的事情，对于像我这样的公司老人来讲，是非常可以理解的。

但是新加入公司或团队的产品，经常会发出一个疑问“为什么产品经理需要写接口需求文档”？在小团队中，业务划分不清晰，所有业务共用一个产、研团队，产品、开发对全局的业务和业务涉及的数据流会比较熟悉。

在这种环境下，假设某个需求的方案，在实现过程中需要基于本业务系统和其他业务系统的数据来实现，就不需要产品经理去写接口需求，开发可基于对需求的理解，自行完成接口的需求梳理和接口的实现。

在大团队中，首先在组织架构上会根据不同的业务线，划分不同的业务部门和不同的产研团队，在这样的组织中，每个业务线的开发一般情况下只负责业务范围内的需求，不会交叉负责其他业务线的需求，从而就会造成不熟悉其他业务线的业务与数据流的现象。

在这种环境下，如某个需求的方案，在实现过程中需要基于本业务系统和其他业务系统的数据来实现，就需要产品经理去调研并输出接口需求。

举个例子：营销团队的某个营销活动，需要基于用户的某些信息去判断用户是否可以参与活动时，就需要营销团队产品经理去了解用户业务的业务、数据、如何获取，并向开发提出接口需求并提供接口需求说明。

据我所了解的情况，很多业务庞大且复杂的公司，产品经理在处理需求的过程中都有可能需要写接口需求：例如：顺丰、金蝶、平安等等。

二、接口的自我介绍大家好，我是你们已经认识很久的好朋友，我的名字叫“接口”。

在平时的工作中，你们经常会讨论到我，并让我帮你解决很多问题。

例如，前端的小姐姐需要查看用户“小明”的姓名、性别、身高、地址等用户信息时，她会将要求先告诉我，然后我会将前端小姐姐的要求转达给后端的小哥哥，待后端小哥哥按要求完成任务之后，我就会将前端姐姐想要的信息告诉她。

美团券对接API文档(20160718162959)

第三方门店ｉｄ１２３４５
第三方门店名海底捞（朝阳门店）
门店所属城市北京
门店所属区域东城区
美团维护的ｐｏｉｉｄ对应表格式：
系统接入方ＸＸＸ
美团门店ｉｄ１２３４５
第三方门店ｉｄ１２３４５
第三方门店名海底捞（朝阳门店）
门店所属城市北京
门店所属区域东城区
后续维护：系统使用期间，如第三方有门店更改、添加，需提交申请给指定美团联系人。
３．３Ｍ３接口：冲正美团券状态接口地址：请求方式：输入参数：返回结果：调用示例：
４Ｑ＆Ａ
１接入步骤
第一步：申请接入，美团创建接入第三方实体，同时给第三方分配接入凭证（ａｐｐ＿ｋｅｙ，ｓｉｇｎ＿ｋｅｙ）第二步：第三方进行系统开发测试，实现美团的验证接口第三步：合作项目上线前，第三方提交一份门店ｉｄ和名字的列表，由美团配置一份两边ｐｏｉｉｄ的对应表列表格式：
２验证流程
３接口设计
３．０说明
３接口设计
３．０说明ຫໍສະໝຸດ ３接口设计３．０说明
３接口设计
３．０说明
３接口设计
３．０说明
３接口设计
３．０说明
３接口设计
３．０说明
３接口设计
３．０说明
美团券验证平台接入文档
１接入步骤２验证流程３接口设计
３．０说明３．０．１ｓｉｇｎ计算方法：３．０．２测试用的ａｐｐ＿ｋｅｙ，ｓｉｇｎ＿ｋｅｙ和美团券密码：
３．１Ｍ１接口：查询美团券信息接口地址：请求方式：输入参数：返回结果：错误码：调用示例：
３．２Ｍ２接口：消费美团券接口地址：请求方式：输入参数：返回结果：错误码：调用示例：

XXX项目APP接口文档首页 (3)首页 (3)加载更多商品 (7)用户注册 (9)注册 (9)发送手机验证码 (11)用户中心 (12)登录 (12)登出 (14)原产品 (15)产品列表 (15)产品详情 (18)分类树 (22)备注： (23)注：传参一律用post方式，key=request, value为一串json格式字符串，格式如：request={"head": {"partner": "xxxxxxxxxxxxxxxxxxxxxxx","key": "xxxxxxxxx","mdkey": "xxxxxxxxxxx"},"para": {"user_name": "user_name","pwd": "123456"},"result": {"start": 0,"count": 10}}head：头信息，用于安全校验，参数固定为partner、key、mdkey 三项，mdkey随不同接口而变，partner和key为常量头部信息校验错误统一返回，错误码分三种：1：PARTNER有误{"head": {"code": "C0004","msg": "PARTNER验证失败！"}}2：KEY有误{"head": {"code": "C0005","msg": "KEY验证失败！"}}3：MD5加密错误{"head": {"code": "C0001","msg": "请求验证失败！"}}para：请求体，客户端请求所需要传入的参数，依据不同接口而定result：结果集，主要用于分页首页首页URL：输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(partner+key)},"result": {"start": 0, //从第0条数据开始，（首页此项参数只能为0）"count": 20 //总共返回20条数据，（即每页显示数量，由客户端自定）}}输入参数说明：错误码：参考头部信息校验统一错误码正确返回：{"head": {"code": "10000","msg": "数据获取成功"},"para": {"banner": [{"ad_id": "2","ad_name": "首页轮转2","pic": "/data/files/mall/ad/1434512150.jpg","link": "/index.php?app=search&act=products&cid=1312","image_size": {"width": 1200,"height": 475}},{"ad_id": "3","ad_name": "首页轮转3","pic": "/data/files/mall/ad/1434523823.png","link": "/joinus/","image_size": {"width": 1200,"height": 475}}……],"cate": [{"cate_id": "1216","cate_name": "女装","cate_ename": "WOMEN","cate_banner": "/data/files/mall/category/2015/06/201506100640272205.jpg","image_size": {"width": 460,"height": 300}},{"cate_id": "1217","cate_name": "男装","cate_ename": "MEN","cate_banner": "/data/files/mall/category/2015/06/201506081359262711.jpg","image_size": {"width": 460,"height": 300}}……],"pic": [{"pic_id": "311","pic_name": "小女孩·柠檬汽水","price": "25.00","pic_url": "/data/files/store_238/pic/2015/06/201506160937045578.jpg", "collects": "1","views": "0","sales": "0","image_size": {"width": 2063,"height": 2063},"love": true //是否关注，true已关注，false未关注},{"pic_id": "314","pic_name": "小女孩·漫漫花事","price": "35.00","pic_url": "/data/files/store_238/pic/2015/06/201506161014059499.jpg", "collects": "1","views": "0","sales": "0","image_size": {"width": 2244,"height": 3488},"love": false}……],"products": [{"product_id": "176","product_name": "三脚猫原创手工皮革染色单肩包手工定制","price": "400.00","image_url": "/data/files/store_90/openshop/product_pic.JPG","collects": "1","views": "0","sales": "0","image_size": {"width": 3000,"height": 3000},"love": true //是否关注，true已关注，false未关注},{"product_id": "2066","product_name": "H.Cstudio 黑白拼色走秀款真丝缎面","price": "499.00","image_url": "/data/files/store_79/product/2015/06/201506150339342394.jpg","collects": "0","views": "0","sales": "0","image_size": {"width": 515,"height": 774},"love": false}……]},"result": {"start": 1,"count": 20}}正确返回码说明：加载更多商品URL：/index.php/index/load_more输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(partner+key)},"result": {"start": 21, //从第21条数据开始"count": 20 //总共返回20条数据，（即每页显示数量）}}返回码描述：错误码：参考头部信息校验统一错误码正确返回：{"head": {"code": "10000","msg": "数据获取成功"},"para": {"products": [{"product_id": "176","product_name": "三脚猫原创手工皮革染色单肩包手工定制","price": "400.00","image_url": "/data/files/store_90/openshop/product_pic.JPG","collects": "1","views": "0","sales": "0","image_size": {"width": 3000,"height": 3000},"love": true //是否关注，true已关注，false未关注},{"product_id": "2066","product_name": "H.Cstudio 黑白拼色走秀款真丝缎面","price": "499.00","image_url": "/data/files/store_79/product/2015/06/201506150339342394.jpg","collects": "0","views": "0","sales": "0","image_size": {"width": 515,"height": 774},"love": false}……]},"result": {"start": 21,"count": 20}}正确返回码说明：用户注册注册URL：/index.php/register/reg输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(mobile+pwd+cpwd+sms_captcha+nick_name+partner+key) },"para": {"mobile": "注册手机号","pwd": "密码","cpwd": "确认密码","sms_captcha": "手机接收的验证码","nick_name": "昵称"}}输入参数说明：返回码描述：错误码：{"head": {"code": "E0003","msg": "注册验证失败"}}{"head": {"code": "E0001","msg": "用户名已存在！"}}{"head": {"code": "E0001","msg": "两次密码不一致"}}正确返回：{"head": {"code": "10000","msg": "恭喜，注册成功！"},"para": {"user_name": "user","phone_mob": "user","nick_name": "oheyou","status": 1,"user_id": 263}}正确返回码说明：发送手机验证码URL：/index.php/register/send_sms_captcha 输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(partner+key)},"para": {"mobile": "用户手机号"}}输入参数说明：返回码描述：错误码：{"head": {"code": "E0005","msg": "手机号码不正确"}}正确返回：{"head": {"code": "10000","msg": "短信发送成功"}}真确返回码说明：用户中心登录URL：/index.php/user/login输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(user_name+pwd+partner+key)},"para": {"user_name": "用户名","pwd": "密码"}}返回码描述错误码：{"head": {"code": "E0003","msg": "用户名或密码错误！"}}正确返回：{"head": {"code": "10000","msg": "登录成功"},"para": {"user_id": "76","user_name": "user","nick_name": "oheyou","gender": "0","im_qq": "0","email":"****************","points": "0","portrait": "/data/files/usr/76/2015/05/201505140448321718.jpg","logins": "0","last_login": "1435226105","follow": "4", //关注数量"fans": "1", //粉丝数量"loves": "12", //喜欢数量（产品，图片，商品）"collects": "0" //店铺收藏数量}}正确返回码说明：登出URL：/index.php/user/login_out 输入参数：request={"head": {"key": "ldingadmin","mdkey": md5(partner+key)}}输入参数说明：返回码描述错误码：无正确返回：{"head": {"code": "10000","msg": "登出成功！"}}正确返回码说明：原产品产品列表URL：/index.php/product 输入参数：request={"head": {"key": "ldingadmin","mdkey": md5(cid+order+partner+key) },"para": {"cid": "分类id","order": "排序",},"result": {"start": "0","count": "20",}}输入参数说明：错误码：参考头部信息校验统一错误码正确返回：{"head": {"code": "10000","msg": "数据获取成功"},"para": [{"product_id": "2073","product_name": "HC STUDIO 黑色羊毛西装裤","add_time": "1434346771","price": "219.00","min_price": "219.00","max_price": "219.00","store_id": "79","store_name": "HC 定制工作室","image_url": "/data/files/store_79/product/2015/06/201506230847457013.png","view": "0", //浏览量"collects": "2", //收藏量"carts": "0", //加入购物车量"orders": "0", //下单量"sales": "0", //销售量"comments": "0", //评论量"love": false //是否喜欢},{"product_id": "2071","product_name": "HC STUDIO 优雅锦缎提花褶半身裙","add_time": "1434346569","price": "249.00","min_price": "249.00","max_price": "249.00","store_id": "79","store_name": "HC 定制工作室","image_url": "/data/files/store_79/product/2015/06/201506190721567528.jpg","view": "0","collects": "0","carts": "0","orders": "0","sales": "0","comments": "0","love": false},……],"result": {"start": 0,"count": 20}}产品详情URL：/index.php/product/detail 输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(product_id+partner+key)},"para": {"product_id": "产品id"},"result": { //用于评价和咨询"start": "0","count": "20",}}输入参数说明：错误码：参考头部信息校验统一错误码正确返回：{"head": {"code": "10000","msg": "数据获取成功"},"para": {"product_id": "134","product_name": "poly~(测试专用)","price": "0.01","default_image_id": "616", //商品主图id"image_url": "/data/files/store_76/openshop/product_pic.jpg", //商品主图地址"content": "啦啦啦啦啦啦", //商品详情"tags": [ //商品标签"连衣裙","雪纺","真丝","飘逸"],"brand_id": null, //商品品牌id"brand_name": null, //商品品牌名称"brand_logo": null,//商品品牌logo"store_id": "75", //店铺id"store_name": "awesome", //店铺名称"store_type": "1", //店铺类别1：个人2：公司"apply_type": "seller", //店铺申请类型seller：供应商designer：设计师"description": null, //店铺简介"store_collects": "0", //店铺收藏量"store_sales": "5", //店铺销售量"views": "0", //商品浏览量"carts": "7", //商品加入购物车量"collects": "2", //商品喜欢量"sales": "6", //商品销售量"comments": "0", //商品评论量"orders": "8", //商品下单量"product_loved": false, //是否喜欢过此商品（用户未登录一律返回false）"store_collected": false,//是否收藏过此店铺（用户未登录一律返回false）"spec_text": [ //商品规格描述{"spec_id": "80","spec_name": "颜色","is_color": "0","values": [{"spec_val_id": "23","sval_text": "白色","spec_val_text": "白色"},{"spec_val_id": "24","sval_text": "红色","spec_val_text": "红色"}]{"spec_id": "77","spec_name": "尺码","is_color": "0","values": [{"spec_val_id": "15","sval_text": "M","spec_val_text": "M"},{"spec_val_id": "16","sval_text": "L","spec_val_text": "L"}]}],"sku": { //商品sku";80:23;77:15;": {"sku_id": "541","price": "0.01","is_show": "1"},";80:23;77:16;": {"sku_id": "542","price": "0.01","is_show": "1"},";80:24;77:15;": {"sku_id": "543","price": "0.01","is_show": "1"},";80:24;77:16;": {"sku_id": "544","price": "0.01","is_show": "1"}},"images_datas": [ //商品其他部位图片地址{"image_url": "/data/files/store_75/product/2015/05/201505190926367050.jpg"{"image_url": "/data/files/store_75/product/2015/05/201505190927329810.jpg"}],"qa": [ //商品咨询数据{"reply_content": " hahahaha ","time_post": "1435200728","nick_name": "oheyou","portrait": "/data/files/usr/76/2015/05/201505140448321718.jpg"}],"comment": "" //商品评论数据（格式如咨询）},"result": {"start": 0,"count": 20}}正确返回码说明：分类树URL：/index.php/product/cate输入参数：request={"head": {"partner": "77b872abfe1260053032219354882d91","key": "ldingadmin","mdkey": md5(partner+key)}}输入参数说明：返回码描述错误码：无正确返回：Json格式分类树正确返回码说明：备注：1000 操作成功。

集装箱号识别接口API对接文档

集装箱箱号识别Android SDK V3.2.2对接文档Baixun CNOCRV3.22By青岛百迅科技文章来源：ocr.top1.1注册AppKey集成集装箱箱号识别SDK之前，您首先需要到CNOCR官网注册，获取appKey、app密钥。

1.2在项目中新建libs文件夹并将baixunOCR-release.aar复制进去。

1.3将assets文件夹复制进main文件夹下。

1.4项目build.gradle添加依赖：api'me.jessyan:autosize:0.9.5'implementation files('libs\\baixunOCR-release.aar')1.5添加分包multiDexEnabled及ndk支持如：defaultConfig{applicationId"com.example.ocrtest"minSdkVersion19targetSdkVersion29versionCode1versionName"1.0"multiDexEnabled trueflavorDimensions"1"testInstrumentationRunner"androidx.test.runner.AndroidJUnitRunner"ndk{abiFilters'armeabi-v7a'}}1.6AndroidManifest.xml中添加代码：<meta-dataandroid:name="design_width_in_dp"android:value="360"/><meta-dataandroid:name="design_height_in_dp"android:value="640"/><meta-dataandroid:name="androidd.max_aspect"android:value="2.1"/>1.7权限说明CNOCR接口SDK，需要照相机和文件存储权限，6.0以上手机请自行动态注册权限。

快递鸟接口技术文档说明书

快递鸟接口(API)技术文档1前言 (5)2接口规范说明 (5)2.1接口规范及说明 (5)2.1.1报文及报文编码 (5)2.1.2接口数据包结构 (5)2.1.3JSON示例 (6)2.1.4系统级参数 (6)2.1.5流程示意图 (7)2.2签名说明 (7)2.2.1关于签名 (7)2.2.2(C#)DataSign签名加密代码 (9)3下单类接口 (10)3.1接入步骤 (10)3.2预约取件接口 (11)3.2.1功能说明 (11)3.2.2基本信息 (11)3.2.3接口规则 (12)3.2.4支持情况 (12)3.2.5应用级参数 (12)3.2.6返回参数 (17)3.3预约取件取消接口 (17)3.3.1功能说明 (17)3.3.2基本信息 (17)3.3.3接口规则 (18)3.3.4支持情况 (18)3.3.5应用场景 (18)3.3.6应用级参数 (18)3.3.7返回参数 (19)3.4电子面单接口 (19)3.4.1功能说明 (19)3.4.2基本信息 (19)3.4.3应用场景 (20)3.4.4接口规则 (20)3.4.6应用场景 (21)3.4.7应用级参数 (21)3.4.8返回参数 (30)3.5电子面单取消接口 (35)3.5.1功能说明 (35)3.5.2基本信息 (36)3.5.3接口规则 (36)3.5.4支持情况 (36)3.5.5应用级参数 (36)3.5.6返回参数 (37)3.6电子面单追加子单接口 (37)3.6.1功能说明 (37)3.6.2基本信息 (37)3.6.3应用级参数 (38)3.6.4返回参数 (38)3.7获取电子面单文件接口 (39)3.7.1功能说明 (39)3.7.2基本信息 (39)3.7.3应用级参数 (39)3.7.4返回参数 (40)4轨迹查询类接口 (42)4.1即时查询接口 (42)4.1.1功能说明 (42)4.1.2基本信息 (42)4.1.3接口规则 (42)4.1.4支持情况 (42)4.1.5应用场景 (42)4.1.6应用级参数 (42)4.1.7返回参数 (43)4.2物流跟踪 (45)4.2.1轨迹订阅接口 (45)4.3单号识别接口 (64)4.3.1功能说明 (64)4.3.2基本信息 (64)4.3.3接口规则 (64)4.3.4应用级参数 (64)4.3.5返回参数 (65)5增值类接口 (66)5.1在途监控-国内版 (66)5.1.1即时查询接口(增值版) (66)5.1.2物流跟踪接口(增值版) (72)5.2快递查询接口 (78)5.2.1功能说明 (78)5.2.2基本信息 (78)5.2.3接口规则 (78)5.2.4支持情况 (78)5.2.5应用场景 (78)5.2.6应用级参数 (78)5.2.7返回参数 (79)5.3在途监控-国际版 (84)5.3.1物流跟踪接口(国际版) (84)5.4物流查询地图接口 (86)5.4.1即时查询接口(地图版) (87)5.4.2物流跟踪接口(地图版) (95)5.5短信服务 (100)5.5.1短信模板接口 (101)5.5.2短信发送接口 (103)5.5.3短信黑名单接口 (105)5.6智能地址解析接口 (106)5.6.1功能说明 (106)5.6.2基本信息 (106)5.6.3应用级参数 (106)5.6.4返回参数 (107)6附录 (109)6.1对接相关资料 (109)6.2电子面单模板规格 (109)6.3返回编码列表 (116)7技术支持 (117)1前言快递鸟API旨在为电商、电商平台、物流工具、打单工具、仓储系统、移动APP等系统提供专业、稳定、优质的API接口服务，满足不同用户的物流管理需求。

聊天软件产品需求文档模板(详细范文)

1. 介绍1.1 产品概述本文档旨在描述一款名为“ChatEase”的聊天软件的需求和功能。

ChatEase是一款为广大用户提供高效、便捷、安全的聊天服务的应用程序。

该应用程序支持多种形式的聊天方式，包括文字、语音、图片和表情等。

ChatEase还提供了好友管理、消息通知和历史记录等功能，以便用户更好地管理和查看聊天记录。

ChatEase的目标是成为用户日常生活中必不可少的聊天工具。

1.2 目标用户ChatEase的目标用户是年龄在18-40岁之间，有一定的社交需求和使用智能手机的能力。

他们可能是学生、上班族、自由职业者或其他职业人士，对于高效便捷的聊天方式有着强烈的需求。

他们可能对于市面上已有的聊天软件不满意，希望寻找一款更加安全、稳定、易用的聊天工具。

ChatEase将致力于满足这一用户群体的需求，提供更好的用户体验和服务。

1.3 市场分析随着智能手机和移动互联网的普及，聊天软件已经成为人们日常生活中必不可少的工具之一。

市场上已经存在了许多知名的聊天软件，如微信、QQ、WhatsApp等。

这些软件已经形成了强大的市场竞争力，但是也存在着一些问题，如隐私泄露、广告干扰等。

ChatEase将致力于解决这些问题，提供更加安全、稳定、易用的聊天工具，以满足用户的需求。

2. 功能需求2.1 用户注册和登录ChatEase应用程序需要提供用户注册和登录功能。

用户可以通过手机号、邮箱或第三方账号进行注册，注册完成后需要进行账号验证。

用户登录后可以查看个人信息、修改密码等。

2.2 好友管理ChatEase应用程序需要提供好友管理功能。

用户可以通过手机号、用户名或扫描二维码添加好友。

添加好友需要对方同意，添加成功后可以进行聊天和分享文件等操作。

用户还可以查看好友列表、删除好友、设置好友备注等。

2.3 聊天功能ChatEase应用程序需要提供聊天功能，支持文字、语音、图片和表情等多种聊天方式。

用户可以在聊天窗口中发送消息、查看对方发送的消息、撤回消息等。

软件开发技术设计文档模板

1. 引言1.1 设计背景在快节奏的大学日常生活中，社交软件已经成为大家日常必不可少的一部分，普通大学生的朋友圈和QQ空间等社交软件平台上，经常能够看到有人发送寻物启事、或是拾到他人丢失物品的拾主找寻丢失它的失主的某些消息。

大学日常生活中，大部分人都会有曾经丢过东西的经历，无论大小。

那如果一旦丢失了一些对我们比较重要的东西呢？譬如带有重要资料的U盘、随身携带的耳机、出入图书馆会用到的校园卡、身份证、夹着银行卡的钱包等等，无论是马虎大意还是因为焦急匆忙，那些“求扩！”、“急寻！”、“大家帮帮忙！”的字眼都着实能够让人感受到失主的焦急与无奈。

但是，由于好友人数的限制或是群人数的限制，大家往往会通过转发多个群或者请求好友扩散的方式来散播讯息。

这种方法有着很大的弊端，首先是可见的人群少，只能自己的好友可见或者群内可见，这会使消息传递的比较缓慢，对于急于找到的东西造成了一定的时间浪费。

其二，这还会浪费网络资源，也会把相对重要的信息顶替，对社交平台这个娱乐的环境造成一定的干扰，在如此环境下，本团队希望开发一个能够方便同学们生活的校园app，本app暂时基于Android系统，用于帮助同学发布与接收失物的讯息。

1.2 编写目的基于我们学校非常普遍的丢失物品现象，我们团队想要去一个平台能够帮助大家快速将信息集合起来，尽最大可能地使大家快速寻找到自己在校园内丢失的物品，并且能够将捡到的东西及时还给失主。

2. 软件支持3.总体功能概述3.1 功能总体需求3.2应用技术以tomcat8.0搭建服务器，Mysql作为数据库支持，Android开发的APP 界面作为交互界面，使用前后端完全分离开发的框架MVC，在controller控制器部分，使用Java语言作为后端开发语言，使用sevlet搭建控制层的数据传输流，利用Hirbernate框架实现数据库的增删该查功能，其中图片上传的部分，利用Volley框架实现，首先将图片上传到服务器端，写好该图片的目录字段存储在数据库中，实现图片的存储显示。

App-注册中心接口文档

功能说明添加商户信息URL格式JSONHTTP请求方式POST请求参数新的字段旧的字段必选类型及范围说明placeName place_name 1 string商户名称agentid agentid 1 string 代理商idmnetsiteType m_netsite_type 1 int 商户服务类型1 snetsiteType s_netsite_type 1 int 商户服务类型2 businessNature business_nature 1 int 经营性质lawPrincipalName law_principal_name1 string 商户经营法人relationshipAccount relationship_account1 string 联系电话lawPrincipalCertificateType law_principal_certificate_type1 string 法人有效证件类型lawPrincipalCertificateId lawPrincipalCertificateId1 string 法人有效证件号startTime start_time 1 string营业开始时间endTime end_time 1 string营业结束时间新的字段旧的字段必选类型及范围说明provinceCode province_code 1 int所在地区省cityCode city_code 1 int所在地区市areaCode area_code 1 int所在地区区policeid policeid 1 int派出所idlongitude longitude 1 string经度latitude latitude 1 string纬度accessType access_type 1 int接入方式operatorNet operator_net 1 int服务商acssesIp acsses_ip 1 string固定ipsiteAddress site_address 1 string详细地址devtypeid devtypeid 1 string设备型号deviceClassify device_classify 1 int设备分类sdmac sdmac 1 string设备mac 字段说明返回值字段字段类型字段说明res boolean 结果error String 失败原因 if（res == false）功能说明编辑商户信息URL格式JSONHTTP请求方式POST请求参数新的字段旧的字段必选类型及范围说明id Id 1 int商户idplaceName place_name 1 string商户名称agentid agentid 1 string 代理商id mnetsiteType m_netsite_type 1 int 商户服务类型1 snetsiteType s_netsite_type 1 int 商户服务类型2 businessNature business_nature 1 int 经营性质lawPrincipalName law_principal_name 1 string商户经营法人relationshipAccount relationship_account 1 string联系电话lawPrincipalCertificateTy pe law_principal_certificate_type1 string 法人有效证件类型lawPrincipalCertificateId lawPrincipalCertificateId1 string 法人有效证件号startTime start_time 1 string营业开始时间endTime end_time 1 string营业结束时间新的字段旧的字段必选类型及范围说明provinceCode province_code 1 int所在地区省cityCode city_code 1 int所在地区市areaCode area_code 1 int所在地区区policeid policeid 1 int派出所idlongitude longitude 1 string经度latitude latitude 1 string纬度accessType access_type 1 int接入方式operatorNet operator_net 1 int服务商acssesIp acsses_ip 1 string固定ipsiteAddress site_address 1 string详细地址字段说明返回值字段字段类型字段说明res boolean 结果error String 失败原因 if（res == false）URL格式JSONHTTP请求方式GET请求参数必选类型及范围说明unit_id 1 int 商户id返回字段说明返回值字段字段类型字段说明resunit_detail json 结果（查出商户的所有字段）service_type json 服务类型表所有信息region json 所在区域所有信息polices json 派出所表所有信息证件类型表接入方式表服务商表URL格式JSONHTTP请求方式GET请求参数无返回字段说明字段说明旧返回值字段字段类型service_type json 服务类型表所有信息region json 所在区域所有信息polices json 派出所表所有信息证件类型表接入方式表服务商表功能说明显示绑定设备页面接口URL格式JSONHTTP请求方式GET请求参数新的字段旧的字段必选类型及范围说明unit_id 1 int 商户id 返回字段说明旧返回值字段字段类型字段说明collection_equipment_typejson 服务型号表所有内容功能说明绑定设备接口URL格式JSONHTTP请求方式POST请求参数新的字段旧的字段必选类型及范围说明unit_id 1 int 商户idsdmac 1 String MACcollection_equipment_type1 设备类型返回字段说明返回值字段字段类型字段说明返回值字段res boolean 结果 True or false error String 失败原因 if（res == false）功能说明显示解绑设备页面接口URL格式JSONHTTP请求方式GET请求参数新的字段旧的字段必选类型及范围说明unit_id 1 int 商户idsdmac 1 String 设备mac 返回字段说明旧返回值字段字段类型字段说明unit_name string 商户名称功能说明解绑设备接口URL格式JSONHTTP请求方式POST请求参数新的字段旧的字段必选类型及范围说明unit_id 1 int 商户idsdmac 1 String MACunit_name 1 String 商户名称collection_equipment_type1 设备类型返回字段说明返回值字段字段类型字段说明返回值字段res boolean 结果reserror String 失败原因 if（res == false）。

PRD文档模板

版本号TOP接入系统(Taobao IntergrationPlatform)产品需求说明书编写人：黑羽编写时刻：2020/1/20修改记录：确认签字：目录1概述............................................................................................................ 错误!未定义书签。

名词说明............................................................................................... 错误!未定义书签。

产品概述及目标................................................................................... 错误!未定义书签。

产品roadmap........................................................................................ 错误!未定义书签。

产品风险............................................................................................... 错误!未定义书签。

2利用者需求................................................................................................ 错误!未定义书签。

需求描述............................................................................................... 错误!未定义书签。