当前位置：文档库 › 财付通API接口文档样例代码

财付通API接口文档样例代码

引言

文档概述

本文描述了财付通开放平台的JAVA SDK，帮助开发者轻松实现在线支付、收付款等功能。文档详细介绍了财付通开放平台的工作方式和开发过程，可以帮助开发人员快速入门并掌握开发技能，同时也可以作为日后接口参数以及参数类型的速查手册。

阅读对象

具有WEB程序开发背景，了解JAVA语言。

业务术语

术语说明

ISV 独立软件供应商/ Independent Software Vendor，可以是商户、个人或者第三方中介开发者

财付通APP 指ISV使用财付通开放平台SDK开发的WEB应用程序，运行于第三方服务器上为最终用户提供服务

商户指财付通的商户，商家可以是ISV。

开放平台财付通提供给ISV的开发注册、应用管理、沙箱测试平台。

最终用户指通过财付通开放平台使用财付通APP的财付通用户

接口业务流程

支付流程

支付流程中，用户在财付通APP中购买业务，通过财付通支付平台进行支付。典型业务流程如下：

买家在财付通APP上浏览下单购买一个商品，财付通APP会生成一个支付链接，此链接通过用户的浏览器跳转到财付通开放平台，财付通通过此链接获取支付请求的参数，引导用户完成支付过程。

用户在财付通完成支付后，财付通通过return_url将用户浏览重新定向到财付通APP，财付通APP 向用户提示订单状态和后续操作。同时，财付通会通过后台回调财付通APP的notify_url，财付通APP在收到支付结果通知后可以根据通知ID查询通知内容，在确保支付成功后再进行业务逻辑处理（例如发货），这样可以进一步提高安全性，防止伪支付成功结果的诈骗。

通知查询/订单查询流程

通知查询/订单查询是指财付通APP向财付通系统发送查询请求，并同步等待财付通系统处理完毕后返回的响应数据。数据交互是财付通APP与财付通服务器直接通信。

例如用户在财付通APP查询时，财付通APP要确认用户某个订单是否支付成功，可以向财付通发送一个查询请求，财付通收到请求后返回查询结果，财付通APP处理结果后再显示给用户。

后台通知流程

后台通知是指财付通系统主动向财付通APP发送通知数据，并同步等待财付通APP处理完毕后返回的响应数据。数据交互是财付通服务器与财付通APP直接通信，一般请求采用http的get或post，应答用字符串格式。

用户在财付通支付成功后，财付通会在后台通过notify_url向财付通APP发起通知，财付通APP 处理后成功返回success，失败返回fail或其他字符。

补单机制

对后台通知流程，如果财付通收到财付通APP的应答不是success或由于网络异常超时，财付通认为通知失败，财付通会通过一定的策略（如1分钟、2分钟、4分钟、8分钟、16分钟、32分钟，共6次）定期重新发起通知，尽可能提高通知的成功率，但财付通不保证通知最终能成功。

由于上述原因，可能存在同样的通知多次发送给财付通APP的情况。财付通APP必须能够正确处理，在收到重复的后台通知不重复引发业务流程（例如发货）。

财付通推荐的做法是，当收到财付通发送的通知消息时，需要检查本系统内订单的状态，判断该通知是否已经处理过。为防止并发产生的问题，在对业务数据进行状态检查和处理之前，要求采用加锁判断进行并发控制。

功能划分

财付通APP负责与之业务相关的代码和页面。

财付通开放平台提供支付相关的业务功能和页面。具体业务功能请参照后面章节SDK说明

支付页面如下：

在小钱包中：

在普通浏览器中：

SDK说明

概述

API说明

类名说明

com.tenpay.api.PayRequest 支付请求

com.tenpay.api.PayResponse 支付响应

com.tenpay.api.OrderQueryRequest 订单查询请求

com.tenpay.api.OrderQueryResponse 订单查询响应

com.tenpay.api.NotifyQueryRequest 通知查询请求

com.tenpay.api.NotifyQueryResponse 通知查询响应

com.tenpay.api.ShareLoginState 共享登录用户信息

共享登录用户信息接口：

1用户跳转到应用时，初始化ShareLoginState对象,ShareLoginState.getUserId()即可获得当前用户的id

支付接口，常见开发步骤如下：

2初始化请求对象PayRequest

3设置请求系统级参数（应用ID等），例如PayRequest.setAppid(应用ID)

4设置请求业务级参数，例如PayRequest.setParameters(参数名称, 参数值)

5生成跳转URL，例如PayRequest.getURL()

6将用户重定向到跳转URL，例如Servlet/JSP中的重定向方法response.sendRedirect()或用Javascript进行页面跳转

通知查询或订单查询，常见开发步骤如下：

7初始化请求对象，例如NotifyQueryRequest或OrderQueryRequest

8设置请求系统级参数（应用ID等），例如NotifyQueryRequest.setAppid(应用ID)

9设置请求业务级参数，例如NotifyQueryRequest.setParameters(参数名称, 参数值)

10通过NotifyQueryRequest.send()方法将请求发送到接口并获得响应对象，例如NotifyQueryResponse response = NotifyQueryRequest.send()

11判断订单支付状态，例如NotifyQueryResponse.isPaySuccessful()

12从响应对象中获取参数值，进行相应处理，例如NotifyQueryResponse.getParameter(参数名) 后台通知交互模式，常见开发步骤如下：

13构造一个Servlet或JSP接收开放平台的回调

14初始化响应对象PayResponse

15判断订单支付状态，例如PayResponse.isPaySuccessful()

16从响应对象中获取参数值，进行相应处理，例如PayResponse.getParameter(参数名)

调用过程

支付类

支付跳转

·业务功能

买家在财付通APP中下订单后付款，财付通APP调用财付通开放平台支付接口生成支付URL，页面跳转到财付通支付中心或银行。用户完成支付后，财付通把用户引导回财付通APP指定的页面（return_url），并通过回调支付请求中的notify_url反馈支付结果。

·接口调用方向

开发者开发应用调用财付通开放接口

·请求

com.tenpay.api.NotifyQueryRequest 通知查询请求

方法列表

/**

* 构造方法

* @param secretKey

public NotifyQueryRequest(String secretKey);

/**

* 设置应用ID

* @param appid

* 应用ID

public void setAppid(String appid);

/**

* 设置是否在沙箱环境

* @param inSandBox

* true表示请求发送到沙箱环境，false表示请求发送到正式环境*/

public void setInSandBox(boolean inSandBox);

/**

* 设置业务参数

* @param key

* 参数名称

* @param value

* 参数值

public void setParameter(String key, String value);

/**

* 调用开放平台接口发送请求，获取响应

* @return 接口调用的返回结果

* @throws Exception

public CommonResponse send() throws Exception;

参数名称详见下表

参数名称必填类型说明

notify_id 是String(64

)

支付成功后，财付通系统反馈的通知ID此参数来源详见3.1.2.5章节参数列表

中的notify_id

sign_key_index 否Int 多密钥支持的密钥序号，默认1

sign_type 否String(8) 签名类型，取值：MD5、RSA，默认：MD5，暂只支持MD5

service_version 否String(8) 版本号，默认为1.0

·返回结果

com.tenpay.api.NotifyQueryResponse通知查询响应

方法列表

/**

* 判断支付结果

* @return true表示支付成功，false表示支付处于其他状态，需要调用getPayInfo()方法获取详细说明

public boolean isPaySuccessful();

/**

* 获取支付结果信息

* @return 支付结果说明

public String getPayInfo();

/**

* 获取响应参数

* @param key 参数名称

* @return 参数值

public String getParameter(String key);

参数名称详见下表

参数名称必填类型说明

total_fee 是Int 用户实际支付的金额，单位为分，如果discount有值，通知的total_fee + discount = 请求的total_fee

transaction_id 是String(2

财付通交易号

out_trade_no 是String(3

财付通APP系统的订单号，与请求一致。

time_end 是String(1

支付完成时间，格式为yyyymmddhhmmss，如2009年12月27日9点10分10秒

表示为20091227091010。时区为GMT+8 beijing。该时间取自财付通服务器

input_charset 否String(8) 字符编码,取值：GBK、UTF-8，默认：GBK。

sign_key_inde

否Int 多密钥支持的密钥序号，默认1

attach 否String(6

商家数据包，原样返回

bank_type 否String(1

银行类型，默认为“DEFAULT”－财付通，其余参照第4.1节银行编码

fee_type 否Int 现金支付币种,目前只支持人民币,默认值是1-人民币

transport_fee 否Int 物流费用，单位分，默认0。如果有值，必须保证transport_fee + product_fee = total_fee

product_fee 否Int 物品费用，单位分。如果有值，必须保证transport_fee + product_fee=total_fee discount 否Int 折扣价格，单位分，如果有值，通知的total_fee + discount = 请求的total_fee

buyer_alias 否String(6

对应买家账号的一个加密串

sign_type 否String(8) 签名类型，取值：MD5、RSA，默认：MD5，暂只支持MD5 ·样例

// 应用ID

String appid = "0000000155";

// 密钥

String secretKey = "123456";

// 是否沙箱测试

boolean isSandBox = true;

// 初始化通知查询请求

NotifyQueryRequest request = new NotifyQueryRequest(secretKey);

request.setAppid(appid);// 设置应用ID

request.setInSandBox(isSandBox);// 请求发送到沙箱

// 设置业务参数

request.setParameter("notify_id", "xxxxxxxxxxxxxxx");// 通知查询ID，此ID来源于支付之后的回调

try {

// 发起接口调用

NotifyQueryResponse response = request.send();

if (response.isPaySuccessful()) {

// 支付成功

// 处理业务逻辑

// ......

} else {

// 支付处于其他状态

System.out.println(response.getPayInfo()); // 获取详细状态说明

}

} catch (Exception e) {

// 异常处理

}

订单查询

·业务功能

根据商户订单号或者财付通订单号查询财付通侧记录的具体订单信息。

·接口调用方向

开发者开发应用调用财付通开放接口。

·请求

com.tenpay.api.OrderQueryRequest订单查询请求

方法列表

/**

* 构造方法

* @param secretKey

public OrderQueryRequest(String secretKey);

/**

* 设置应用ID

* @param appid

* 应用ID

public void setAppid(String appid);

/**

* 设置是否在沙箱环境

* @param inSandBox

* true表示请求发送到沙箱环境，false表示请求发送到正式环境*/

public void setInSandBox(boolean inSandBox);

/**

* 设置业务参数

* @param key

* 参数名称

* @param value

* 参数值

public void setParameter(String key, String value);

/**

* 调用开放平台接口发送请求，获取响应

* @return 接口调用的返回结果

* @throws Exception

public CommonResponse send() throws Exception;

参数名称详见下表

参数名称必填类型说明

out_trade_no

二者必

填

其一String(3

财付通APP内部的订单号, out_trade_no和transaction_id至少一个必填，同

时存在时transaction_id优先

transaction_id String(2

财付通交易号, out_trade_no和transaction_id至少一个必填，同时存在时

transaction_id优先

sign_key_inde

否Int 多密钥支持的密钥序号，默认1

sign_type 否String(8) 签名类型，取值：MD5、RSA，默认：MD5，暂只支持MD5 service_versio

否String(8) 版本号，默认为1.0

·返回结果

订单查询返回结果与通知查询返回结果相同，参见“通知验证返回结果”

·样例

// 签名密钥: 开发者注册时，由财付通分配

String secretKey = "64507558218450442324574381315452";

// 初始化订单查询请求

OrderQueryRequest req = new OrderQueryRequest(secretKey);

// 设置在沙箱中运行:正式环境请设置为false

req.setInSandBox(true);

// 设置财付通App-id

req.setAppid("0000000201");

// 设置财付通App订单号:财付通APP的订单号

req.setParameter("out_trade_no", "test000000001");

// 发送请求，并获取返回对象

OrderQueryResponse res = req.send();

if (res.isPayed()) {// 已经支付

// 已经支付财付通app订单号

System.out.println("支付成功，应用订单号：" + res.getParameter("out_trade_no"));

// 财付通app订单号对应的财付通订单号

System.out.println("财付通订单号:" + res.getParameter("transaction_id"));

// 支付金额，单位：分

System.out.println("支付金额:" + res.getParameter("total_fee") + "分");

// 支付完成时间,格式为yyyymmddhhmmss,如20091227091010

System.out.println("支付完成时间:" + res.getParameter("time_end"));

}

else {// 未正常支付，或者调用异常，如调用超时、网络异常

System.out.println("支付未成功状态说明:" + res.getPayInfo());

}

其他类

共享登录

·业务功能

买家转到APP中时，系统将买家的ID传入APP，方便用户订单生成、用户状态更新等相关操作。

·交互模式

买家点击跳转到APP时，id等相关信息将签名后通过url一起发往APP。

·样例

// 签名密钥: 开发者注册时，由财付通分配

String secretKey = "64507558218450442324574381315452";

//创建共享登陆态对象

ShareLoginState state = new ShareLoginState(req, secretKey);

// 获取用户id

String userID = state.getUserId();

枚举类型

银行编码

编码含义说明DEFAULT 财付通，支持的各类支付方式包括（银行，财付通账户，一点通等）

ICBC 中国工商银行支持信用卡CMB 招商银行支持信用卡CCB 中国建设银行支持信用卡ABC 中国农业银行支持信用卡SPDB 上海浦东发展银行支持信用卡SDB 深圳发展银行支持信用卡CIB 兴业银行不支持信用卡BOB 北京银行支持信用卡CEB 中国光大银行支持信用卡CMBC 中国民生银行支持信用卡CITIC 中信银行支持信用卡GDB 广东发展银行支持信用卡PAB 平安银行支持信用卡BOC 中国银行支持信用卡COMM 交通银行支持信用卡ICBCB2B 中国工商银行(企业) 企业网银CMBB2B 招商银行(企业) 企业网银POSTGC 中国邮政储蓄银行(银联)

BOC_EPOS 中行EPOS

ICBC_EPOS 工行EPOS CCB_EPOS 建行EPOS

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

修改记录 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}

百度知道OPEN API接口规范文档1.0_final

修改记录 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.wendangku.net/doc/264977212.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 普通政策请求参数

京东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。

开发接口API模板

"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"){

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、精简程序结构，免除重复定义比如，有两个及上的的类拥有相同的方法，但是实现功能不一样，就可以定义一个接口，将这个方法提炼出来，在需要使用该方法的类中去实现，就免除了多个类定义系统方法的麻烦。举例：鸟类和昆虫类都具有飞行的功能，这个功能是相同的，但是其它功能是不同的，在程序实现的过程中，就可以定义一个接口，专门描述飞行。下图是分别定义鸟类和昆虫类，其都有飞行的方法。

开心网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)会在网页中给出授权码，用户需要手工将验证码输入到应用中才能完成授权流程。

api接口文档

接口：接口泛指实体把自己提供给外界的一种抽象化物，用以由内部操作分离出外部沟通方法，使其能被内部修改而不影响外界其他实体与其交互的方式。在计算机中，接口是计算机系统中两个独立的部件进行信息交换的共享边界。这种交换可以发生在计算机软、硬件，外部设备或进行操作的人之间，也可以是它们的结合。 API： API是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程，而又无需访问源码，或理解内部工作机制的细节。简介：操作系统是用户与计算机硬件系统之间的接口，用户通过操作系统的帮助，可以快速、有效和安全、可靠地操纵计算机系统中的各类资源，以处理自己的程序。为使用户能方便地使用操作系统，OS 又向用户提供了如下两类接口：用户接口：操作系统专门为用户提供了“用户与操作系统的接口” ，通常称为用户接口。该接口支持用户与OS 之间进行交互，即由用户向OS 请求提供特定的服务，而系统则把服务的结果返回给用户。程序接口：操作系统向编程人员提供了“程序与操作系统的接口” ，简称程序接口，又称应用程序接口API。该接口是为程序员

在编程时使用的，系统和应用程序通过这个接口，可在执行中访问系统中的资源和取得OS 的服务，它也是程序能取得操作系统服务的唯一途径。大多数操作系统的程序接口是由一组系统调用(system call)组成，每一个系统调用都是一个能完成特定功能的子程序。应用程序接口又称为应用编程接口，是一组定义、程序及协议的集合，通过API接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。API同时也是一种中间件，为各种不同平台提供数据共享。程序设计的实践中，编程接口的设计首先要使软件系统的职责得到合理划分。良好的接口设计可以降低系统各部分的相互依赖，提高组成单元的内聚性，降低组成单元间的耦合程度，从而提高系统的可维护性和可扩展性。

接口文档规范

XXX接口说明书(版本：V1.0)

修订记录

1简介 1.1文档目的接口文档是前端与后端交互密不可分的环节，接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性，避免对接过程中的错误率。 1.2接口规范 (1)遵循RESTfulAPI设计风格 (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:[ { label:'待开票' value:1001 }, { label:'回款' value:1003 } ]

OpenLayers API接口文档

OpenLayers API 由于OpenLayers是采用JavaScript实现的，不存在包的概念，但是它可以通过命名空间来实现类似包的功能。另外，JavaScript不存在继承的概念，也不存在私有、公有、保护等概念，OpenLayers中所谓的继承其实就是将基类中的所有属性和方法复制到子类中去。OpenLayers的命名空间如下：一、OpenLayers命名空间：

如上图所示，OpenLayers是整个webgis系统的最外层命名空间，所有的地理信息系统相关web程序都在此命名空间下，在此命名空间下又创建了其他的命名空间来管理相关功能的类。在这个命名空间下定义了一些基础类和基类来构建整个框架。 1、class OpenLayers.Map Map类将div DOM元素实例化的对象为地图容器，可以向地图容器中添加图层和控件。属性

2、class OpenLayers.Map2 基于OpenLayers.Map封装，将自有地图图层和常用控件都已经加载在地图当中，用户无需关心地图数据源等问题，简化了用户的地图调用。实例化该类后即可创建一个可查看和使用的地图对象，其方法和属性与OpenLayers.Map一致，见OpenLayers.Map类。 2、class OpenLayers.Marker OpenLayers命名空间下的Marker类可以被实例化为marker对象，用于标注地图上的位置，marker对象是由LonLat 对象和Icon对象组合而成的。markers一般被添加到一个叫做https://www.wendangku.net/doc/264977212.html,yer.Markers的特殊图层中。需要注意的是，如果你在一个marker中使用了一个icon，也就是说，你不能在其他的marker中在使用它——一旦你使用了这个icon，你应该clone()这个icon然后在另外的marker中使用这个icon。 3、class OpenLayers.Popup Popup类实例化一个弹出窗口，通常被添加到地图容器中。构造函数

JPA开发文档(大全)

JPA开发文档（大全）这是一份比较全面的JPA文档，希望能够帮助大家，让大家更好的学习工作。 1.发展中的持久化技术 3 1.1 JDBC (3) 1.2 关系对象映射（Object Relational Mapping，ORM） (3) 1.3 Java 数据对象（Java Data Object，JDO） (3) 1.4 Java Persistence API（JPA） (3) 2.JPA 体系架构 (5) 3.Entity Bean (7) 3.1定义对Entity中属性变量的访问 (7) 3.2 主键和实体标识（Primary Key and Entity Identity) (9) 4.EntityManager (10) 4.1 配置和获得EntityManager (10) 4.2 Entity的生命周期和状态 (10) 4.3 持久化Entity(Persist) (11) 4.4 获取Entity (13) 4.5 更新Entity (13) 4.6 删除Entity (13) 4.7 脱离/附合(Detach/Merge) (14) 5.JPA Query (14) 5.1 Query接口 (15) 5.2 简单查询 (15) 5.3 使用参数查询 (16) 5.4 排序(order by) (16) 5.5 查询部分属性 (17) 5.6 查询中使用构造器(Constructor) (17) 5.7 聚合查询(Aggregation) (18)

5.8 关联(join) (19) 5.9比较Entity (20) 5.10 批量更新(Batch Update) (21) 5.11批量删除(Batch Remove) (21) 1.发展中的持久化技术 1.1 JDBC 很多企业应用的开发者选择使用JDBC 管理关系型数据库中的数据。JDBC支持处理大量的数据，能够保证数据的一致性，支持信息的并发访问，提供SQL 查询语言查找数据。JDBC 所使用的关系模型不是为保存对象而设计的，因此迫使开发者选择在处理持久数据时放弃面向对象编程，或者自己去开发将面向对象特性（比如：类之间的继承）和关系型数据库进行映射的专有解决方案。 1.2 关系对象映射（Object Relational Mapping，ORM） ORM 是目前完成对象和关系数据表之间的映射最好的一种技术，这些ORM 框架处理对象和关系数据库之间的协调工作，将开发者从这部分工作中解脱出来，集中精力处理对象模型。阻碍ORM 发展的问题是，现有的每一种ORM 产品都有自己特有的API，开发者只能将自己的代码绑定到某一个框架提供商的接口上，这种状况形成了厂商锁定，意味着一旦该框架提供商无法解决系统中出现的严重错误，或者因为其它的原因转而采用其它的框架，将会给开发者的企业应用带来极大的困难，唯一的解决办法是重写所有的持久化代码。 1.3 Java 数据对象（Java Data Object，JDO） JDO 是Java EE 标准中另外一个支持管理持久化数据的规范，JDO 规范使用和JPA 非常类似的API，只是通常是通过JCA 技术集成到应用服务器上。但是JDO 是针对轻量级容器而设计的，不能够支持容器级别的声明式安全、事务特性，也无法对远程方法调用提供支持。 1.4 Java Persistence API（JPA）

开发接口文档API文档模板

X X X项目接口文档版本控制信息 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(); ("file", [0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData, processData : false, contentType : false, success : function(result) { result = (result); if == "10000"){ ('上传成功！'); } } });

Json接口文档

文档 [ { [ID](int):编号, [NodeName](string):节点名称 [NodeNo](int):节点编号, [ProductID](int):产品编号, [Remark](string):备注, [GatewayNo](string):网关编号, [AreaID](int):区域编号, [X]:, [Y]:, [Longitude](string):经度, [Latitude](string):纬度, [Extern](string):备用字段, [Type](string):类型, [Installation](string):安装地点, [Color](string):颜色, [CropsNames](string):作物, [GreenhousesID](int):大棚编号 }, .... ] [ { [SENSOR_ID](int):传感器编号, [SENSOR_SHOW_NAME](string):传感器名称, [PORT_SHOW_NAME](string):传感器显示名称,

[UNIT](string):单位, [Accuracy](string):准确性, [ParentID](int):父节点编号, [Code](string):代码, [Level](int):层级, [Color](string):颜色 }, …. ] [ { [ID](int):编号, [SRC_NAME](string):节点名称, [TIME_STAMP](datetime):时间, [NODE_ID](int):节点编号, [CHANNEL](int):, [SENSOR_ID](int):传感器编号, [DATA](double):数值, [LIVE](int):层级 }, .... ] [ { [节点编号](int):, [安装地点](string):, [更新时间](datetime):, [湿度](string):, [温度](string):, [气压](string):, [降雨量](string):, [风向](string):,

第三方充值平台接口开发文档

API接口说明书

目录 1、API介绍 (3) 1.1通讯协议 (3) 1.2充值流程 (3) 1.3权限版本（power） (3) 1.4版本号（ver） (4) 1.5时间戳（timestamp） (4) 1.6订单号（orderid） (4) 1.7数字签名（sign和signkey） (4) 2、API调用说明 (5) 2.1在线充值 (5) 2.2订单回调 (7) 2.3商品进价表 (7) 2.4渠道商信息 (9) 2.5游戏区服表 (11) 2.6用户余额 (12) 2.7手机号码归属地 (12) 2.8系统时间戳 (13) 2.9销售软件 (13) 2.10激活码开通软件 (14) 2.11下级用户列表 (15) 2.12财务记录 (16) 2.13订单记录 (17) 2.14转账 (19) 3、注意事项 (19) 4、通用状态码 (20) 5、附录 (20) 5.1全国省份直辖市ID对照表 (20)

1、API介绍 1.1通讯协议 1. 联系速度达技术（QQ：1551369420）获取密钥KEY，及接口地址。 2. 接口采用GET/POST方式提交请求 3. 返回XML或JSON，传入参数增加format=xml或者format=json 1.2充值流程一次请求保存在本地 1 请求时间戳系统启动，获取服务器时间戳 [api/sys_now] 2请求产品表、渠道表、区服表获取充值产品表 [api/product]、渠道表 [api/product_channel]、区服表 [api/product_area](该步骤执行一次存储在本地即可) 多次请求3选择产品根据所要充值的业务需要先调用本地数据(游戏充值需调用区服表、手机充值需调用渠道表并请求归属地 [api/sys_phone])，然后选择产品。 4提交订单将充值订单提交到充值接口 [api/recharge]。其中productid 就是api/product的 i ；area的值就是手机号码归属地对应的值（见附录）如果是游戏则是api/product_area的i。 5回调订单状态回调订单状态 [api/status]。 1.3权限版本（power） 13代表普及版 15代表专业版

TRSWCM6.5二次开发-023-接口API文档(可编辑修改word版)

修订记录

1基本类、常用基本方法 1.1常用方法该节的方法需要依赖的JS 引入情况如下： 1.1.1判断数据类型的方法 1.1.1.1判断数据是否是数组E x t.i s A rr a y（o）和 A rr a y.i s A rr a y（o） ?方法说明：通过这个方法，可以判断当前参数o 的数据类型是否是数组，返回true 或false； ?参数说明：参数o 是要判断的数据； ?使用示例：例如要判断rels 是否是数组； var rels = []; Array.isArray(rels); 1.1.1.2判断数据是否是布尔型数据E x t.i s Boo l e a n（o） ?方法说明：判断数据的类型是否是布尔型，返回true 或false； ?参数说明：参数o 是要判断的数据； ?使用示例：例如要判断o 是否是布尔型数据； var o = true; Ext.isBoolean(o);

1.1.1.3判断数据类型是否是函数E x t.i s F un c t i o n（o） ?方法说明：判断数据的类型是否是函数，返回true 或false； ?参数说明：参数o 是要判断的数据； ?使用示例：例如要判断参数o 是否是函数； var o = function(){}; Ext.isFunction(o); 1.1.1.4判断数据类型是否是字符串E x t.i s S t r i n g（o） ?方法说明：判断数据的类型是否是字符串型，返回true 或false； ?参数说明：参数o 是要判断的数据； ?使用示例：例如要判断定义的o 是否是字符串类型； var o = 'aaa'; Ext.isString(o); 1.1.1.5判断数据类型是否是数字E x t.i s N u m b e r（o） ?方法说明：判断数据的类型是否是number 型，返回true 或false； ?参数说明：参数o 是要判断的数据； ?使用示例：例如要判断参数o 是否是数字类型； var o = 3; Ext.isNumber(o); 1.1.1.6判断数据类型是否是为空E x t.i s E m p t y（o, n o t A ll o w B l a n k） ?方法说明：判断数据的类型是否是空类型，包括null、undefined、以及notAllowBlank 参数不传或者传 false，空串也返回 true，返回true 或false； ?参数说明：参数o 是要判断的数据，参数 notAllowBlank 是是否允许空串也为空； ?使用示例：例如要o 是否为空； var o = ''; Ext.isEmpty(o);

财付通API接口文档样例代码

API接口文档

百度知道开放平台openAPI接口规范文档 V1.0

开发接口文档-API文档模板

百度知道OPEN API接口规范文档1.0_final

API 接口 设计文档 模板

共享平台API接口规范文档V0.7s

京东API接口整理

api接口文档

开发接口API模板

java开发接口文档模板

开心网API接口说明文档

api接口文档

接口文档规范

OpenLayers API接口文档

JPA开发文档(大全)

开发接口文档API文档模板

Json接口文档

第三方充值平台接口开发文档

TRSWCM6.5二次开发-023-接口API文档(可编辑修改word版)

API 接口设计文档模板