YUNMO API DOC

Before proceeding with integration, please contact YUNMO's business representatives to obtain your sandbox/production environment credentials and the merchant management console URL.

Interface Rules

1.Agreement Type

Transmission Protocol：HTTPS

Request Method：POST

Request header information：Content-Type: application/json

Character encoding：UTF-8

Signature Algorithm：MD5

2.Interface Address

Sandbox

production

https://sandbox-api.yunmo.io

3.Public Participation

All interface request parameters consist of common parameters + the data section, with the data section varying according to specific interface requirements. The common parameters are described as follows:

param	required	type	description
merchantNo	Y	String	Assigned merchant ID
token	Y	String	Request Token
requestTime	Y	Long	Request Timestamp
version	Y	String	Interface Version (current fixed value V1.0)
nonce	Y	String	16-character random string
sign	Y	String	Signature
data	\	Object	\

4.Common Response

All API responses consist of a common response plus data, where the data part contains the specific results of the request. The common response is described below:

param	type	description
code	String	For operation result codes, please refer to the response codes section in the appendix.
msg	String	Operation Result Explanation
timestamp	Long	Response Timestamp
data	Object	\

Signature Algorithm

All api in this document require a signature for access. You can verify your signature method by clicking 【Settings】 -> 【Signature Tool】 in the Merchant Management Console.

1. Steps for Generating a Signature

Let all sent or received data form a set M. Sort the keys of non-empty parameter values within set M in ascending order by ASCII code (lexicographical order). Concatenate them using the URL key-value pair format (i.e., key1=value1&key2=value2...) to form the string plainText.

Parameter names are case-sensitive.

Parameter NameASCII CodeSort in Ascending Order (Lexicographical Order)

If the parameter value is empty, it is excluded from the signature.

The sign field in the parameters does not participate in the signature.

The token field in the parameters is not included in the signature.

Certain parameters that are not involved in signing will be detailed in the API documentation.

The interface may add fields, when verifying signatures, all fields returned must be validated.

Append the secretKey obtained from the merchant backend's 【API Management】 menu to the end of plainText (ensure this secretKey is safeguarded; never include it in request parameters. If the secretKey is compromised, immediately reset it in the merchant center). This yields the signTemp string (i.e., plainText + secretKey). Apply MD5 encryption to signTemp to obtain the final encrypted result signValue. Place signValue into the sign field of the request parameters to complete the signing process.

2. Signature Example

Assuming a request for YUNMO's JSON data

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

Sort the json data by ASCII code and convert it into URL key-value pairs. The resulting plainText value is as follows:

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

Concatenate the value of plainText with the application's secretKey (assuming secretKey=1111111111111111) to obtain the value of signTemp as follows:

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

Perform MD5 encryption on the value of signTemp to obtain the 32-bit signValue, as follows:

6bf642b5fc7b10a6eae3b8ab5e7bbea2

Place the value of signValue into the sign field of the request parameters. The final request parameters sent to YUNMO are as follows:

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

1.1 Protocol Specification

YUNMO API DOC#

Interface Rules#

1.Agreement Type#

2.Interface Address#

3.Public Participation#

4.Common Response#

Signature Algorithm#

1. Steps for Generating a Signature#

2. Signature Example#