YUNMO接口文档

在开始接入之前，请联系YUNMO商务人员获取您的sandbox/prod环境账号密码，以及商户管理台地址。

接口规则

1.协议类型

传输协议：HTTPS

请求方式：POST

请求头信息：Content-Type: application/json

字符编码：UTF-8

签名算法：MD5

2.接口地址

沙箱环境

生产环境

https://sandbox-api.yunmo.io

3.公共入参

所有接口请求入参都是由公共入参 + data部分组成，data部分参考具体接口要求。公共入参说明如下：

参数名	是否可空	类型	说明
merchantNo	否	String	分配的商户编号
token	否	String	请求令牌
requestTime	否	Long	请求时间戳
version	否	String	接口版本(当前固定值V1.0)
nonce	否	String	16位随机字符串
sign	否	String	签名
data	\	Object	\

4.公共响应

所有接口返回都是由公共响应 +data组成，data部分为请求的具体结果。公共响应说明如下：

参数名	类型	说明
code	String	操作结果码，具体请参考附录响应码部分
msg	String	操作结果说明
timestamp	Long	响应时间戳
data	Object	\

签名算法

本文档所有接口均需要签名才能访问。您可以在商户管理台点击【更多设置】->【签名验证工具】来对您的签名方式进行校验。

1. 生成签名的步骤

设所有发送或者接收到的数据为集合 M，将集合 M 内非空参数值的key按照ASCII码从小到大排序（字典序），使用 URL 键值对的格式（即key1=value1&key2=value2...）拼接成字符串plainText

参数名区分大小写

参数名ASCII码从小到大排序（字典序）

如果参数的值为空不参与签名

参数中的sign字段不参与签名

参数中的token字段不参与签名

部分不参与签名的参数会在API文档中详细说明

接口可能增加字段，验证签名时必须支持验证返回的所有字段

在 plainText 尾部拼接上从商户后台【API】菜单中获取的 secretKey（请务必保管好该 secretKey，禁止将 secretKey 放到请求参数中，如果泄露了 secretKey，应当及时到商户中心重置 secretKey），便得到 signTemp 字符串（即 plainText + secreKey），并对 signTemp 进行 MD5 加密，得到最终加密结果 signValue，将 signValue 放到请求参数中的 sign 字段中，则完成了一次签名。

2. 签名示例

假设请求YUNMO的json数据

{
	"nonce": "TW4P54uVulwRoc2y",
	"merchantNo": "BU078255558",
	"token": "testToken",
	"requestTime": 1770712296681,
	"version": "v1.0",
	"data": {
		"customerCode": "test0001"
	}
}

将 json 数据按ASCII码排序并转换为 URL 键值对，得到plainText的值如下：

customerCode=test0001&merchantNo=BU078255558&nonce=TW4P54uVulwRoc2y&requestTime=1770712296681&version=v1.0

将plainText的值拼接上应用的secretKey（假设 secretKey=1111111111111111），得到 signTemp 的值如下：

customerCode=test0001&merchantNo=BU078255558&nonce=TW4P54uVulwRoc2y&requestTime=1770712296681&version=v1.01111111111111111

对signTemp的值进行 MD5 加密，得到32位的signValue的值如下

6bf642b5fc7b10a6eae3b8ab5e7bbea2

将signValue的值放到请求参数中的sign字段中，那么最终向 YUNMO 发送的请求参数如下:

{
	"sign": "6bf642b5fc7b10a6eae3b8ab5e7bbea2",
	"nonce": "TW4P54uVulwRoc2y",
	"merchantNo": "BU078255558",
	"token": "testToken",
	"requestTime": 1770712296681,
	"version": "v1.0",
	"data": {
		"customerCode": "test0001"
	}
}

协议规范

YUNMO接口文档#

接口规则#

1.协议类型#

2.接口地址#

3.公共入参#

4.公共响应#

签名算法#

1. 生成签名的步骤#

2. 签名示例#