要在您的应用中使用支付宝开放产品的接口能力,您需要先去蚂蚁金服开放平台(open.alipay.com),在开发者中心中创建登记您的应用,并提交审核,审核通过后会为您生成应用唯一标识(APPID),并且可以申请开通开放产品使用权限,通过APPID您的应用才能调用开放产品的接口能力。需要详细了解开放平台创建应用步骤请参考《开放平台应用创建指南》。
开发者调用接口前需要先生成RSA密钥,RSA密钥包含应用私钥(APP_PRIVATE_KEY)、应用公钥(APP_PUBLIC_KEY)。生成密钥后在开放平台开发者中心进行密钥配置,配置完成后可以获取支付宝公钥(ALIPAY_PUBLIC_KEY)。详细步骤请参考《配置应用环境》。
为了帮助开发者调用开放接口,我们提供了开放平台服务端SDK,包含JAVA、PHP和.NET三个语言版本,封装了签名&验签、HTTP接口请求等基础功能。请先下载对应语言版本的SDK并引入您的开发工程。
各语言版本服务端SDK详细使用说明,请参考《服务端SDK使用说明》
在SDK调用前需要进行初始化,代码如下:
AlipayClient alipayClient = new DefaultAlipayClient(URL, APP_ID, APP_PRIVATE_KEY, FORMAT, CHARSET, ALIPAY_PUBLIC_KEY, SIGN_TYPE);
配置参数 | 示例值解释 | 获取方式/示例值 |
---|---|---|
URL | 支付宝网关(固定) | https://openapi.alipay.com/gateway.do |
APPID | APPID 即创建应用后生成 | 获取见上面创建应用并获取APPID |
APP_PRIVATE_KEY | 开发者私钥,由开发者自己生成 | 获取详见上面配置密钥 |
FORMAT | 参数返回格式,只支持json | json(固定) |
CHARSET | 编码集,支持GBK/UTF-8 | 开发者根据实际工程编码配置 |
ALIPAY_PUBLIC_KEY | 支付宝公钥,由支付宝生成 | 获取详见上面配置密钥 |
SIGN_TYPE | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
场景说明:
商户系统为用户开具发票时,可以通过调用用户抬头列表接口获取用户在支付宝预设的抬头列表,用户选择抬头后提交开票申请。
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2"); AlipayEbppInvoiceTitleListGetRequest request = new AlipayEbppInvoiceTitleListGetRequest(); request.setBizContent("{" + "\"user_id\":\"2088000000000000\"" + " }");//请开发者实际测试时,保证其值和发起授权用户的user_id一致,此处仅示例。 AlipayEbppInvoiceTitleListGetResponse response = alipayClient.execute(request,access_token);//access_token即用户信息授权时获取后授权码,注意用户信息授权时scope=auth_invoice_info if(response.isSuccess()){ System.out.println("调用成功"); } else { System.out.println("调用失败"); }
关键入参:
参数名称 | 参数说明 |
---|---|
user_id | 支付宝用户id ,必须和发起授权用户的user_id一致 |
关键出参:
参数名称 | 参数说明 |
---|---|
title_list | 抬头列表,包括title_name(抬头名称),is_default(是否是用户默认抬头)等信息,具体包含字段见此行下方 |
user_id | 抬头所属的支付宝用户id |
title_name | 抬头名称 |
title_type | 抬头类型 值包含两种情况: PERSONAL(个人抬头) CORPORATION(单位抬头) |
is_default | 是否是用户设置的默认抬头 值包含两种情况: false(非默认) true(默认抬头) |
user_mobile | 单位电话 |
tax_register_no | 纳税人识别号 |
user_address | 单位地址 |
open_bank_name | 单位开户银行 |
open_bank_account | 单位开户银行账号 |
关键出参和用户填写抬头表单映射关系图如下所示:
1)个人抬头表单与接口输出参数映射关系
2)单位抬头表单与接口输出参数映射关系
沙箱环境是开放平台提供给开发者调试接口的环境,具体操作步骤见沙箱接入指南。
1、支付宝闪电开票沙箱接入,详见沙箱接入指引,沙箱接口调通后,再进行线上测试与验收;
2、支付宝闪电开票沙箱接入接口调试的抬头数据准备需要使用沙箱买家账号(点击开发者中心-沙箱环境-沙箱账号)登录沙箱钱包(点击开发者中心-沙箱环境-沙箱工具)进入应用“发票管家”添加。