API

2017-11-28  本文已影响0人  放开那个女巫

对外API
系统接口
用户接口:

API

version 1.0

用户登录

用于用户登录,手机号码作为账号,并输入密码。
数据格式:json

请求:

参数 类型 必须 说明
phoneNumber string 手机号码为用户的登录账号
password string 登录密码应为MD5加密后的密文
areacode string 地区码,如中国为86
{
  "phoneNumber":"××××××" ,
  "password":"××××××"
  "areacode":"××××××"
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
token string
phoneNumber string 手机号码为用户的登录账号
userid int 用户的id
imgurl string 用户请求头像的地址
areacode string
ethaddress string 用户的eth地址
message string 一些文本说明,可有可无
{
  "code" : 0 ,
  "message":"success",
  "data":{
      "token":"××××××",
      "phonenumber":"××××××",
      "userid":——,
      "imgurl":"××××××"
      "areacode":"××××××",
      "ethaddress":"××××××",
    }
 } 
{
  "code" : 302 ,
  "message":"failed",
  "data":{
      "token":null
    }
 } 

校验版本

校验版本

请求:

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
message string 一些文本说明,可有可无
versionName string 用以在APP上显示版本号
versionCode int 真正用来校验APK版本的
apkurl string APK的下载链接

|changelog|||

{
  "code" : 0 ,
  "message":"success",
  "data":{
      "versionCode":_______,
      "versionName":"××××××",
      "url":"××××××",
       "changelog":"××××××"
    }
 } 

token过期

当检测到token过期时,会返回一个状态吗,并要求重新登录
数据格式:json

请求:

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
token string
phoneNumber string 手机号码为用户的登录账号
userid int 用户的id
message string 一些文本说明,可有可无
{
  "code" : 303 ,
  "message":"token timeout",
  "data":null
 } 

用户注册 ——请求获取验证码

该API用于向服务器请求一个短信验证码,故只需要正确的手机号码即可。
数据格式:json

请求:

参数 类型 必须 说明
areaCode string 用户的国家区码,如中国大陆的区码为86
phoneNumber string 待获取验证码的手机号码
{
 "phoneNumber":"××××××",
 "areaCode":"××××××"
}

返回:

-参数类型:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
message string 一些文本说明,可有可无
{
  "code" : 0 ,
  "message":"send success",
  "data":null
 } 
{
  "code" : 315 ,
  "message":"the phone-number is not exit",
  "data":null
 } 

用户注册 ——注册

输入之前已请求过的验证码,交给后端进行匹配

请求:

参数 类型 必须 说明
phoneNumber string 待获取验证码的手机号码
areaCode string 用户的国家区码,如中国大陆的区码为86
checkCode string 验证码
password string 待设置的密码
username string 待注册的用户名
{
 "phoneNumber":"××××××",
 "checkCode":"××××××"
  "areacode":"××××××",
 "password":"××××××"
 "username":"××××××"
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
message string 一些文本说明,可有可无
{
  "code" : 0 ,
  "message":"regist success",
  "data":null
 } 
{
  "code" : 413 ,
  "message":"regist failed",
  "data":null
 } 

忘记密码 ——请求获取验证码

该API用于向服务器请求一个短信验证码,故只需要正确的手机号码即可。
数据格式:json

请求:

参数 类型 必须 说明
areaCode string 用户的国家区码,如中国大陆的区码为86
phoneNumber string 待获取验证码的手机号码
{
 "phoneNumber":"××××××",
 "areaCode":"××××××"
}

返回:

-参数类型:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
message string 一些文本说明,可有可无
{
  "code" : 0 ,
  "message":"send success",
  "data":null
 } 
{
  "code" : 315 ,
  "message":"the phone-number is not exit",
  "data":null
 } 

忘记密码 ——重设密码

输入之前已请求过的验证码,以及待设置的密码,交给后端.

请求:

参数 类型 必须 说明
phoneNumber string 待获取验证码的手机号码
password string 待设置的密码
checkcode string 验证码
areaCode string 用户的国家区码,如中国大陆的区码为86
{
 "phoneNumber":"××××××",
 "checkcode":"××××××",
 "password":"××××××"
 "areacode":"××××××"
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
message string 一些文本说明,可有可无
{
  "code" : 0 ,
  "message":"reset success",
  "data":null
 } 
{
  "code" : 414,
  "message":"reset failed",
  "data":null
 } 

首页

请求:

参数 类型 必须 说明
token string
{
 "phoneNumber":"××××××" ,
 "token":"××××××",
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
totalIncom string 总的挖矿收益(totalIncom中第一个l是“小写的L”, 第二个I是“大写的i”)(需要前端string—>float64)
yestodayIncom string 昨日的挖矿收益(需要前端string—>float64)
currentPrice string 当前BCDN币的价格(需要前端string—>float64)
name string name用来区分广告图片,如果本地已有该图片name,就不必再向服务器下载图片
imgurl string 下载图片的链接
message string 一些文本说明,可有可无
{
  "code" : 0 ,
  "message":"index",
  "data":{
        "totalIncom": "××××××",
        "yestodayIncom" : "××××××",
        "currentPrice":"××××××",
        "totalValue":"××××××",
        "advertising":[
            {"name":"××××××", "imgurl":"××××××"},//当name为default的时候,就播放本地的默认广告位招商图片
            {"name":"××××××", "imgurl":"××××××"},
            {"name":"××××××", "imgurl":"××××××"},

        ]
    }
 } 

首页-资产导入查询

请求:

参数 类型 必须 说明
mailReceiver string 官网邮箱
webPassword string 官网密码 md+salt
checkCode string 邮件验证码
uid string 用户userid
{
 "mailReceiver":"××××××" ,
 "webPassword":"××××××",
 "checkCode":"××××××",
 "uid":"××××××",
}

返回:

参数 类型 必须 说明
RetCode int 代表当前请求的反馈结果,详解后文returecode
Description string
Err string
data string
{
  "RetCode" : 0 ,
  "Description ":"",
  "Err ":"",
  "data":{
         Btc: 0.0,
         Eth: 0.0,
         Bcdn: 0.0
    }
 } 

首页-资产导入提交

请求:

参数 类型 必须 说明
mailReceiver string 官网邮箱
webPassword string 官网密码 md+salt
uid string 用户userid
{
 "mailReceiver":"××××××" ,
 "webPassword":"××××××",
 "uid":"××××××"
}

返回:

参数 类型 必须 说明
RetCode int 代表当前请求的反馈结果,详解后文returecode
Description string
Err string
data string
{
  "RetCode" : 0 ,
  "Description ":"",
  "Err ":"",
  "data":{
    }
 } 

首页-内测挖矿收益导入查询

请求:

参数 类型 必须 说明
ethAddress string ETH地址
invitedCode string 内测试码
uid string 用户userid
{
 "mailReceiver":"××××××" ,
 "webPassword":"××××××",
 "uid":"××××××",
}

返回:

参数 类型 必须 说明
RetCode int 代表当前请求的反馈结果,详解后文returecode
Description string
Err string
data string
{
  "RetCode" : 0 ,
  "Description ":"",
  "Err ":"",
  "data":{
         Btc: 0.0,
         Eth: 0.0,
         Bcdn: 0.0
    }
 } 

首页-内测挖矿收益导入提交

请求:

参数 类型 必须 说明
ethAddress string ETH地址
invitedCode string 内测试码
uid string 用户userid
{
 "mailReceiver":"××××××" ,
 "webPassword":"××××××",
 "uid":"××××××",
}

返回:

参数 类型 必须 说明
RetCode int 代表当前请求的反馈结果,详解后文returecode
Description string
Err string
data string
{
  "RetCode" : 0 ,
  "Description ":"",
  "Err ":"",
  "data":{
    }
 } 

获得邮箱验证码

请求:

参数 类型 必须 说明
mailReceiver string 邮箱
{
 "mailReceiver":"××××××" 
}

返回:

参数 类型 必须 说明
RetCode int 代表当前请求的反馈结果,详解后文returecode
Description string
Err string
data string
{
  "RetCode" : 0 ,
  "Description ":"",
  "Err ":"",
  "data":{
    }
 } 

首页——预约抢码应用

请求:

参数 类型 必须 说明
phoneNumber string 手机号码
token string
{
 "phoneNumber":"××××××" ,
 "token":"××××××",
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
ethAddress string 视返回的code决定 用户的以太坊地址
reservationCode string 视返回的code决定 用户的预约码
timestamp int64 开奖的时间戳
time string 中奖时间
nickname string 中奖的用户名
timesofperson string 预约的人数
type int type
message string 一些文本说明,可有可无
list
message string 一些文本说明,可有可无
{
  "code" : 0 ,
  "message":"no ethAddress",
  "data":{
    "type": 1,
    "timestamp": ______,
    "timesofperson":"××××××"
  }
 } 
{
  "code" : 0 ,
  "message":"reservationCode",
  "data":{
      "type" :2,
      "ethAddress":"××××××"
      "timestamp": ______
    }
 } 
{
  "code" : 0 ,
  "message":"not time",
  "data":{
      "type" :3,
      "reservationCode":"××××××,
      "timestamp": ______
    }
 } 
{
  "code" : 0 ,
  "message":"make persistent efforts",
  "data":{
      "type" :4,
      "reservationCode":"××××××",
        "timestamp": ______ ,
        "list":[
        {time:"××××××",nickname:"××××××"},
        {time:"××××××",nickname:"××××××"},
        {time:"××××××",nickname:"××××××"},
        {time:"××××××",nickname:"××××××"},
        {time:"××××××",nickname:"××××××"},
        {time:"××××××",nickname:"××××××"},    
    ],
    }
 } 
{
  "code" : 0 ,
  "message":"Congratulations",
  "data":{
       "type" :5,
      "reservationCode":"××××××",
      "list":[
        {time:"××××××",nickname:"××××××"},
        {time:"××××××",nickname:"××××××"},
        {time:"××××××",nickname:"××××××"},
        {time:"××××××",nickname:"××××××"},
        {time:"××××××",nickname:"××××××"},
        {time:"××××××",nickname:"××××××"},    
    ],
        "timestamp": ______
    }
 } 

首页 ——预约抢码应用——绑定ETH——使用以太坊地址

请求:

url: https://ip:port/index/reservationCode/bindethaddr/forEth

参数 类型 必须 说明
phoneNumber string 手机号码
token string token
ethAddress string 用户想要参与抢码,就必须绑定一个eth地址,且地址中必须拥有1000以上的BCDN
type string 如果是抢码,则type为"checkCoin",如果是非抢码的绑定ETH地址,则type为"normal"
{
 "phoneNumber":"××××××",
 "token":"××××××",
 "ethAddress":"××××××"
  "type":"******"
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
ethAddress string 视返回的code决定 用户的以太坊地址
coins string 视返回的code决定 刚刚预提交的eth账户中BCDN的数量
message string 一些文本说明,可有可无
{
  "code" : 0 ,
  "message":"success",
  "data":{
      "ethAddress":"××××××"
    }
 } 
{
  "code" : 2000 ,
  "message":"sorry,you don`t have enough coins",
  "data":{
      "coins":"××××××
    }
 } 
{
  "code" : 2002 ,
  "message":"the wrong ethAddress",
  "data":null
 } 

首页 ——预约抢码应用——绑定ETH——使用gateio

请求:

url: https://ip:port/index/reservationCode/bindethaddr/forGateio

参数 类型 必须 说明
phoneNumber string 手机号码
token string token
ethAddress string 用户想要参与抢码,就必须绑定一个eth地址,且地址中必须拥有1000以上的BCDN
{
 "phoneNumber":"××××××",
 "token":"××××××",
 "ethAddress":"××××××"
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
ethAddress string 视返回的code决定 用户的以太坊地址
coins string 视返回的code决定 刚刚预提交的eth账户中BCDN的数量
message string 一些文本说明,可有可无
{
  "code" : 0 ,
  "message":"success",
  "data":{
      "ethAddress":"××××××"
    }
 } 
{
  "code" : 2000 ,
  "message":"sorry,you don`t have enough coins",
  "data":{
      "coins":"××××××
    }
 } 
{
  "code" : 2002 ,
  "message":"the wrong ethAddress",
  "data":null
 } 

首页 ——预约抢码应用——预约抢码

请求:

参数 类型 必须 说明
phoneNumber string 手机号码
token string token
{
 "phoneNumber":"××××××",
 "token":"××××××"
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
ethAddress string 视返回的code决定 用户的以太坊地址
coins string 视返回的code决定 刚刚预提交的eth账户中BCDN的数量
{
  "code" : 0 ,
  "message":"success",
  "data":{
      "reservationCode":"××××××
    }
 } 

首页 ——绑定额外挖矿码应用

请求:

参数 类型 必须 说明
phoneNumber string 手机号码
token string token
code string 待绑定的挖矿码RSA加密
{
 "phoneNumber":"××××××",
 "token":"××××××"
 "code”:"××××××"

}

返回:

成功

{
  "code" : 0,
  "message":"success",
  "data":null
 } 

失败1 - 挖矿码不存在

{
  "code" : 2101 ,
  "message":"it not exits",
  "data":null
 } 

失败2 - 挖矿码已经被绑定

{
  "code" : 2102 ,
  "message":"it belong to others",
  "data":null
 } 

失败2

钱包

请求:

参数 类型 必须 说明
phoneNumber string 手机号码
token string
{
 "phoneNumber":"××××××",
 "token":"××××××"
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
balance string 钱包余额(需要前端string—>float64)
takeOutReady string 待提现的金额(需要前端string—>float64)
{
  "code" : 0 ,
  "message":"welcome",
  "data":{
      "balance":"××××××" ,
      "takeOutReady":"××××××"
    }
 } 

钱包——挖矿收益

请求:

参数 类型 必须 说明
phoneNumber string 手机号码
token string
{
 "phoneNumber":"××××××",
 "token":"××××××"
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
income string 挖矿收益(需要前端string—>float64)
machineId int 矿机编号
totalincom string 总的挖矿收益(需要前端string—>float64)
yestodayincom string 昨天的收益(需要前端string—>float64)
date string 收益日期
{
  "code" : 0 ,
  "message":"welcome",
  "data":{
       "totalincom":"",
        "yestodayincom":"",
      "history":[
          {"machineId":——,"income":——,"date":"××××××"},
          {"machineId":——,"income":——,"date":"××××××"},
          {"machineId":——,"income":——,"date":"××××××"}
      ]
    }
 }

钱包——提现首页

请求:

参数 类型 必须 说明
phoneNumber string 手机号码
token string

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
balance float64 钱包余额
ethaddress string 将要提现至的eth地址
limit float64 今日的提现上限
fee string 提现的手续费
{
  "code" : 0 ,
  "message":"welcome",
  "data":{
       "balance":"××××××",
       "ethaddress":"××××××",
       "limit":______,
       "fee":"××××××",
     
    }
 } 

钱包——提现首页——查看提现历史

请求:

参数 类型 必须 说明
phoneNumber string 手机号码
token string

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
history json数组
date string 提现时间
amount float64 提现的数量
status int 提现的状态(1-Wait,2-success,3-false)
{
  "code" : 0 ,
  "message":"welcome",
  "data":{
      history:[
           {"date":"××××××","amount":"××××××","Statust":1},   
          {"date":"××××××","amount":"××××××","Statust":2},   
          {"date":"××××××","amount":"××××××","Statust":3},   
        ] 
    }
 } 

钱包——提现首页——执行提现

请求:

参数 类型 必须 说明
phoneNumber string 手机号码
checkCode string 提现验证码
amount string 提现的数量
token string

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
{
  "code" : 0 ,
  "message":"success",
  "data":null
 } 

我的

请求:

参数 类型 必须 说明
phoneNumber string 手机号码
token string
{
 "phoneNumber":"××××××",
 "token":"××××××"
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
userName string 如果用户没有设置用户名,则显示为空
ethAddress string 用户的eth地址
minnerCode string 用户的挖矿码,如果没有则显示为空
phoneNumber string 用户的手机号码
{
  "code" : 0 ,
  "message":"minner history",
  "data":{
      "userName":"××××××",
      "ethAddress":"××××××",
      "minnerCode":"××××××",
      "phoneNumber":"××××××"
    }
 } 

我的——上传更新头像

请求:

参数 类型 必须 说明
phoneNumber string 手机号码
token string
userid string 登录时服务端返回的userid
image file 上传的头像图片,用file类型上传(该file的name必须为user.img)
{
 "phoneNumber":"××××××",
 "token":"××××××",
 "userid":"××××××",
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode
imgurl string 请求头像的url

成功:

{
  "code" : 0 ,
  "message":"minner history",
  "data":null
 } 

失败:

{
  "code" : 304 ,
  "message":"minner history",
  " data":{
    "imgurl":"××××××"  
  }
 } 

我的——修改手机号码

调用该API之前,要先请求校验码

请求:

参数 类型 必须 说明
phoneNumber string 原手机号码
newPhoneNumber string 新手机号码
newAreaCode string 新手机号码的国际码
checkCode string 校验码
token string
{
 "phoneNumber":"××××××",
 "newPhoneNumber":"××××××",
 "token":"××××××",
 "newAreaCode" :"××××××",
"checkCode":"××××××",
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode

成功:

{
  "code" : 0 ,
  "message":"success",
  "data":null
 } 

失败:

{
  "code" : 305,
  "message":"failed",
  "data":null
 } 

我的——修改密码

调用该API之前,要先请求校验码

请求:

参数 类型 必须 说明
phoneNumber string 原手机号码
password string 旧密码
newPassword string 新密码
checkCode string 校验码
areacode string 区码
token string
{
 "phoneNumber":"××××××",
 "password":"××××××",
 "newPassword":"××××××",
 "token":"××××××",
 "checkCode":"××××××",
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode

成功:

{
  "code" : 0 ,
  "message":"success",
  "data":null
 } 

失败:

{
  "code" : 306,
  "message":"failed",
  "data":null
 } 

我的——修改昵称

请求:

参数 类型 必须 说明
phoneNumber string 原手机号码
username string 新的用户名
token string
{
 "phoneNumber":"××××××",
 "username":"××××××",
 "token":"××××××",
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode

成功:

{
  "code" : 0 ,
  "message":"success",
  "data":null
 } 

我的——我的挖矿码

参数 类型 必须 说明
phoneNumber string 手机号码
areacode string 手机区号
token string
{
 "phoneNumber":"××××××",
 "areacode":"××××××",
 "token":"××××××",
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode

成功:

{
    "RetCode":"0",
    "Description":"get arrayMinnerCode success",
    "Err":"",
    "data":{
        "CodeList":[
            {
                "code":"123123123"
            }
        ]
    }
}
参数 类型 必须 说明
phoneNumber string 原手机号码
username string 新的用户名
token string
{
 "phoneNumber":"××××××",
 "username":"××××××",
 "token":"××××××",
}

返回:

参数 类型 必须 说明
code int 代表当前请求的反馈结果,详解后文returecode

成功:

{
  "code" : 0 ,
  "message":"success",
  "data":null
 } 

返回码

有些接口返回code 有些是RetCode 请注意区分

备注:

上一篇 下一篇

猜你喜欢

热点阅读