1 .接口说明

1.1.支付宝定义两种类型接口：

• SPI（Service Provider Interface）：支付宝定义接口规范，由ISV实现，提供给支付宝调用;
• API（Application Programming Interface）：支付宝开放平台接口，支付宝实现, 提供给ISV调用；

1.2 接口列表：

2.服务商提供接口（SPI）

2.1.1 请求方式

采用https的方式向服务商发送数据请求。

2.1.2.整体流程

SPI 的接入流程如下图所示：

支付宝：

1. 在后台设置 SPI 的相关规范（如调用类型、请求方法、参数和错误码等）；
2. 将若干个 SPI 组合成实现具体业务功能的产品功能包；
3. 将功能包以全面开放（外部服务商可以自助添加）或者定向开放（仅对特定目标服务商可见）的形式发布；
4. 待第三方系统服务商完成相关 SPI 的开发并成功发布后，即可调用第三方系统服务商提供的 SPI

第三方系统服务商：

根据支付宝 SPI 的相关规范完成 SPI 的开发。支付宝调用第三方系统服务商SPI服务前需要完成 SPI 功能包的添加并成功发布服务，

2.1.3SPI接入步骤

2.1.4 身份认证接口规范及参数说明

1.接口名称

spi.alipay.commerce.educate.certification.campuscard.query（认证学生信息查询）

2.2.通信规范

2.2.1 协议规则

外部商户接入支付宝开放平台出口网关，提供的服务必须满足以下规范：

2.2.2 请求报文格式

Header 参数

由 SPI 接口文档中的 Header 参数定义，Header中的key具有固定前缀"x_"。

Query 参数（支付宝开放平台接口统一规范，仅供参考，测试工具中已固定传入，无需在工具中填写Query参数）

Body 参数

由 SPI 接口文档中的 Body 参数定义，Content-Type为：application/x-www-form-urlencoded。

2.2.3 响应报文格式

响应参数定义

response 定义

{
"response":{
    "code":"10000",
    "msg":"Success",
"name":"王小二",
"school_stdcode":"4136013438",
"school_name":"同济大学",
"status":"0（在校）",
"short_code":"1234567890",
"expire_at":"2019-10-01",
"campus_no":"1234567890",
"ext_info":"{\"email\":\"092806@tongji.edu.cn\"}"
  }
,"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

{
    "response":{
        "code":"40004",
        "msg":"Business Failed",
        "sub_code":"INVALID_PARAMS",
        "sub_msg":"无效参数"
    },
    "sign":"TqnBnkILs86FJWRqWWZptqIpSKLIp2vnwod177h7GLyWuLhzgRHpXgXd8GoD4flyHrHBTycQdiUjWw6VqCE5rYHrJU3iYqI1e0MLlhCb"
}

/**
 * 明文公钥模式：RSA/RSA2验签，sign和sign_type不参与验签
 * 
 * @param params    签名参数：业务参数（包括SPI接口定义的header、query、body参数）+系统参数（除去sign、sign_type以外的所有系统字段）
 * @param publicKey 支付宝公钥明文
 * @param charset   验签字符集
 * @param charset   验签算法（RSA/RSA2）
 */
boolean AlipaySignature.rsaCheckV1(Map<String, String> params, String publicKey, 
                                   String charset, String signType)
    
/**
 * 证书模式：RSA/RSA2验签，sign和sign_type不参与验签
 * 
 * @param params    签名参数：业务参数（包括SPI接口定义的header、query、body参数）+系统参数（除去sign、sign_type以外的所有系统字段）
 * @param alipayPublicCertPath 支付宝公钥证书
 * @param charset   验签字符集
 * @param charset   验签算法（RSA/RSA2）
 */
boolean AlipaySignature.rsaCertCheckV1(Map<String, String> params, String alipayPublicCertPath, 
                                       String charset, String signType)

{ "response":{ "code":"10000", "msg":"Success", "key":"value" }, "sign":"xxx" }

{
  "code":"10000",
  "msg":"Success",
  "key":"value"
}

/**
 * RSA/RSA2签名，sign和sign_type不参与签名
 * 
 * @param content
 * @param privateKey
 * @param charset
 * @return
 * @throws AlipayApiException
 */
public static String rsaSign(String content, String privateKey, String charset, String signType)

@RequestMapping(value = "/isv/spi/service") 
@ResponseBody 
    public String spiService(@RequestHeader HttpHeaders headers, 
                          @RequestParam Map<String, String> params) {
        // http响应结果载体
        JSONObject result = new JSONObject();
        // 业务处理结果载体
        JSONObject response = new JSONObject();         

        //header中的业务参数也参与签名（可选，根据SPI接口定义而定）
        params.put("header_biz1", headers.getFirst("header_biz1"));
        params.put("header_biz2", headers.getFirst("header_biz2"));

        // 1、验签支付宝请求报文
        boolean isPass = AlipaySignature.rsaCheckV1(params, alipayPublicKey, "UTF-8", "RSA2");

        if (isPass) {
            // 2、验签成功：处理业务逻辑，并构造业务处理结果
            response.put("code", "10000");
            response.put("msg", "Success");
            response.put("biz", "value");
            JSONObject person = new JSONObject();   
            person.put("age", "18");
            person.put("height", "180");
            response.put("person", person);  // response中嵌套复杂类型数据结构场景
        } else {
            // 验签失败：构造错误码
            response.put("code", "40004");
            response.put("msg", "Business Failed");
            response.put("sub_code", "ISV-VERIFICATION-FAILED");
            response.put("sub_msg", "验签失败");
        }

        // 3、业务处理结果加签
        // contentToSign 为 {"code":"10000","msg":"Success","biz":"value","person":{"age":"18","height":"180"}}
        String contentToSign = response.toJSONString(); 
        String sign = AlipaySignature.rsaSign(contentToSign, isvPrivateKey, "UTF-8", "RSA2");

        // 4、构造http响应结果
        result.put("sign", sign);
        result.put("response", response);

        // 返回json格式响应报文
        return result.toJSONString();
    }

3.支付宝开放平台接口（API）

合作ISV同步认证的学生信息到支付宝，需要调用openapi同步认证数据，默认用户是已认证的状态。

3.1.接口名称：

alipay.commerce.educate.authenticate.campuscard.create（高校ISV认证信息同步）

3.2.入参：

3.3以java为例调用代码

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayCommerceEducateAuthenticateCampuscardCreateRequest request = new AlipayCommerceEducateAuthenticateCampuscardCreateRequest();
request.setBizContent("{" +
"\"cert_no\":\"21020119980615433X\"," +
"\"cert_type\":\"学生证件类型，默认为1: 1 居民身份证\"," +
"\"user_name\":\"王小二\"," +
"\"campus_no\":\"1234567890\"," +
"\"gender\":\"学生性别,0未知，1男，2女，9未说明的性别\"," +
"\"school_stdcode\":\"1234567890\"," +
"\"school_name\":\"同济大学\"," +
"\"campus\":\"嘉定校区\"," +
"\"organization\":\"年级/学院/班级\"," +
"\"expire_at\":\"2019-01-01\"," +
"\"isv_short_code\":\"123456789\"," +
"\"ext_info\":\"{\\\"name\\\":\\\"123\\\"}\"," +
"\"card_type\":\"1\"" +
"  }");
AlipayCommerceEducateAuthenticateCampuscardCreateResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例：

{
"alipay_commerce_educate_authenticate_campuscard_create_response":{
    "code":"10000",
    "msg":"Success",
"result":"SUCCESS"
  }
,"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

FAQ