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
（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[]格式，返回给调用方。