微洽开放平台api接口规范.docVIP

微洽开放平台API接口规范 1、概述 本规范定义了微洽开放平台的接口API 1.1、最新版本 当前最新版本：V2.0 2、网络传输协议规范 2.1、网络传输协议 使用HTTP协议进行信息传输 2.2、HTTP请求地址 /openapi.do 2.3、HTTP请求方法 使用POST方法进行请求 2.4、HTTP内容类型 Content-Type: application/x-www-form-urlencoded 3、输入与输出格式规范 3.1、输入格式 默认的输入字符编码格式为UTF-8格式，输入参数说明： 业务数据,格式为BASE64编码的字符串,编码前的内容须加密处理 输出内容的数据类型包括： 普通列表项目布尔型(Boolean),例如isNew:true|false 数字型(Number),例如number:3.1415 字符串型(String),例如name:张三 对象类型(Object),null表示空对象，{…}表示非空对象，对象的属性可以是Boolean, Number, String, Object, Array 数组类型(Array)：[]表示空数组。数组的元素可以是Boolean, Number, String, Object, Array 通用输出值的格式为JSON格式： { success: boolean, //服务出现异常为false,其他为true error:string, //错误信息,success=false时携带此信息 errorCode:, //错误代码,用于错误的分类 data: Object/Array //返回值,类似Map对象或者Array数组对象 } success=true: 成功，此时error=null、errorCode=0，代表没有错误。其中data为返回的数据对象，data只可能是Object或Array类型 success=false: 失败，进一步查看errorCode确定错误的分类以确定下一步操作，对于每个接口来说，errorCode的情况可能都不一样，具体说明见各个接口的说明，确认错误类型后可查看data数据了解详细错误原因 批量处理只返回错误信息，无错误返回的表示处理成功 3.3、输入参数加密算法 输入参数中的data参数须使用企业私钥(Key)加密，企业管理员可在 微洽平台 获取企业私钥。登录在“管理- 企业设置-开发组信息” 页面获取接口密钥(Key)。 java代码加密方法如下，不同实现的程序语言请确保算法一致性: /** * AES算法加密文本 * @param secretKey 密钥 * @param originalString 需要加密的文本 * @return 加密的文本(Base64格式) * **/ public static String aesEncrypt(String secretKey, String originalString) { if (StringUtils.isEmpty(secretKey)) throw new IllegalArgumentException(this secretKey must not be empty); if (StringUtils.isEmpty(originalString)) throw new IllegalArgumentException(this originalString must not be empty); final byte[] byteKey = toByteArray(secretKey); SecretKeySpec skeySpec = new SecretKeySpec(byteKey, AES); try { Cipher cipher = Cipher.getInstance(AES/ECB/NoPadding); cipher.init(Cipher.ENCRYPT_MODE, skeySpec); byte[] originalBytes = originalString.trim().getBytes(UTF-8); if (originalBytes.length % 16 != 0) { byte[] newOriginalBytes = new byte[(originalBytes.length / 16 + 1) * 16]; System.arraycopy(originalBytes, 0, newOriginalBytes, 0, originalBytes.length); or