ic1101_cocos_API.md 11 KB

IC1101 Cocos API

一、通用说明

通用前缀: http://192.168.7.231:7379/new_battle

请求方式: Get

测试客户端:

二、枚举定义

1.登录类型枚举 ChannelEnum
public enum ChannelEnum {
    WD(1, "wallect connect QR code"),
    MetaMask(2, "Metamask网页登录"),
    GameAccount(3, "游戏账号登录"),
    Guest(4, "游客登录"),
    UNKNOWN(1000, "未知");
}
2.钱包类型 WalletEnum
public enum WalletEnum {
    Game(1, "游戏小钱包"),
    Auth(2, "认证的WEB3钱包"),
    UNKNOWN(1000, "未知");
}
3.登录类型 LoginEnum
public enum LoginEnum {
    Cocos(1, "Cocos"),
    PcUe5(2, "PcUe5"),
    WebSite(3, "官网");
}

三、API列表

1.多渠道登录接口 /loginByChannel

image-20230215193208858

请求

参数名 类型 可否为空 是否参与加密 说明
channelId int 1.二维码walletconnect扫码登录 2.钱包登录metamask 3.传统账密登录 ,具体见ChannelEnum结构
account string 账号名
pwd string 密码
sign string md5加密值
timestamp string 时间戳 毫秒
loginType int 登录类型,具体见LoginEnum结构
http://127.0.0.1:7379/new_battle/loginByChannel?channelId=1&account=0xeccbc87e4b5ce2fe28308fd9f2a7baf3&sign=0f6aa27a4e529987d808162e38e731ef&timestamp=1676373020000

返回:

{
    "data": {
        "account": "a1",
        "authWallets": [
            {
                "address": "0xeccbc87e4b5ce2fe28308fd9f2a7baf3",
                "createAt": 1676459788011,
                "createTime": "2023-02-15 19:16:28",
                "id": 7
            }
        ],
        "bindAt": 1676530976623,
        "bindTime": "2023-02-16 15:02:56",
        "channelId": 1,
        "createAt": 1676459787846,
        "createTime": "2023-02-15 19:16:27",
        "edit": true,
        "email": "a1@qq.com",
        "id": 8,
        "inviteCode": "ADSFCSNPCU",
        "lastLoginAt": 1676530976623,
        "lastLoginIp": "127.0.0.1",
        "lastLoginTime": "2023-02-16 15:02:56",
        "nickName": "a1",
        "score": 0,
        "smallWallet": {
            "address": "0x00000000000000000000000000000000",
            "createAt": 1676459787993,
            "createTime": "2023-02-15 19:16:27",
            "hdIdx": 7,
            "id": 7
        },
        "status": 0,
        "token": "oZtH7N6ovx",
        "tokenExpireAt": 1676790176623,
        "tokenExpireTime": "2023-02-19 15:02:56"
    },
    "errCode": 0,
    "errMsg": "Success"
}
2 .web端账号绑定接口 /bindAccountWithWallet

牵涉到的功能

  • 邮箱验证码认证

  • 上级用户邀请码溯源后的积分增加

请求

参数名 类型 可否为空 是否参与加密 说明
token string 登录成功后获取的令牌
account string 账号名
pwd string 密码
email string 邮箱
emailCode string 邮箱验证码
srcInviteCode string 我上级的邀请码
sign string md5加密值
timestamp string 时间戳 毫秒
http://127.0.0.1:7379/new_battle/bindAccountWithWallet?account=a1&pwd=123456&email=a1@qq.com&emailCode=xjhung&srcInviteCode=loqsx&sign=0f6aa27a4e529987d808162e38e731ef&timestamp=1676373020000&token=kjumh

返回:

{
    "data": {
        "account": "a1",
        "authWallets": [
            {
                "address": "0xeccbc87e4b5ce2fe28308fd9f2a7baf3",
                "createAt": 1676459788011,
                "createTime": "2023-02-15 19:16:28",
                "id": 7
            }
        ],
        "channelId": 1,
        "createAt": 1676459787846,
        "createTime": "2023-02-15 19:16:27",
        "edit": true,
        "email": "a1@qq.com",
        "id": 8,
        "inviteCode": "ADSFCSNPCU",
        "lastLoginIp": "",
        "nickName": "a1",
        "score": 0,
        "smallWallet": {
            "address": "0x00000000000000000000000000000000",
            "createAt": 1676459787993,
            "createTime": "2023-02-15 19:16:27",
            "hdIdx": 7,
            "id": 7
        }
    },
    "errCode": 0,
    "errMsg": "Success"
}
3 .账号信息接口 /accountInfo

请求

参数名 类型 可否为空 是否参与加密 说明
token string 登录成功后获取的令牌
sign string md5加密值
timestamp string 时间戳 毫秒

请求

http://127.0.0.1:7379/new_battle/accountInfo?token=oZtH7N6ovx&sign=0f6aa27a4e529987d808162e38e731ef&timestamp=1676373020000

返回

{
    "data": {
        "account": "a1",
        "authWallets": [
            {
                "address": "0xeccbc87e4b5ce2fe28308fd9f2a7baf3",
                "createAt": 1676459788011,
                "createTime": "2023-02-15 19:16:28",
                "id": 7
            }
        ],
        "bindAt": 1676530976623,
        "bindTime": "2023-02-16 15:02:56",
        "channelId": 1,
        "createAt": 1676459787846,
        "createTime": "2023-02-15 19:16:27",
        "edit": true,
        "email": "a1@qq.com",
        "id": 8,
        "inviteCode": "ADSFCSNPCU",
        "lastLoginAt": 0,
        "lastLoginIp": "127.0.0.1",
        "nickName": "a1",
        "score": 0,
        "smallWallet": {
            "address": "0x00000000000000000000000000000000",
            "createAt": 1676459787993,
            "createTime": "2023-02-15 19:16:27",
            "hdIdx": 7,
            "id": 7
        },
        "status": 0,
        "token": "oZtH7N6ovx",
        "tokenExpireAt": 1676790176623,
        "tokenExpireTime": "2023-02-19 15:02:56"
    },
    "errCode": 0,
    "errMsg": "Success"
}
4 .账号拉新积分明细 /accountScoreDetails

请求

参数名 类型 是否必填 是否参与加密 说明
pageSize int 分页的单页最大记录数,-1代表不分页,获取所有数据,默认是10条
curIdx int 当前第几页,默认从0开始
token string 登录成功后获取的令牌
sign string md5加密值
timestamp string 时间戳 毫秒
http://127.0.0.1:7379/new_battle/accountScoreDetails?token=oc904uFv4f&sign=0f6aa27a4e529987d808162e38e731ef&timestamp=1676373020000

返回

{
    "data": [
        {
            "createAt": 1676623234384,
            "createTime": "2023-02-17 16:40:34",
            "dstAccountId": 10,
            "dstAccountName": "",
            "dstPoint": 100,
            "eventDesc": "成功注册增加100积分",
            "srcAccountId": 10,
            "srcPoint": 0
        }
    ],
    "errCode": 0,
    "errMsg": "Success",
    "totalSize": 1
}
5. 获取邮箱验证码 /mailCode

请求

参数名 类型 是否必填 是否参与加密 说明
email string 邮箱地址
sign string md5加密值
timestamp string 时间戳 毫秒
6. 忘记密码 /passwordForget

请求

参数名 类型 是否必填 是否参与加密 说明
account string 账号名
newPwd string 新密码
email string 邮箱地址
emailCode string 验证码
sign string md5加密值
timestamp string 时间戳 毫秒
7. 新用户注册 /accountRegister

请求

参数名 类型 是否必填 是否参与加密 说明
account string 账号
pwd string 新密码
email string 邮箱地址
emailCode string 验证码
sign string md5加密值
timestamp string 时间戳 毫秒
8. 绑定邮箱 /bindEmail

请求

参数名 类型 是否必填 是否参与加密 说明
account string 账号
pwd string 新密码
email string 邮箱地址
emailCode string 验证码
sign string md5加密值
timestamp string 时间戳 毫秒