本文档展示了如何从零开始,使用蚂蚁金服开放平台服务端SDK快速接入无线账户授权产品,完成与支付宝对接的部分。
注意:文档中的代码示例和Demo是用来阐述API基本使用方法的,仅针对大众场景。供ISV参考,特殊情况还请ISV自行扩展,确保符合自身业务需求。
要在您的应用中使用支付宝开放产品的接口能力,您需要先去蚂蚁金服开放平台(open.alipay.com),在开发者中心中创建登记您的应用,并提交审核,审核通过后会为您生成应用唯一标识(APPID),并且可以申请开通开放产品使用权限,通过APPID您的应用才能调用开放产品的接口能力。需要详细了解开放平台创建应用步骤请参考《开放平台应用创建指南》。
开发者调用接口前需要先生成RSA密钥,RSA密钥包含应用私钥(APP_PRIVATE_KEY)、应用公钥(APP_PUBLIC_KEY)。生成密钥后在开放平台开发者中心进行密钥配置,配置完成后可以获取支付宝公钥(ALIPAY_PUBLIC_KEY)。详细步骤请参考《配置应用环境》。
接入无线账户授权需要集成两个SDK,客户端SDK需要集成在商户自己的APP中,用于唤起支付宝APP并发送授权请求,并在支付宝APP返回商户APP时授权结果。服务端SDK需要商户集成在自己的服务端系统中,用于后续的服务端接口调用。
无线账户授权与App支付共用同一个SDK,集成SDK的详细方法与支付一样,请参考支付的接入配置流程iOS集成流程详解和Android集成流程详解。
1.下载服务端SDK
为了帮助开发者调用开放接口,我们提供了开放平台服务端SDK,包含JAVA、PHP和.NET三语言版本,封装了签名&验签、HTTP接口请求等基础功能。请先下载对应语言版本的SDK并引入您的开发工程。
2.接口调用配置
在SDK调用前需要进行初始化,以JAVA代码为例:
AlipayClient alipayClient = new DefaultAlipayClient(URL, APP_ID, APP_PRIVATE_KEY, FORMAT, CHARSET, ALIPAY_PUBLIC_KEY, SIGN_TYPE);
关键参数说明:
配置参数 | 示例值解释 | 获取方式/示例值 |
---|---|---|
URL | 支付宝网关(固定) | https://openapi.alipay.com/gateway.do |
APP_ID | APPID即创建应用后生成 | 获取见上面创建应用并获取APPID |
APP_PRIVATE_KEY | 开发者应用私钥,由开发者自己生成 | 获取见上面配置密钥 |
FORMAT | 参数返回格式,只支持json | json(固定) |
CHARSET | 请求和签名使用的字符编码格式,支持GBK和UTF-8 | 开发者根据实际工程编码配置 |
ALIPAY_PUBLIC_KEY | 支付宝公钥,由支付宝生成 | 获取详见上面配置密钥 |
SIGN_TYPE | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
接下来,就可以用alipayClient来调用具体的API了。alipayClient只需要初始化一次,后续调用不同的API都可以使用同一个alipayClient对象。
系统交互流程:
无线账户授权com.alipay.account.auth|:
无线账户授权API必须通过支付宝提供的移动端SDK来调用,点击查看授权SDK调用说明。
获取授权令牌alipay.system.oauth.token:
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2"); //获得初始化的AlipayClient AlipaySystemOauthTokenRequest request = new AlipaySystemOauthTokenRequest();//创建API对应的request类 request.setGrantType("authorization_code"); request.setCode("4b203fe6c11548bcabd8da5bb087a83b"); AlipaySystemOauthTokenResponse response = alipayClient.execute(request);//通过alipayClient调用API,获得对应的response类 System.out.print(response.getbody()); //根据response中的结果继续业务逻辑处理
关键入参:
参数名称 | 参数说明 |
---|---|
grant_type | 值为authorization_code时,代表用code换取;值为refresh_token时,代表用refresh_token换取 |
code | 授权码,用户授权后由客户端SDK返回 |
关键出参:
参数名称 | 参数说明 |
---|---|
user_id | 支付宝用户的唯一userId |
access_token | 访问令牌。通过该令牌调用需要用户信息授权的接口,如alipay.user.userinfo.share |
用户信息共享alipay.user.userinfo.share:
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2"); //获得初始化的AlipayClient AlipayUserUserinfoShareRequest request = new AlipayUserUserinfoShareRequest();//创建API对应的request类 AlipayUserUserinfoShareResponse response = alipayClient.execute(request, access_token);//在请求方法中传入上一步获得的access_token System.out.print(response.getbody()); // TODO 根据response中的结果继续业务逻辑处理
关键入参:
参数名称 | 参数说明 |
---|---|
access_token | 对于需要用户授权的接口,获取用户相关数据时,用于标识用户授权关系 |
关键出参:(待确认全开放后默认返回的字段)
参数名称 | 参数说明 |
---|---|
user_id | 用户的userId |
同步返回结果码 | 含义 | 说明 |
---|---|---|
10000 | 业务处理成功 | |
40001~40006 | 业务处理失败 | 具体失败原因请参考“公共错误码”。其它请参考API文档。 |
20000 | 业务出现未知错误或者系统异常 | 业务出现未知错误或者系统异常 |