sdk 与工具 -凯发app官方网站

更新时间：2024-09-14 17:43:51

订阅更新

我的文档

设置

简介

为了帮助开发者快速接入支付宝 api v3，支付宝提供了基于 v3 协议的服务端 sdk。sdk 为商户的技术人员封装了请求的签名和响应的验签，简化了系统的开发工作。

服务端sdk（v3版）

支付宝将与服务端交互的接口（openapi v3）封装在开发工具包（sdk）中，开发者无需自行实现同支付宝服务端交互的复杂逻辑，直接将 sdk 导入自己的工程后，通过 openapi v3 的示例代码实现同支付宝服务端的交互。

目前已支持

java

、

php

、

三种编程语言，开发者可根据自己的需要，选择对应的 sdk。开发者如果需要接入其他语言，可查看

自行生成sdk

。

获取alipay sdk

开发语言	资源下载	环境要求	说明
java 版资源	● ●	●java 1.8 ●maven (3.8.3 )/gradle (7.2 )	请使用 3.0.0.all 及以上版本。
.net 版资源	● ●	●.net core >=2.0 ●.net framework >=4.7	请使用 3.0.0 及以上版本。
php 版资源	● ●	●^7.4 \|\| ^8.0	请使用 3.0.0 及以上版本。
node.js 版资源	● ●	●node.js >= 18.20.0	请使用 4.0.0 及以上版本。

注意事项

java sdk（alipay-sdk-java）

在 2.8.0.all 版本之前存在无法兼容接口新版本的风险，建议您尽快将上述 sdk 升级至 2.9.0.all 及以上版本（如已是更新版本请忽略，无需任何操作），以免因平台接口升级出现不兼容报错。

请将项目中对 java sdk 的 maven 依赖的版本号更新到 2.9.0.all 或以上，如下所示：

<groupid>com.alipay.sdkgroupid>

<artifactid>alipay-sdk-java-v3artifactid>

<version>2.9.0.allversion>

dependency>

温馨提示：

●

强烈建议开发者在升级后进行业务功能的回归验证，以免出现不可预见的兼容性问题影响业务正常运行。

●

如若遇到特殊情况导致升级失败，请通过

-右下角，联系支付宝凯发app官方网站的技术支持寻求帮助。

sdk使用说明

由于实例化 sdk 客户端时需要指定应用的私钥信息，请务必注意不要将私钥信息配置在源码中（例如配置为常量或储存在配置文件的某个字段中等），因为私钥的保密等级往往比源码高得多，将会增加私钥泄露的风险。推荐将私钥信息储存在专用的私钥文件中，将私钥文件通过安全的流程分发到服务器的安全储存区域上，仅供自己的应用运行时读取。

sdk 已经对加签/验签逻辑做了封装，使用 sdk 时传入支付宝公钥等内容可直接通过 sdk 自动进行加验签。sdk目前仅支持 rsa2 算法。

确定接口对应的类

1. 全面开放的 openapi

例如接口名为：

alipay.trade.pay

在 sdk 中对应的请求/响应类为：每个单词首字母大写，并去掉分隔符（“.”），末尾加上 model（或 responsemodel / errorresponsemodel / defaultresponse）。无响应参数时，返回类为object。

在 sdk 中对应的 api 资源类为：最后一个分隔符（“.”）之前的每个单词首字母大写，并去掉分隔符（“.”），末尾加上 api。

在 sdk 中对应的调用方法为：最后一个分隔符（“.”）之后的单词。

如上接口名对应的类为：

alipaytradepaymodel（请求类）

alipaytradepayresponsemodel（正常响应类）

alipaytradepaydefaultresponse（异常响应类）

└─ alipaytradepayerrorresponsemodel（业务自定义异常响应类）

└─ commonerrortype（通用异常响应类）

alipaytradeapi（api 资源类）

└─ pay（调用方法）

注意

：若 api 没有返回值，则没有业务自定义异常响应类，此时sdk返回的类统一为 object 。

2. 非全面开放的 openapi

使用通用接口 execute 调用，无需使用 request、response 和 model 类。（对于找不到对应 request、response 和 model 类的 openapi 均可使用该方法调用）

具体调用方式见下方示例代码。

示例代码

java

普通调用示例

与v2区别：

全局 client 设置方式不同：

configuration.getdefaultapiclient()

可获取全局唯一 client，也可通过

configuration.setdefaultapiclient(apiclient)

重新设置 client。

需初始化 api 资源类（alipaytradeapi）

也可通过如下方式设置 apiclient：

最终发起调用后的请求如下：

证书调用示例

pageexecute & sdkexecute调用示例

与v2区别：

无request类，需组装map或json

需传入 api 的方法名（method）

通用方法

新版 sdk 覆盖已全面开放的 openapi，对于尚在试点等阶段的定向 openapi，可使用更加灵活的通用方法发起调用

：

第三方代理调用示例

普通 api 调用

pageexecute & sdkexecute 调用

自定义body参数

高级参数设置

sdk使用okhttp进行网络传输，可通过自定义

okhttpclient

的方式设置连接池、超时时间等。

关闭日志：

注意

：如需使用日志，请自行引入日志框架如

log4j

并配置相关配置文件。

异常处理示例

aes 加密配置示例

sdk目前仅支持 aes 算法进行加解密。

注意

：如果设置了该参数，则表示当前 apiclient 下所有接口都会加密。如果需要指定部分接口加密，可另外设置一个全局 apiclient 用于调用加密接口：

sse 协议调用方法

说明

：需升级到 3.0.0.all 及以上版本。

请求需要实现抽象类

com/alipay/v3/util/streamcallback.java

异步通知验签说明

v3版本依然提供

alipaysignature.java

工具类帮助开发者接入，使用方式与v2版本一样。可参考

。