API

{{DOMAIN}} https://sdk.umiverse.io/

Signature Method: Follow the order provided in the documentation (excluding ts and sign), concatenate the corresponding parameter values into a string, append ts and UMI-API-KEY (provided by us) at the end, and then use MD5 to generate the signature.

Signature String

const text = `${merchantId}${action}${user}${amount}${limitTotal}${limitDay}${description}${ts}${KEY}`;

JavaScript Example:

// Signature Example
const KEY = "UMI-API-KEY";
let str = '';
// Iterate through the parameter object
for (const key in param) {
    if (param.hasOwnProperty(key)) {
        const value = param[key];
        // Concatenate parameter values into the string
        str += `${value}`;
    }
}
// Append the timestamp and secret key to the end of the string
str += `${ts}${KEY}`;
// Compute the MD5 hash value
const sign = md5(str);

Increase DivePoint

POST https://sdk.umiverse.io/quest/divepoint/inc

By calling this API, the game provider can increase the DivePoint balance for a user in the corresponding game on the UMI platform.

Request Body

Name	Type	Description
merchantId*	String	The unique Merchant ID assigned to your account.
extraParams	String	Additional attributes, provided as a JSON string or single string to include supplementary information.
sign*	String	The signature of the request parameters, used to verify the authenticity of the request.
ts*	Number	The current timestamp, e.g., 1699243390.
description*	String	A description of the quest or activity.
amount*	String	The number of DivePoints to be added.
user*	String	Umi platform account ID, provided by the Umi platform when the user logs into your game.
limitTotal*	Number	The total number of times a user can claim this reward. A value of 0 indicates no limit.
limitDay*	Number	The number of times a user can claim this reward in a single day. A value of 0 indicates no daily limit.
action*	String	Operational characteristic values, such as login or daily_quest.

200: OK SUCCESS

```json
{
    "statusCode": 200,
    "message": "success",
    "data": null,
    "count": 0
}
```

400: Bad Request Param Error

{
    "statusCode": 400,
    "message": [
        "merchantId should not be empty",
        "user should not be empty",
        "amount should not be empty",
        "description should not be empty",
        "ts should not be empty",
        "sign should not be empty"
    ],
    "error": "Bad Request"
}

422: Unprocessable Entity Signature Error And Others

{
    "statusCode": 422,
    "message": "signature not correct",
    "error": "Unprocessable Entity"
}