Skip to content

yp-creative/yop-java-sdk-old

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

273 Commits
.gitlab
.gitlab
 
 
src
src
 
 
.gitignore
.gitignore
 
 
CHANGELOG.md
CHANGELOG.md
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
assembly-jdk16.xml
assembly-jdk16.xml
 
 
assembly-jdk17.xml
assembly-jdk17.xml
 
 
assembly.xml
assembly.xml
 
 
dependency-reduced-pom.xml
dependency-reduced-pom.xml
 
 
package.sh
package.sh
 
 
pom.xml
pom.xml
 
 

Repository files navigation

Java版使用说明

易宝开放平台 的SDK是由程序自动化生成的代码包，其中包含了构建请求、加密、返回解析等一些必要的功能。

  • 支持java sdk支持1.5及以上（目前仅支持j2se标准java平台使用，不适合android平台）

1.准备工作

注册成为开放平台开发者并创建应用。

  • 如果未注册，请访问开放平台注册并创建应用。
  • 如果是易宝原有商户，请联系技术支持开通相关账号。

2.下载SDK包

将下载好的压缩包解压，内容如下：

+- docs                            // 其他文档或工具
|  +- tz.jsp                       // 环境探针
+- LICENSE                         // 授权协议，请勿删除
+- pom.xml                         // maven 依赖管理文件
+- README.md                       // README 文档
+- yop-java-sdk-${version}-jdk18.jar    // All in One for JDK 1.8，已将lib目录shade打包
+- yop-java-sdk-${version}-jdk17.jar    // All in One for JDK 1.7，已将lib目录shade打包
+- yop-java-sdk-${version}-jdk16.jar    // All in One for JDK 1.6，已将lib目录shade打包
+- yop-java-sdk-${version}-sources.jar  // 源码包
+- yop-java-sdk-${version}-tests.jar    // 单元测试
+- yop-java-sdk-${version}.jar          // 未将lib目录shade打包的原始jar包
+- yop_sdk_config_default.json     // 默认用配置文件
+- yop_sdk_config_template.json    // 配置文件模版
+- lib                             // 依赖包，采用All in One时请忽略本目录

<dependency>
	<groupId>com.yeepay.g3.yop</groupId>
	<artifactId>yop-java-sdk</artifactId>
	<version>${具体版本见SDK包}</version>
</dependency>

2.1 发布SDK包到仓库

参考发布第三方jar包到远程仓库，示例如下：

mvn deploy:deploy-file -Dversion=3.2.1 -DgroupId=com.yeepay.g3.yop -DartifactId=yop-java-sdk -Dpackaging=jar -Dfile=target/yop-java-sdk-3.2.1.jar -DpomFile=pom.xml -Durl=http://xxxx:8000/artifactory/xxx-release/ -DrepositoryId=xxx

3. 示例

3.0. 配置文件说明

app_key：应用标识

aes_secret_key：应用密钥，当认证鉴权机制为对称、OAuth2、Basic时需要提供

yop_public_key（list）：YOP平台公钥，当认证鉴权机制为非对称时需要提供

- store_type
    - string：密钥文本<br>
    - file_p12：p12格式的密钥文件<br>
- cert_type: RSA2048/RSA4096<br>
- value: 如果store_type为string，则该值为密钥文本；如果store_type为file_*，则该值为密钥文件路径<br>

isv_private_key（list）：ISV 私钥，当认证鉴权机制为非对称时需要提供<br>
- store_type<br>
    - string：密钥文本<br>
    - file_p12：p12格式的密钥文件<br>
- cert_type: RSA2048/RSA4096<br>
- value: 如果store_type为string，则该值为密钥文本；如果store_type为file_*，则该值为密钥文件路径<br>
- password：如果p12需要密码<br>

httpclient:<br>
- connect_timeout：全局连接超时，默认值：30*1000
- read_timeout：全局读取超时时间，默认值：30*1000
- max_connections: 最大连接数，默认值：50

server_root:
- yop: YOP 服务器请求地址。默认值：https://openapi.yeepay.com/yop-center<br>
- yos: YOS 服务器请求地址。默认值：https://yos.yeepay.com/yop-center<br>

region: 区域，默认值：空<br>

proxy:<br>
- host: 代理服务器IP<br>
- port:  代理服务器端口，默认值：-1<br>
- scheme: 协议(http或者https)
- username: 代理账号<br>
- password: 代理密码<br>
- domain: 代理域<br>
- workstation: 代理工作站<br>

protocol_version：协议版本，默认：yop-auth-v2<br>

config_version: 配置文件版本<br>

3.1. 对称加密接口

代码示例：

// 初始化 SDK（建议不要设置，自动会走配置读取）
//YopConfig.setAppKey("<Your appKey>");
//YopConfig.setAesSecretKey("<Your appSecret>");

// 发起调用
YopRequest request = new YopRequest();// 注意重载方法可以支持不同请求使用不同的密钥

// 演示普通参数传递
request.addParam("address", "13812345678");

// 演示本地文件参数传递
request.addFile(new File("src/test/resources/log4j.xml"));

// 演示本地文件流参数传递
FileInputStream stream = new FileInputStream(new File("/Users/dreambt/SiteMesh Flow Diagram.png"));
request.addFile(stream);

// 演示远程文件参数传递
request.addFile(new URL("https://www.yeepay.com/logo.png").openStream());

YopResponse response = YopClient.post("/rest/v1.0/notifier/send", request);

3.2. 非对称签名接口

配置文件

默认配置文件名：yop_sdk_config_default.json

配置项

  • yop_public_key：YOP平台密钥
  • store_type
    • string：密钥文本
    • file_p12：p12格式的密钥文件
  • cert_type
    • RSA2048
    • RSA4096
  • value
    • 如果store_type为string，则该值为密钥文本
    • 如果store_type为file_*，则该值为密钥文件路径
  • password：如果p12需要密码

配置示例

{
  "yop_public_key": [{
    "store_type": "string",
    "cert_type": "RSA2048",
    "value": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4g7dPL+CBeuzFmARI2GFjZpKODUROaMG+E6wdNfv5lhPqC3jjTIeljWU8AiruZLGRhl92QWcTjb3XonjaV6k9rf9adQtyv2FLS7bl2Vz2WgjJ0FJ5/qMaoXaT+oAgWFk2GypyvoIZsscsGpUStm6BxpWZpbPrGJR0N95un/130cQI9VCmfvgkkCaXt7TU1BbiYzkc8MDpLScGm/GUCB2wB5PclvOxvf5BR/zNVYywTEFmw2Jo0hIPPSWB5Yyf2mx950Fx8da56co/FxLdMwkDOO51Qg3fbaExQDVzTm8Odi++wVJEP1y34tlmpwFUVbAKIEbyyELmi/2S6GG0j9vNwIDAQAB"
  }],
//  "isv_private_key": [{
//    "store_type": "file_p12",
//    "cert_type": "RSA2048",
//    "password": "123",
//    "value": "/certificate.p12"
//  }],
    "isv_private_key": [{
      "store_type": "string",
      "cert_type": "RSA2048",
      "value": "MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQC6iLkZOHl5VOvFN7i1jf6uu8UMyrU4fwrdxsvfTaeYVypOX+4SbEiCj9IqMiP7io2RPkERQae8Vt3kUXR1JSNYmofq27G3hXkZGMjjmmJ5X3hMPdfJtm0V8Vf6wHIpwpgE+cmJjtgYkmRnqRB+CVHFjkwoMGzJj8EhVu2uLoNM+XHwVKr4aME70gWKCUp31lHVzR+CHiBrrNvgVUBHWPoP79Yn3A8+lkh63qwje3pP2yD8ZX4/2xXWaxkrJ2l3xBVGy3jp2GBh3RsQlDM9R5MP24fiHCjAZ2+It5s4Li6pqe+Cs13zNWJh3K5Py2zh9u30V56dO37GN57Ox3E0pErTAgMBAAECggEATgkOro9iujCdpdbmzgVGS6FAEVboM2dqi1c0SQn6mA+3Iiyds1VbjEtQl9h8FypiiSWrIOX/nxoUIAU3nB5aSCH1xHn+QhFzlN06hYU7tx0KfZLNqJRJ1IkvzjYeTHwdDs/U0VhR7Q2pNXiT7rZFYElkcNe5WyVpnWH5cwoAYf2tPrQ+X+tIq7w/SsmLAt5luLRirkgjYxfVYKmTnWcEXNCthwX/OCrBJTQF2p6WWdqqd740asWEGZHo3Ow5PfTj9bSH9xfEq5MdokeHUeS3ComO7kwBlJr0t+FF+RMU2uQGdqzrjoUfrAY03ekqXhZUhvxHlu0d8FgL9DgT598McQKBgQDxaUwrXJeVOA1A4YiUhKshM14kPiNqYOZDyBrsJ+ghWozargEz0lbW18gDNK3RWoDeX2sUoF/0G/v86Tj4PcC/9Xbrqz99FuoFe1VOVLLihdzIbvwUp/KNC9OfLPBoSDShKRFuJPQqlooB0tBEQvfeDN25icCHKQW3+VRugD85mQKBgQDFznVx7ZPSDyuSQVr/11lionhJg9aw5ST9UyC2wKvB776FkVVQLLBzMmBxRtS/TGKYaz3YSd4/g2sxq2LBUe8SedcSOr5QWVJU9fDij5imM0iZ7xQEESsiy5EGNX3w+kOI+03JfaFhdxCFLVyjH60VoABKR+cMJHRtToQbH0KjSwKBgAxtrVw2Ih+uiRAkDFIJGn5VFK2s/UnGv1QSA0DRNSQyczn251zxoULiTQvNNH2ouSW5p9uh/g6lOi3lG+e71iaLzpmHcXdRLK8nkFa+CY+b8Kfo/tVZaCVWzIhPWfkkboE1ig4vnNpscaJyZgJ9qCEobGnW67CJrh+wmGYv+BFRAoGASatS4lNxMlKkD5x3n8E8cRfBZN/NHaS52f8Tt/yZ+2imtGgkNe/u53hjosyWf4ibT9jg96TLOSxgx+bkqMszFtZ52zg1mQcrOqk+RaLlX0DKUUpRUhJy1kqqgH17ojwS2vl9RwWbDQmjBXaXgclSVTN56DBPRJ5vHiaX3OIPl3ECgYBEnhsM7DoGTmF5rdXj+JHYi9h5m8tA3hJEY6xWpDqIYOs4geciFtV8XPjmdYcrBJ1Sf4xu9vqMPcVZfJMU7KJNOOpz4rNSYpc1Z7Lfl7zsUnrGmaj6/dw/5QTbE5uneRB6JyjG9hMF9Eg1rEvMCl7pv6ya6WLcpS+0ZY6ZaRD+Hw=="
    }],
  "default_protocol_version": "yop-auth-v2",
  "sdk_version": "1.1.0"
}

####配置文件命名规范 默认配置文件名

yop_sdk_config_default.json

多配置文件命名方式

yop_sdk_config_{appKey}.json

只有一个配置文件时，该配置文件即默认配置文件（无论文件名是不是yop_sdk_config_default.json）； 当有多个配置文件时，则必须指定默认配置文件（通过default配置项）,不指定的情况下第一个配置文件作为默认配置；

默认配置文件读取路径(classPath)

/config

如何覆盖默认配置文件

在 VM arguments 中指定配置文件路径 -Dyop.sdk.config.file 配置文件路径，多个配置文件用逗号分隔，文件路径必须为全路径，示例如下： -Dyop.sdk.config.file=file://home/app/yop_sdk_config_default.json,file://home/app/yop_sdk_config_yop-boss.json

####自定义 如果用户不能使用文件配置方式或者需要更自由的配置方式（例如从数据库加载sdk配置等），只需实现自定义配置提供方接口并注册，示例如下：

//全局设置
AppSdkConfigProvider provider = new MockCacheAppSdkConfigProvider("test", 30L, TimeUnit.SECONDS)
AppSdkConfigProviderRegistry.registerCustomProvider(provider);

。。。发起请求

1.实现提供方接口

  • 可以直接实现接口AppSdkConfigProvider
    • AppSdkConfig是最小配置单元，包含指定appKey的所有配置信息
    • 如果用户配置有多个appKey，需要指定默认appKey，默认appKey的相关资源配置（请求地址，httpClient配置，代理配置等）是sdk实际采用的来源
package com.yeepay.g3.sdk.yop.config;

public interface AppSdkConfigProvider {
 
    /**
     * 获取指定appKey的sdk配置
     *
     * @param appKey appKey
     * @return app sdk配置
     */
    AppSdkConfig getConfig(String appKey);
 
    /**
     * 获取默认的应用sdk配置
     *
     * @return app sdk配置
     */
    AppSdkConfig getDefaultConfig();
 
    /**
     * 获取指定appKey的sdk配置，如果不存在则返回默认配置
     *
     * @param appKey appKey
     * @return app sdk配置
     */
    AppSdkConfig getConfigWithDefault(String appKey);
}

  • sdk提供了一些工具类便于用户实现

    • BaseFixedAppSdkConfigProvider用于sdk配置无需变化只需初始化一次的场景，需实现如下方法：
       /**
   * 加载用户自定义sdk配置
   *
   * @return 用户自定义sdk配置列表
   */
   protected abstract List<SDKConfig> loadCustomSdkConfig();
   provider在初始化的时候会调用该方法进行初始化工作，默认AppSdkConfig需要在相关SDKConfig中将default项配置为true，如果没有则会将读取到的第一个配置项作为默认配置，示例如下

     ```  java
   public class MockFixedSDKConfigProvider extends BaseFixedAppSdkConfigProvider{

       /**
        * sdk配置加载repository，用于从数据库加载sdk配置
        */
       private SDKConfigRepository repository;

       @Override
       protected List<SDKConfig> loadCustomSdkConfig() {
           return repository.queryAllConfig();
       }
   }

* BaseCachedAppSdkConfigProvider 用于sdk配置动态变化的场景，该类中会缓存相关配置并定时刷新以获取最新的配置，，需实现如下方法：

/**
     * 加载sdk配置
     * 缓存会（首次加载、缓存过期、异步刷新）触发该方法去获取最新的配置
     *
     * @param appKey appKey
     * @return sdk配置
     */
    protected abstract SDKConfig loadSDKConfig(String appKey);
        ```
该类在初始化的时候必须指定默认appKey和缓存过期时间，示例如下：
        ``` java
        public class MockCachedSDKConfigProvider extends BaseCachedAppSdkConfigProvider{

        /**
         * sdk配置加载repository，用于从数据库加载sdk配置
         */
        private SDKConfigRepository repository;

        public MockCachedSDKConfigProvider(String defaultAppKey, Long expire, TimeUnit timeUnit) {
            super(defaultAppKey, expire, timeUnit);
        }

        /**
         * 缓存会（首次加载、缓存过期、异步刷新）触发改方法去获取最新的配置
         *
         * @param appKey appKey
         * @return
         */
        @Override
        protected SDKConfig loadSDKConfig(String appKey) {
            return repository.queryConfig(appKey);
        }

2，注册提供方 要想让自定义的提供方生效，需要向AppSdkConfigProviderRegistry（默认情况下采取文件提供方DefaultFileAppSdkConfigProvider）注册，示例如下：

AppSdkConfigProviderRegistry.registerCustomProvider(myProvider);

代码示例

// QA 环境
// YopRequest request = new YopRequest("<Your appKey>", "<Your appSecret>");
YopRequest request = new YopRequest();

// 演示普通参数传递
request.addParam("address", "13812345678");

// 演示本地文件参数传递
request.addFile(new File("src/test/resources/log4j.xml"));

// 演示本地文件流参数传递
FileInputStream stream = new FileInputStream(new File("/Users/dreambt/SiteMesh Flow Diagram.png"));
request.addFile(stream);

// 演示远程文件参数传递
request.addFile(new URL("https://www.yeepay.com/logo.png").openStream());

System.out.println(request.toQueryString());
YopResponse response = YopClient3.postRsa("/rest/v2.0/auth/idcard", request);

测试用商户私钥RSA2048

MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQCXsKWWClznZbdTwp9183e4Ygu/ twbQhuS6LPpu/TZ+OFwwauvIZnOyKu+rFh6apKyVxiLEkssnTsBjLjUIlypEGU2SdLGkswWAPvVd unLjjWEz37W2w4VNkGf8bGCQ9fIxMynoBCTeeWcQz896e1y2p5YZHygUhXGLM/9q5mr3iQQgrEPd FEAdlfLexkbVIF2bS02NsDFLNvqKNk7219cefxWPgJfN7RukUIZyy4nbeevbMAAFpNUFh1NlAh4q zwocOfbZ3NgtwJDf29jibpM3dacS7tqYGwpeGpKazS9tZgTAYcX2kLT7s+G6vVzVQR61pvvDs5ub yfsw/KFR8KDDAgMBAAECggEAShSE6Z+p+4AbZhaYVbxPbYbEgh5af6BBOAMbUvTqlf3kV+j/uWD/ g7WgUod87r0ZZBPdiu69tDarkkRQth9NDvDkh2/iCbM8LoOQxPN3hFXZcMICNn2KLnUls4siJelX HFwGTT8o2lWj1fwHMaPphXKWxTIIGu2IpBkC1iwtdTF8mqe2HH+H2djBE96JXVZIf3/FgGu8ppmX a/xG4DfrTxFnGEJzgaadT3Z+ybXbqjYgFgmmBnZOaTx1XPQfLGQVYJz9BunDhwhrqBUM+QuLr1jU sMsj/Yud52cNXjwq9z8FfkKUdVVfE4VrzH8JpKKk7Vim7RWBQER29jlEnV+ysQKBgQDjMWxZz4Av eXxWSx7MgXN9PEzxzmGWSApseDskSi5PAmXa4ut5XyNJUiGJ8Zf+cssPfWFNtB7suJBuoMTtrQSa p2tgoo70y7QSO0ZlZ0v5Ny9LYh8oHvDgBJVNmS5HWv1U1/VHxNHczNmQ05smXNo1bzMYe5Xo10J2 W47UUTgOHwKBgQCq7G6B5RfD+O1jdmYWlilh5oi1XGdYJGnzhs9DmAUN5plQ3VxpUFxxQCgOwXCs kfT9QUVYhsIpQIs2iCylwuNDuxxiEQyRpeBirRaqmxvosv08Trwsr1Vs/Cuh17ZZOS+OUehN0fDZ CiruK4e2btVfv8LlE1KMuoiUsn1X2gWQ3QKBgCyqBrcRSA4NQBhm5EMoH+A6/pV7EUxOFV6FtHrJ 6pi1y/hgLBLMVU+Qye8og80OHEWLTJnOE1ZOYnadPJnNLd6Jk16IFrqhYWFELe65hAIWi0GypJVq n8gqnn+G4cY9aRhI7HuTgf56dzs1nobIMk3W8qCZizsfNn22OjobTX3ZAoGBAJsTusvF1IMs5g05 DjTt9wvpQx3xgZ46I5sdNA3q7qMHFxGEVeUDUWw7Plzs61LXdoUU5FsGoUEWW3iVopSett3r9TuQ pmu7KVO+IXOXGYJOa259LUQJrKMeRGQpuDtJpDknXXLFyRTSodLH0fEWrCecb7KxjlM6ptLrAshj emtNAoGBAMzGo6aNER8VZfET8Oy0i5G8aVBp6yrMiQsNOj4S1VPoHI+Pc6ot5rDQdjek9PRzF9xe CU4K7+KLaOs6fVmTfsFpPbDafCTTmos9LGr5FIyXpU7LQCl3QPHWPDd5ezsu9SPVjzsEPX3WTSOJ uUA8hE7pJnAzMHLGAFpIXJRu3Z/y

测试用商户公钥RSA2048

MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAl7Cllgpc52W3U8KfdfN3uGILv7cG0Ibk uiz6bv02fjhcMGrryGZzsirvqxYemqSslcYixJLLJ07AYy41CJcqRBlNknSxpLMFgD71Xbpy441h M9+1tsOFTZBn/GxgkPXyMTMp6AQk3nlnEM/PentctqeWGR8oFIVxizP/auZq94kEIKxD3RRAHZXy 3sZG1SBdm0tNjbAxSzb6ijZO9tfXHn8Vj4CXze0bpFCGcsuJ23nr2zAABaTVBYdTZQIeKs8KHDn2 2dzYLcCQ39vY4m6TN3WnEu7amBsKXhqSms0vbWYEwGHF9pC0+7Phur1c1UEetab7w7Obm8n7MPyh UfCgwwIDAQAB

易宝生产公钥RSA2048

-----BEGIN RSA2048 PUBLIC KEY BLOCK----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6p0XWjscY+gsyqKRhw9MeLsEmhFdBRhT 2emOck/F1Omw38ZWhJxh9kDfs5HzFJMrVozgU+SJFDONxs8UB0wMILKRmqfLcfClG9MyCNuJkkfm 0HFQv1hRGdOvZPXj3Bckuwa7FrEXBRYUhK7vJ40afumspthmse6bs6mZxNn/mALZ2X07uznOrrc2 rk41Y2HftduxZw6T4EmtWuN2x4CZ8gwSyPAW5ZzZJLQ6tZDojBK4GZTAGhnn3bg5bBsBlw2+FLkC QBuDsJVsFPiGh/b6K/+zGTvWyUcu+LUj2MejYQELDO3i2vQXVDk7lVi2/TcUYefvIcssnzsfCfja orxsuwIDAQAB -----END RSA2048 PUBLIC KEY BLOCK-----

易宝生产公钥RSA4096

-----BEGIN RSA4096 PUBLIC KEY BLOCK----- MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArbJ1oNf7JmQ5k9HxebaxPet34gzTOPXu LNQJZ8LsgfiDs/J6k8pv3xahGaGWddF+Hl0JYKov69eoOe7aMIvg6M9hM+mz/7bEo2N3IjsgN3gb YxxJAD0zPZsYfcRnjdtjsahDD1sUcarzjQte7mNdUOLwp4bGbYRiudaxZv9aRngonubf5trCk4V0 c0EuJJQPi8X3iUbKebS/ou1CpDi47b0tPyNr69bgd7wtnazVdf7gTJyL1hL9yw6OFPL+HoUQwCLk wl87oi4kdUlw7Y9LCjpveesIwroo8bB8rQdvtbugjHRuzbbxwy4k5ls8icqUjzj1fHAlJ6xJZpJB /tUK37CnDZd+D/sryXeAvclz/d5F1PszE/bseEgn48CWV4H1iiNw1+xKUhnobBnDjPkLUtJ7o2sR 5392KpJLuRb8jJe5On25u3FUPA/tQQID1T07rkbC1KhKuXoiDMTmFqxKz/v1BbFWjWhBuxQOaqkz o4jqs2JgtwU5JR4XnQlAWLPYv6QMuBa+G8/26Zpun1A9JOztpRKBTaTeQ5olX6Oq4hjdfCL9GBh8 N5OjuAlOY7hJYwRdv9YdOUcf5yfgGgDIKNpGRqEJBUSQGVQiEnwO93QZOIaoGmld/gzjnN+zVFkK evf+n+LRMqQlb1RU9oKOcv4g0GW5mojWy3Fy6UI32kUCAwEAAQ== -----END RSA4096 PUBLIC KEY BLOCK-----

4. 详细说明

###4.1. 应用-密钥配置 默认使用YopConfig.setXXX初始化appKey及AES密钥（商户身份仅需设置Hmac密钥） 开放平台默认调用地址为https://open.yeepay.com/yop-center

如需非生产环境联调，需手动设置调用地址：

YopConfig.setServerRoot("http://qa.yeepay.com:18083/yop-center");

如需同时使用多个appKey则通过

YopRequest(String appKey, String secretKey)初始化请求对象

###4.2. 请求 传参：

request.addParam("address", "13812345678");

相同参数名自动构建为数组参数

签名：使用YopClient发起请求自动签名 签名逻辑 (1) 所有请求参数按参数名升序排序，数组/列表值排序; (2) 按 请 求 参 数 名 及 参 数 值 相 互 连 接 组 成 一 个 字 符 串 :...; （注：restful接口自动将URI作为method参数参与签名） (3) 将应用密钥分别添加到以上请求参数串的头部和尾部:<请求参数字符串>; (4) 对该字符串按指定算法（默认为SHA1） 签名 (5) 该签名值使用sign系统级参数一起和其它请求参数一起发送给服务开放平台

发起请求：

YopResponse response = YopClient.get("/rest/v1.0/notifier/blacklist/add", request);

###4.3. 响应 YopResponse主要内容是状态、业务结果、错误/子错误 业务结果被解析为Map，可直接取值；

若觉得Map型结果不便于使用，可通过response.unmarshal(xxx.class)反序列化为自定义java对象；

若不想自定义java对象，response.getStringResult()即为字符串形式的业务结果，格式为request指定格式（json/xml)，可直接做json/xml解析。

SDK已提供工具类方法YopMarshallerUtils.parse支持json解析，具体解析方法可自选。

###4.4. 验签 请求是必须做签名验证的，SDK&YOP自动完成

响应结果也可签名，通过request.setSignRet(true)指定（默认不做结果签名），YopResponse自动验签

某些API指使用非SHA1签名算法，请求对象需明确指定，示例：request.setSignAlg("SHA");

###4.5. 加解密 某些API参数使用明文参数有安全风险，如支付接口可能需要传信用卡CVV码，这些信息明确要求不能明文传输，为此需要对请求进行加密

SDK中，通过request.setEncrypt(true)指定此请求需加密，当前支持AES及Blowfish加解密算法，开放应用调用使用AES、商户身份调用使用Blowfish

请求加密则响应默认加密，YopResponse自动解密、验签、反序列化

###5. 沙箱 沙箱网关是为了提高接入效率而提供的专门部署环境，开启沙箱模式以后，所有的请求都将发送到沙箱网关（不会发生实际业务调用），方便联调。 因此sdk引入了mode参数，mode的可选值为prod（生产），sandbox（沙箱），不配置的情况下默认为prod。 开启沙箱环境有两种方法：

  • 配置文件中配置mode=sandbox,示例如下：

      {
    "app_key": "test",
    "aes_secret_key": "xxx",
    "server_root": "http://openapi.yeepay.com/yop-center",
    "yos_server_root": "http://yos.yeepay.com/yop-center",
    "sandbox_server_root": "http://sandbox.yeepay.com/yop-center",
    "yop_public_key": [
      {
        "store_type": "string",
        "cert_type": "RSA2048",
        "value": "xxx"
      }
    ],
    "isv_private_key": [
      {
        "store_type": "string",
        "cert_type": "RSA2048",
        "value": "xxx"
      }
    ],
    "http_client": {
      "connect_timeout": 10000,
      "read_timeout": 30000,
      "max_conn_total": 2000,
      "max_conn_per_route": 1000
    },
    "mode": "sandbox"
  }

  • 配置jvm启动参数-Dyop.sdk.mode=sandbox,jvm参数的优先级高于配置文件，如果在jvm中指定了mode，实际使用的mode即jvm中的mode， 配置文件中的mode不生效。

注意：

  • 多配置文件的情况下，各个配置文件均可以配置自己的mode，各个配置文件中的appKey发起的请求，按照各自文件中的mode分发（前提是jvm中没有配置mode）
  • 若请求了沙箱网关，在成功接收到沙箱网关的返回结果后会打印一条日志来说明正常请求到了沙箱环境，日志内容为：response from sandbox-gateway

##6. 常见问题

###6.1. 报错：Java Security: Illegal key size or default parameters

说明：异常java.security.InvalidKeyException:illegal Key Size的解决方案

  1. 在官方网站下载JCE无限制权限策略文件（JDK7的下载地址： http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html
  2. 下载后解压，可以看到local_policy.jar和US_export_policy.jar以及readme.txt
  3. 如果安装了JRE，将两个jar文件放到%JRE_HOME%\lib\security目录下覆盖原来的文件
  4. 如果安装了JDK，将两个jar文件放到%JDK_HOME%\jre\lib\security目录下覆盖原来文件

About

No description or website provided.

Topics

sdk rsa sha256 yop

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

1 star

Watchers

5 watching

Forks

1 fork
Report repository

Releases

32 tags

Packages

No packages published

Contributors 2

  •  
  •  

Languages