https://github.com/zhan3333/skysharing-cass-openapi-java-sdk
Skysharing CASS openapi SDK for Java 云享天空代付系统开放接口Java SDK
https://github.com/zhan3333/skysharing-cass-openapi-java-sdk
Last synced: about 1 year ago
JSON representation
Skysharing CASS openapi SDK for Java 云享天空代付系统开放接口Java SDK
- Host: GitHub
- URL: https://github.com/zhan3333/skysharing-cass-openapi-java-sdk
- Owner: zhan3333
- Created: 2019-12-20T01:00:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-03T18:25:59.000Z (over 1 year ago)
- Last Synced: 2025-03-28T12:03:08.932Z (about 1 year ago)
- Language: Java
- Size: 736 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Skysharing CASS open api JAVA SDK
## Update Log
### v2.3.7 2021-08-24
1.新增微信单方授权（需电签）付款接口
### v2.3.6 2021-07-21
1. 新增微信单方授权付款接口
### v2.3.5.1 2021-07-02
1. 支付宝、银行卡通道支持 phone 参数
### v2.3.5 2021-06-08
1. 支付宝付款通道创建订单方法增加银行卡收款方式
### v2.3.4 2021-04-16
1. 新增支付宝创建订单接口
2. 标机一些不需要的接口类, 移除部分类
### v2.3.3 2020-08-05
1. 修改 3.12, 3.13 API 电签接口流程
2. 取消设置的默认 `HTTP` 请求超时时间, 增加 `HTTP` 请求超时返回异常 `RequestTimeoutException`
3. 修正 `new Notify(str)` 后的对象无法访问 `response` 的 bug
4. 增加通过外部订单号查询订单数据接口 `GetOneOrderByOuterOrderSN`
## 注意
1. Client 创建时默认超时时长为 `60s`, 当付款请求产生 `RequestTimeoutException` 异常时， 对于该付款请求不要立即再次发送请求， 建议等待一段时间后进行订单查询操作, 防止超时的请求已到达结算系统并生效。
## 准备
1. 商户的私钥字符串 `appPrivateKey`, 无头尾信息及换行, pkcs8 格式, 下为示例
`MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDmtPj23EPTcpi6S1BppKJzR5+4ab3CWROpYrgdDFlbpO/ia++ckFdJyrgEjpRE3L4veCGpmshC8bG2xH9UaI5edIuC5WXy0FkW2oKFR6dnPpSv22GM/xNFOIGOVqsex9tZbJbfhmyYuWpUbHXlga2KCxbQosYktuWjAEzb+sfFngGVaI7CS5NSUGFhR3xwpEzO8VoViPi66qVQavoxkreG/uKzoI9I7Ai3b5JK+vA+Gz7W+ZpAqJPZihdvmqaKIt7QL7A4+tV8OWzhELyaIsIJ33RfsGe+iLp7XAfh1dm4bfzFIcUS3ws2ZE0ywb3TCurXMYqeLjsiVr42wYjPiHwdAgMBAAECggEAJqC0crjMjnHIiqCjlRygqoaagokJ4amCdkD2LL7tkz+ZfqKt2tv8EXnkt7absq/3FAGcOUaWM0c+hyh9XUeoVr5SwZbhK/eggwgRBHnL2KiMwqkLu0zWECf24Ts3qY6y9lUNKd3a/vNEj2AdmVDOGqfiqQon/Ou2pUUemVJy8m5BwYLafp5tZk/Yvo5ns48I6recTaQiCTbwXlD0hSYVHhaOhtzIXLk5hjBKGasDNuvAmhqZM+XGnITTq4Z+wGZS3Ir4ynGZMn4FzzTXd41SZ/tucKjFmh3tSeCQjTBzKS+Y6je694UNCKy0TTFc9mANFs4qL+m58uD6KWUiRx/27QKBgQD/FgJQPB2W6Yw92vTS1fJA1irJLPeUoy3R99qDAlGjbnwht31943/DfhBtBGdEOUaXskJvtZLYwU4aE9CytUKQeqhuIU1uRosE44V3wq6EFTknXGFQ+XAT9e+hAjSn7HcHYjPRvxMJvmg3N/86oQAq/Zt6UNGmvCRwQzSdmdeUmwKBgQDniJm7v56xVuO/5W+P9yiNUayHgCfya7/eQij0Rw9hIJ0mKEUl2ENGGdtw6ZqsdrSD6yHkzGLTGCd0cy9cifwz25AjnSOf5kLHJem9WuxqcFlZQlF8X+ba1OOJwfQxyCrjhR2/1QttVGOl84kMDij/YYA0Ip+EQ5mP5YWxsfzRpwKBgGHX3VdNV8Q1HRf0zoe4jM2V2J+F4glfdgnd2jD6SLo5fN+p9Da/dphT2JUYZUvj9FHnjFgw+3ys2Ppjs19462ljwwtLNtofsN9VLjK7uBjt0xhn9OQMaZMeeKX3pJ7sstNgNaQ0eGb6ZBsaHYoti1TyJhsKuQANlqSBAsOY6PoVAoGAfpjIRkoeASVbXj+bYoJn3+16gpRmQzz7KhHOxtJb7GWix4xZUroO/rOAsxpoAkjdpwvX+nxuxLF+UUPx741bIxe4lmCDbBjBBpcKWQjwH7rSf+WtHG5rkde5mkc8uEOUf9b3Tz60AtGTsteYZckQTaMIMHmF8xHrUyzSjzic3h0CgYEApidFokFSKY39OLk9WqWLd+XfL1ykOJh4xsREADo09oIvVtRrtaojaDpCg6/ewb5eVHzIxutTJqrKNIiO00+jK9OBqHf3NIbVA2aAxj2+zTZCc/+zkqDjnhWFcKLU4hAH5j6mQrDcn7hzE5ic/nyILQOyO2hQVXqM82RFcIJPCkE=`
2. CASS系统提供的公钥 `cassPublicKey`, 无头尾信息及换行, 下为示例
`MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzvaToLe+vIN/G4u9gxe3kL/myE129RsgZWIyTf7Tjc0rARdsvE9Xy2fdzNTwttyqJJaB9oNuCjdhNXAJoSUqoKei0aA88oFylPWG6DZ7ZoIXOGtipvnloosWhskes+E+EvQWrwSgzCAEr5N7iHY5DEBBy8ZoHsthd5CvCGyBgfeAsCCQ/R6Cl2Bw0SNasVu45+0PfmW/AUeC29i7KJm1HC/D5n6oXSa6q16oh6TWiFnVJF5dNCeuHN+3KQAe/Hv3CldiTHB8mND9OYzx2DzZYJD7g8f185Td5a8mRwlYf2PwTfGLkMdxa+XlGIsHjCFbXD1N85XC3QVfbgZWnxQA9QIDAQAB`
3. CASS提供的商户 `APPID`
4. CASS open api 调用地址 `https://fuwu-openapi.skysharing.cn/gateway/cass`
## maven 引用包
```xml
com.github.zhan3333
skysharing-cass-sdk-java
2.3.6
```
## 简单调用示例
```JAVA
class Test {
public void queryBalance() {
// 商户私钥
String privateKeyStr = "";
// CASS系统公钥
String cassPublicKeyStr = "";
// APPID
String APPID = "12345H29GDK580CGNO30G81OEB";
// 实例化客户端, format 暂时只支持JSON, signType 暂时只支持RSA2
DefaultCassPayClient client = new DefaultCassPayClient("https://fuwu-openapi.skysharing.cn/gateway/cass", APPID, privateKeyStr, cassPublicKeyStr, "JSON", "RSA2");
// 可选， 设置请求超时时间。默认为 60s
client.setTimeout(TimeUnit.SECONDS, 60, 60, 60, 60);
// 可选， 开启 debug 日志输出， 将通过 System.out 输出
client.setDebug(true);
// 创建接口请求
GetBalanceRequest request = new GetBalanceRequest();
// 设置请求参数
request.setPayChannelK(GetBalanceRequest.BANK);
// 执行请求,获取响应值
GetBalanceResponse response = client.execute(request);
// 验签
if (response.verify()) {
// 验签通过
if (response.isSuccess()) {
// 业务请求成功 ...
System.println(response)
}
}
}
}
```
## 接口对应请求和响应列表
|序号| 接口名称 | 请求 | 响应|
| ---- | ---- | ---- | --- |
|3.1|获取商户余额 | GetBalanceRequest | GetBalanceResponse |
|3.2|获取单个批次状态 | GetOneRemitStatusRequest | GetOneRemitStatusResponse |
|3.3|获取单个订单状态 | GetOneOrderStatusRequest | GetOneOrderStatusResponse |
|3.4|银行卡实时下单 | PayBankRemitRequest | PayBankRemitResponse |
|3.5|微信实时下单 | PayWeChatRemitRequest | PayWeChatRemitResponse |
|3.6|单笔银行卡实时下单 | PayOneBankRemitRequest | PayOneBankRemitRequest |
|3.7|单笔微信实时下单 | PayOneWeChatRemitRequest | PayOneWeChatRemitRequest |
|3.8|充值账号查询 | GetChannelDataRequest | GetChannelDataResponse |
|3.9|银行卡充值申请提交 | ChargeBankRequest | ChargeBankResponse |
|3.10|微信充值申请提交 | ChargeWeChatPayRequest | ChargeWeChatPayResponse |
|3.11|获取充值结果 | GetChargeResultRequest | GetChargeResultResponse |
|3.12|添加用户实名认证状态 | VerifyUserRequest | VerifyUserResponse |
|3.13|获取用户实名认证状态 | GetUsersVerifyStatusRequest | GetUsersVerifyStatusResponse |
|3.14|获取合同列表 | GetContractListRequest | GetContractListResponse |
|3.16|批量获取用户电签状态 | GetUserEsignStatusRequest | GetUserEsignStatusResponse |
|3.17|获取商户电签二维码 | GetShowSignUrlRequest | GetShowSignUrlResponse |
|3.18|通过外部订单号查询订单状态 | GetOneOrderByOuterOrderSNRequest | GetOneOrderByOuterOrderSNResponse |
|3.19|支付宝单笔下单 | PayOneALiRemitRequest | PayOneALiRemitResponse |
|3.20|支付宝批量下单 | PayALiRemitRequest | PayALiRemitResponse |
|3.21|微信单笔付款到 OpenID | PayOneWeChatOpenIDRemitRequest | PayOneWeChatOpenIDRemitResponse |
|3.22|微信批量付款到 OpenID | PayWeChatOpenIDRemitRequest | PayWeChatOpenIDRemitResponse |
## 异常清单
|类|说明|
|----|----|
|CassApiException|异常基类|
|InvalidPrivateKeyException|无效的私钥|
|InvalidPublicKeyException|无效的公钥|
|RequestFailedException|请求失败异常|
|RequestTimeoutException|请求超时异常, 对于付款等关键接口, 发生该异常时, 务必不要立即重复发起请求, 需要一段时间后通过查询接口确认订单是否提交成功|
|ResponseNotValidException|服务端响应结构异常|
|SignException|对数据进行签名异常|
## 解析异步通知数据
可以将接收到的 json 文本直接创建 Notify.class, 可以解析出来对象便于操作
```
String str = "{\"response\":{\"charset\":\"UTF-8\",\"content\":\"{\\\"resourceID\\\":\\\"18483279179157507UBO8C1GBI8S4RUJ\\\",\\\"pushType\\\":2,\\\"notifyUrl\\\":\\\"http:\\\\\\/\\\\\\/docker.for.mac.localhost:7777\\\\\\/api\\\\\\/conversion_skysharing\\\\\\/v1\\\\\\/notify\\\",\\\"sendData\\\":\\\"{\\\\\\\"status\\\\\\\":\\\\\\\"TRADE_FAILED\\\\\\\"}\\\",\\\"createdAt\\\":1585742840681725,\\\"orderSN\\\":\\\"8D9B9AE0-6DDD-4D72-9334-18AD72029500\\\",\\\"rbUUID\\\":\\\"18483278357073921OA5IDCFFO2RO62L\\\"}\",\"notifyTime\":\"20200608143859\",\"notifyType\":2,\"signType\":\"RSA2\"},\"sign\":\"gV9P7jvBCX6qc8xRRfIAfi357Wpc9Rmt9MfOwa4QucRU3\\/WSf525WFlyfEt3BqeJ1qsDWGHLoH5l++77kUPL0qRcLc6InC6G1uxERaaJ8yPPZa9246mJJo3SyLr+3ZT5bq5mLYhOOx0Zj2GR0+08luLHB29f72xdXTNWvitro9o48O4RJ0CeldIG89J1N683ZXlRSIfUcIBoHWEUHlYV8sDZlQlAMcc9+dIjsg\\/5RGjkhJHI2LMKldJrvK8jCb1pruS+i4f51gatcdqwoDZ0zWy1xTaywPT4PdaBU6emB4Xn4kyW6NBCLFVEU0bIg9CNZXZ6TXSN5H6Kbl8ppJuKdA==\"}";
Notify n = new Notify(str);
System.out.printf("notify object: %s", n);
```
## 异步通知签名校验
可以直接对通知请求体进行校验签名，内部会自动解码处理
```
Map map = new HashMap<>();
try {
DefaultCassPayClient client = new DefaultCassPayClient(dotenv.get("API_URL"), dotenv.get("APPID"), dotenv.get("PRIVATE_KEY_STR"), dotenv.get("VZHUO_PUBLIC_KEY_STR"));
client.setDebug(true);
boolean ret = client.verifyNotify(postStr);
System.out.printf("response verify: %b", ret);
if (ret) {
map.put("content", "success");
} else {
map.put("content", "failed");
}
} catch (InvalidPrivateKeyException | InvalidPublicKeyException e) {
e.printStackTrace();
}
// 需要向客户端返回 success, failed, 为 failed 时将会按照一定频率重试通知，
return map
```