Introduction

ConnexionSDK Open API v1.0.0

1 Integration Preparations

• Request API Key and Secret Key
• Whitelist the external API requesting IP
• Integrate API according to the doc below

2 Basic Information

2.1 API basic information

• The following base endpoints are available: https://openapi.connexion.games
• All ports require API Key
• All ports respond with JSON format
• For GET actions, parameters required to be sent in query string
• For POST actions, parameters required to be sent in request body

2.2 IP restriction

• Whitelist is required for external visiting IPs

2.3 Required parameters in request header

• content-type: application/json
• X-CONNEXION-APIKEY: ${APIKEY}
• X-CONNEXION-SIGNATURE: ${SIGNATURE}

ps: ${APIKEY}is the API Key requested in rule 1, ${SIGNATURE} is the generated signature according to rule 2.4

2.4 Required parameter

2.5 Signature generating rules

• Arrange all fields (excluding the fields in request header) in ascending order of the fields’ key value, then concatenate them according to key=value&key=value.....the string is named s1
• We use HMAC SHA256 method for signature. The SecretKey that corresponds to APIKEY is used as the key for HMAC SHA256，s1 is the target of HMAC SHA256, the resulting output is s2
• Turn s2 into lower case letters and now you obtain the signature

We are providing API SDK in three languages:

• Java
• JavaScript & TypeScript
• Golang

3 Ports

3.1 Userlist requesting port

Description

• Requesting user lists that are from the guild

Path

• /user/list

Method

• GET

Parameters

Sample Input Parameter:

timestamp=1234567890&currentPage=1&pageSize=10

Output

Sample Response:

{
    "msg": "success",
    "code": 0,
    "data": [
        {
            "uid": "12345",
            "roleName": "name",
            "roleType": "warrior",
            "level": "33",
            "militaryCapability": "23580",
            "ranking": "10"
        },
        ...
    ],
    "total": 1
}

3.2 User info requesting port

Description

• Requesting info of users that are from the guild

Path

• /user/info

Method

• GET

Parameters

Sample Input Parameter:

uid=1234523456&timestamp=1234567890

Output

Sample Response:

{
    "msg": "success",
    "code": 0,
    "data": {
            "uid": "12345",
            "roleName": "name",
            "roleType": "warrior",
            "level": "33",
            "militaryCapability": "23580",
            "ranking": "10",
            "extraData":  {

            }
    }
}

3.3 User fighting capacity ranking port

Description

• Requesting user fighting capacity ranking information

Path

• /global/topList/militaryCapability

Method

• GET

Parameters

Sample input parameters:

topNum=100&timestamp=1234567890

Output

Sample output:

{
    "msg": "success",
    "code": 0,
    "data": [
        {
            "roleName": "12345",
            "value": "23580",
            "ranking": "10"
        },
        ...
    ]
}

3.4 User level ranking port

Description

• Request user level ranking information

Path

• /global/topList/roleLevel

Method

• GET

Parameters

Sample input parameters:

topNum=100&timestamp=1234567890

Output

Sample output:

{
    "msg": "success",
    "code": 0,
    "data": [
        {
            "roleName": "12345",
            "value": "23580",
            "ranking": "10"
        },
        ...
    ]
}

3.5 User 1v1 pvp rating ranking port

Description

• Request user 1v1 pvp rating ranking info

Path

• /global/topList/pvpPoints/1v1

Method

• GET

Parameters

Sample input parameters:

topNum=100&timestamp=1234567890

Output

Sample output:

{
    "msg": "success",
    "code": 0,
    "data": [
        {
            "roleName": "12345",
            "value": "23580",
            "ranking": "10"
        },
        ...
    ]
}

3.6 User 3v3 pvp rating ranking port

Description

• Request user 3v3 pvp rating ranking information

Path

• /global/topList/pvpPoints/3v3

Method

• GET

Parameters

Sample input parameters:

topNum=100&timestamp=1234567890

Output

Sample output:

{
    "msg": "success",
    "code": 0,
    "data": [
        {
            "roleName": "12345",
            "value": "23580",
            "ranking": "10"
        },
        ...
    ]
}

3.7 User improved fighting capacity ranking port

Description

• Request user ranking information in respect to fighting capacity improvement over a certain period

Path

• /global/topList/fightingImprove

Method

• GET

Parameters

Sample input parameters:

topNum=100&timestamp=1234567890

Output

Sample output:

{
    "msg": "success",
    "code": 0,
    "data": [
        {
            "roleName": "12345",
            "value": "23580",
            "ranking": "10"
        },
        ...
    ]
}

3.8 User onchain data search port

Description

• Based on user's wallet address, search for onchain data

Path

• /user/chainInfo

Method

• GET

Parameters

Sample input parameters:

address=0xF387a991234785B2D9d8f9826822BeCD367D5678&timestamp=1234567890

Output

Sample output:

{
    "msg": "success",
    "code": 0,
    "data": {
            "minted": true,
            "deposited": true,
            "extraData":  {

            }
    }
}

4 Error Code