API One Pager

API 文档登录

一、消息推送

Gethttps://open.debox.pro/openapi/messages/group/send

向群组发文字消息，调用示例：

curl -X POST -H "Content-Type: application/json" \
-H "X-API-KEY: t2XAlEF6......" \
-d '{"to_user_id":"uvg2p6ho","group_id":"fxi3hqo5",\
"object_name":"RC:TxtMsg","message":"i am message sent by bot"}' \
"https://open.debox.pro/openapi/messages/group/send"

Parameters

Query

group_id : String 群组的group_id。代表往哪个群组发消息，非空

to_user_id : String 用户的userid。代表@群组的哪个用户，可为空

object_name : String 代表消息类型，文字消息，必须为RC:TxtMsg

message : String 文字消息字符串，非空

X-API-KEY : String 开发者的 key，可以在开放平台申请

Responses

200: OK

{
  "code":200,
  "data":null,
  "message":"success",
  "success":false
}

Gethttps://open.debox.pro/openapi/messages/group/send

向群组发图片文字消息，从上到下排版顺序为图片、title、content、图片，其中content为富文本，可以插入任意超链接。调用示例：

  curl -X POST -H "Content-Type: application/json" \
  -H "X-API-KEY: t2XJ........lEF6" \
  -d '{"group_id":"l3ixp32y","object_name":"RCD:Graphic","title":"我是标题","content":"i am 富文本 \
  {\"uitag\":\"a\",\"text\":\"点击我\",\"href\":\"https://debox.pro/\"}将跳转"}' \
  "https://open.debox.pro/openapi/messages/group/send"

Parameters

Query

group_id : String 群组的group_id。代表往哪个群组发消息，非空

to_user_id : String 用户的userid。代表@群组的哪个用户，可为空

object_name : String 代表消息类型，图片文字消息，必须为RCD:Graphic

title : String 代表图文消息的文字标题

content : String 代表图文消息的主体部分，为富文本，可以插入超链接和图片

1、超链接
示例： {"uitag":"a","text":"USDC","href":"https://debox.pro/deswap"}
“uitag”="a"，表示一个超链接。
将以下 json 转成字符串，放到 content 里，在 DeBox 的 App 里将显示一个带 Href 的超链接
var uiA = {
uitag: "a",
text: text,
href: href,
}
uitag =”a”，表示是个文字超链接
text 表示超链接文字
href 表示点击跳转页面

2、图片
示例：{"uitag":"img","src":"https://domain.com/a.png","position":"foot","height":"500","href":""}
uitag="img" ，表示是一副图片，将以图片的形式进行展示。
将以下 json 转成字符串，放到 content 里，在 DeBox 的 App 里将显示一个带 Href 的超链接
var uiImg = {
uitag: "img",
src: "<https://domain.com/a.png>",
position: "foot",
href: "<https://debox.pro>",
height: "500",
}
src：图片地址，为空时只显示占位
position 表示显示位置
为 head 时，表示该图片显示在顶部,在 title 的前面
为 foot 时，表示该图片显示在底部
为其他时，隐藏图片不显示任何东西
href 表示点击后的跳转页面
为 DeBox 白名单地址时，直接打开
为非白地址时，则弹提示警告框
为空、或者没有定义时，显示放大的图片
height 表示图片的高度
height> =0 ，则图片高度为 height，
height<0、没配置、配置的不是数字时，则用默认值。iOS、Android 顶部图片高度默认值为 115；底部图片高度默认值 230；
height=0 时，不显示

3、一个 content 的例子：
项目名称 成交量
{"uitag":"a","text":"USDT","href":"https://debox.pro/deswap"} 96.78k
{"uitag":"a","text":"USDC","href":"https://debox.pro/deswap"} 81.74k
{"uitag":"a","text":"OP_ETH","href":"https://debox.pro/deswap"} 2.55k
{"uitag":"a","text":"BNB","href":"https://debox.pro/deswap"} 3.95
{"uitag":"img","src":"https://domain.com/a.png","position":"head","height":”300”,"href":"https://www..."}
{"uitag":"img","src":"https://domain.com/b.png","position":"foot","height":"500","href":"https://www..."}

显示样例：

纯文字：
alt text
上图下文

上文下图：

上图中文下图:

Header

X-API-KEY : String 开发者的 key，可以在开放平台申请

Responses

200: OK

{
  "code":200,
  "data":null,
  "message":"success",
  "success":false
}

Gethttps://open.debox.pro/openapi/messages/private/send

向私人发消息，调用示例：

curl -X POST -H "Content-Type: application/json" \
-H "X-API-KEY: t2XAlEF6......" \
-d '{"to_user_id":"uvg2p6ho","object_name":"RCD:Command","message":"i am message"}' \
"https://open.debox.pro/openapi/messages/private/send"

Parameters

Query

to_user_id : String 用户的userid。代表消息的接受者，非空

object_name : String 代表消息类型，私聊消息，必须为RCD:Command

message : String 具体的消息内容，非空

Header

X-API-KEY : String 开发者的key，可以在开放平台申请

Responses

200: OK

{
  "code":200,
  "data":null,
  "message":"success",
  "success":false
}

二、获取用户昵称、头像及钱包地址等用户信息

Gethttps://open.debox.pro/openapi/user/info

获取用户基础信息，使用示例:

curl -X GET -H "X-API-KEY: t2XAlEF6......" \
"https://open.debox.pro/openapi/user/info?user_id=uvg2p6ho"

Parameters

Query

user_id : String 用户的userid。在登录授权时可以获得授权用户的userid

X-API-KEY : String 开发者的 key，可以在开放平台申请

Responses

200: OK

{
    "code": 1,
    "data": {
        "name": "ltx", // 用户昵称
        "wallet_address": "0xsadf......34df", // 钱包地址
        "avatar": "https://data.debox.space/nfts/0x67a7f09c/699-1.png",// 头像地址
        "uid": "fxidfef4" // 用户id和 user_id一样
    },
    "message": "成功",
    "success": true
}

Gethttps://open.debox.pro/openapi/user/is_follow

验证某用户是否关注另一个用户，使用示例:

curl -X GET -H "X-API-KEY: t2XAlEF6......" \
"https://open.debox.pro/openapi/user/is_follow?\
walletAddress=0x2267......&chain_id=1&followAddress=0xB63219a8E0D367d87BA1c8B0736CbfDbf2cD459F"

Parameters

Query

walletAddress : 关注者的钱包地址

followAddress : 被关注者的钱包地址

Header

X-API-KEY 开发者的key，可以在开放平台申请

Responses

200: OK

{"case3702":false}

400: Bad Request

{"error":"Bad Request","code":400,"message":"You X-API-KEY is not available"}

401: Unauthorized

{"error":"Bad Request","code":401,"message":"Param error"}

三、社区（群组）信息

Gethttps://open.debox.pro/openapi/group/info

获取当前群组信息，使用示例:

curl -X GET -H "X-API-KEY: t2XAlEF6......"  \
"https://open.debox.pro/openapi/group/info?\
group_invite_url=https://m.debox.pro/group?id=fxi3hqo5"

Parameters

Query

group_invite_url : 群组分享 url，在 app 端，点击群分享，复制链接即可获得

X-API-KEY : 开发者 key,在开放平台可以获取

Responses

200: OK

# is_charge 检查是否为PayEClub
# subchannel_number 子频道数量
# group_name 群组名称
# group_number 群组人数
# group_pic 群封面图
# create_time 创建时间
# maximum 最大群组人数上限
# mod MOD名称
{
    "code": 200,
    "data": {
        "is_charge": true,
        "subchannel_number": 3,
        "group_name": "aaa",
        "group_number": 29,
        "group_pic": "https://data.debox.pro/static/2022/09/19/static/2022/09/19/100009_1435000131.jpg",
        "create_time": "2022-04-30 16:03:24",
        "maximum": "500",
        "mod": [
            "MOD1",
            "MOD2"
        ]
    },
    "message": "success",
    "success": true
}

400: Bad Request

{"error":"Bad Request","code":400,"message":"You X-API-KEY is not available"}

Gethttps://open.debox.pro/openapi/group/is_join

验证用户是否加入了某群组，使用示例:

curl -X GET -H "X-API-KEY: t2XAlEF6......" \
"https://open.debox.pro/openapi/group/is_join?\
walletAddress=0x2267......&url=https://m.debox.pro/group?id=fxi3hqo5"

Parameters

Query

walletAddress : 钱包地址，代表要验证的用户

url : 群组分享URL ，代表某个群，在群组聊天页面，点击右上角的分享，点击“复制链接”获得

chain_id : 区块链网络ID，默认值1，以太坊主网

Header

X-API-KEY : 在开放平台后台获取

Responses

200: OK

{"case3701":false}

400: Bad Request

{"error":"Bad Request","code":400,"message":"You X-API-KEY is not available"}

401: Unauthorized

{"error":"Bad Request","code":401,"message":"Param error"}

四、动态、点赞、用户间的关注关系

Gethttps://open.debox.pro/openapi/moment/praise_info

获取钱包地址对应用户发的所有动态获得的点赞信息，使用示例:

curl -X GET -H "X-API-KEY: t2XAlEF6......" \
"https://open.debox.pro/openapi/moment/praise_info?\
wallet_address=0x2267......&chain_id=1"

Parameters

Path

moment/praise_info

Query

wallet_address : 钱包地址，代表某个用户

chain_id : 区块链网络ID，默认值1，以太坊主网

X-API-KEY : 开发者的key，可以在开放平台申请

Responses

200: OK

# receive_praise_total 自己获得的点赞总数
# send_praise_total    给别人点赞的总数
{
    "code": 1,
    "data": {
        "receive_praise_total": 46,
        "send_praise_total": 208
    },
    "message": "success",
    "success": true
}

400: Bad Request

{"error":"Bad Request","code":400,"message":"You X-API-KEY is not available"}

Gethttps://open.debox.pro/openapi/moment/give_praise

判断某个用户是否给某条动态点赞，使用示例:

curl -X GET -H "X-API-KEY: t2XAlEF6......" \
"https://open.debox.pro/openapi/moment/give_praise?\
wallet_address=0x2267......&chain_id=1&moment_id=oo0epx1p"  

Parameters

Query

wallet_address : 钱包地址，代表某个用户

chain_id : 区块链网络ID，默认值1，以太坊主网

moment_id : 动态ID，代表某个动态

Header

X-API-KEY :开发者的key，可以在开放平台申请

Responses

200: OK

# is_praise 是否已点赞
{
    "code": 1,
    "data": {
        "is_praise": false
    },
    "message": "success",
    "success": true
}

400: Bad Request

{"error":"Bad Request","code":400,"message":"You X-API-KEY is not available"}

Gethttps://open.debox.pro/openapi/moment/receive_praise

获取某个动态点赞总数、以及所有点赞用户，使用示例:

curl -X GET -H "X-API-KEY: t2XAlEF6......" \
"https://open.debox.pro/openapi/moment/receive_praise?moment_id=oo0epx1p"

Parameters

Query

moment_id : 动态ID，代表某个动态

Header

X-API-KEY 开发者的key，可以在开放平台申请

Responses

200: OK

# receive_praise_total  被点赞数
{
    "code": 1,
    "data": {
        "receive_praise_total": 1
        "praise_users":[{"name":"xxx","wallet_address":"0x3e52...","avatar":"https://data...png","uid":"0yz..."}]
    },
    "message": "success",
    "success": true
}

400: Bad Request

{"error":"Bad Request","code":400,"message":"You X-API-KEY is not available"}

五、投票、抽奖

Gethttps://open.debox.pro/openapi/vote/info

获取钱包地址用户在某群组的投票数量

Parameters

Query

wallet_address : 钱包地址，代表某个用户

chain_id : 区块链网络ID，默认值1，以太坊主网

group_invite_url : 群组分享url，代表某个群组

X-API-KEY 开发者的 key，可以在开放平台申请

Responses

200: OK

# vote_number  投票数量
{
    "code": 200,
    "data": {
        "vote_number": 6//投票数量
    },
    "message": "success",
    "success": true
}

400: Bad Request

{"error":"Bad Request","code":400,"message":"You X-API-KEY is not available"}

Gethttps://open.debox.pro/openapi/lucky_draw/info

获取钱包地址用户在某群组的抽奖数量

Parameters

Query

wallet_address : 钱包地址，代表某个用户

chain_id : 区块链网络ID，默认值1，以太坊主网

group_invite_url : 群组分享url，代表某个群组

Header

X-API-KEY 开发者的 key，可以在开放平台申请

Responses

200: OK

# initiate_luckDraw_total 发起抽奖总次数
# luckDraw_total 参与抽奖总次数
# luckDraw_win_total 中奖总次数
{
    "code": 1,
    "data": {
        "initiate_luckDraw_total": 3,
        "luckDraw_total": 3,
        "luckDraw_win_total": 3
    },
    "message": "success",
    "success": true
}

400: Bad Request

{"error":"Bad Request","code":400,"message":"You X-API-KEY is not available"}

六、红包

Gethttps://open.debox.pro/openapi/lucky_box/user

获取钱包地址用户收/发的红包信息

Parameters

Path

moment/praise_info

Query

wallet_address : 钱包地址，代表某个用户

chain_id : 区块链网络ID，默认值1，以太坊主网

X-API-KEY 开发者的 key，可以在开放平台申请

Responses

200: OK

# receive_luckyBox_number  领取红包个数
# receive_luckyBox_total 领取红包数量（金额）
# send_luckyBox_number 发送红包个数
# send_luckyBox_total 发送红包数量（金额）
{
    "code": 1,
    "data": {
        "receive_luckyBox_number": 12,
        "receive_luckyBox_total": 1235.9,
        "send_luckyBox_number": 18,
        "send_luckyBox_total": 3199.58
    },
    "message": "success",
    "success": true
}

400: Bad Request

{"error":"Bad Request","code":400,"message":"You X-API-KEY is not available"}

Gethttps://open.debox.pro/openapi/lucky_box/user/group

某个用户在特定群组领取红包的数目

Parameters

Query

wallet_address : 钱包地址，代表某个用户

chain_id : 选择要从中获取数据的区块链网络

group_invite_url : 群组分享url，代表某个群组

Header

X-API-KEY 开发者的 key，可以在开放平台申请

Responses

200: OK

# receive_luckyBox_number  领取红包数量
{
    "code": 1,
    "data": {
        "receive_luckyBox_number": 8//领取红包数量
    },
    "message": "success",
    "success": true
}

400: Bad Request

{"error":"Bad Request","code":400,"message":"You X-API-KEY is not available"}

Gethttps://open.debox.pro/openapi/lucky_box/group

获取当前群组发放红包总量，使用示例:

curl -X GET -H "X-API-KEY: t2XAlEF6......" \
"https://open.debox.pro/openapi/lucky_box/group?\
group_invite_url=https://m.debox.pro/group?id=fxi3hqo5"

Parameters

Query

group_invite_url : 群组分享 url ，代表某个群

Header

X-API-KEY ：

Responses

200: OK

# sum_amount 发送vDBX数量
# total_num 发送的个数
{
    "code": 200,
    "data": {
        "sum_amount": 3896,
        "total_num": 30
    },
    "message": "success",
    "success": true
}

400: Bad Request

{"error":"Bad Request","code":400,"message":"You X-API-KEY is not available"}

七、授权登录

DeBox授权登录是基于OAuth2.0 协议标准构建的登录系统，详细介绍

Gethttps://app.debox.pro/oauth/authorize

在DeBox App中，点击该链接，跳转至授权界面，用户在该界面点击允许或取消。用户允许授权后，页面会跳转到重定向地址，并携带 code & userId & sourse

https://app.debox.pro/oauth/authorize/?
app_id=ohpdAP9W55gyXeJ0&grant_type=authorization_code&scope=payment&response_type=code&
pay_info=loginTest&redirect_uri=https://docs.debox.pro/demo/a.html

Parameters

Query

redirect_uri : String 授权成功后的回调地址。当用户点击授权后，app会将获得的code作为参数回调该地址，需要用encodeURIComponent编码

app_id : String 应用唯一标识，DeBox开发者社区申请

scope : String 授权域:payment代表支付授权 moment代表打赏消息授权

grant_type : String 表示授权方式是授权码：authorization_code

Posthttps://open.debox.pro/openapi/oauth2/access_token

获取第一步的 code 后，请求以下链接获取 access_token：

  curl --location --request GET
  https://open.debox.pro/openapi/oauth2/access_token?
  grant_type=authorization_code&code=ZDY5ZTA......FRE5
  &app_id=xxxxxx&app_secret=xxxxxx&user_id=xxxxxx

Parameters

Query

grant_type : String 表示授权方式是授权码：authorization_code

code : String 第一步获取的 code

app_id : String 应用唯一标识，DeBox开发者社区申请

app_secret : String 开放平台申请的app_secret

user_id : String 授权用户的user_id

Responses

200: OK

  {
      "code": 1,
      "data": {
          "access_token":
          "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODgzOTQ4MDMsInN1YiI6IjEwMzA1O
  CJ9.hbEt8JthQvo85iGkhUiPpTlcII4n3hgOYDErUDS9X2kkOnsNM27pAO_x9WP4KEE_33uFEd6GOgS
  A51MlYZakb1",
          "expires_in": 1,
          "refresh_token": "MDBMOWYZYWYTZMRLYS01ODRHLWJKYTUTZGFIMMU1ZDEZNWM3",
          "token_type": ""
  },
      "message": "success",
      "success": true
  }

401: Failed

  { 
    "code": 401, 
    "message": "Bad Request", 
    "success": false 
  }

Posthttps://open.debox.pro/openapi/oauth2/refresh_token

刷新access_token

curl --location --request GET
https://open.debox.pro/openapi/oauth2/refresh_token?
grant_type=refresh_token&refresh_token=YTNMYMZJZMY......ZTAH
&app_id=xxxxxx&app_secret=xxxxxx&user_id=xxxxxx

Parameters

Query

grant_type : String 表示授权方式是授权码：refresh_token

refresh_token : String 第二步获取的 refresh_token

app_id : String 应用唯一标识，DeBox开发者社区申请

app_secret : String 开放平台申请的app_secret

user_id : String 授权用户的user_id

Body

access_token : 授权得到的code

serial_id : 授权得到的流水号（订单号）

Responses

200: OK

  {
      "code": 1,
      "data": {
          "access_token":
          "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODgzOTQ4MDMsInN1YiI6IjEwMzA1O
  CJ9.hbEt8JthQvo85iGkhUiPpTlcII4n3hgOYDErUDS9X2kkOnsNM27pAO_x9WP4KEE_33uFEd6GOgS
  A51MlYZakbg",
          "expires_in": 1,
          "refresh_token": "MDBMOWYZYWYTZMRLYS01ODRHLWJKYTUTZGFIMMU1ZDEZNWM3",
          "token_type": ""
  },
      "message": "success",
      "success": true
  }

401: Failed

 {
  "code": 401,
  "message": "Bad Request",
  "success": false
}

八、授权支付

DeBox提供了基于vDBX的支付授权接口，为vDBX提供更广阔的应用场景。

Gethttps://app.debox.pro/oauth/authorize

⼀次性token请求接⼝,该接口用来生成积分支付的订单号和token，和下面的/payment/transfer接口联合使用完成积分支付功能。

Parameters

Query

redirect_uri : String 授权成功跳转链接，需要用encodeURIComponent编码

app_id : String 应用唯一标识，DeBox开发者社区申请

scope : String 授权范围（payment）

grant_type : String 授权类型（onetime_token）

amount : Number 金额，最多两位小数

payer_user_id : String 发送方user_id。pay_type为send时，该参数为授权用户的user_id；pay_type为receive时，该参数为第三方开发者的user_id

receiver_user_id : String 接收方user_id。pay_type为send时，该参数为第三方开发者的user_id；pay_type为receive时，该参数为授权用户的user_id

pay_type : String 代表授权用户的角色。该参数为send代表授权用户是支付方，该参数为receive时代表授权用户是收款方

pay_info : String 转账信息，用于提示支付的场景

Responses

200: OK

{ 
      "code": "xxx", // 授权token，⽤于转账请求 有效期5分钟
      "serial_id": "xxx",  // 订单号
      "source ": "debox" // 来源
}

Posthttps://open.debox.pro/openapi/payment/transfer

转账接口

Parameters

Query

app_id : 应用的app_id

app_secret : 应用的密钥 AppSecret，DeBox开发者社区申请

Body

access_token : 授权得到的code

serial_id : 授权得到的流水号（订单号）

Responses

200: OK

{ 
      "code": "", // 错误码，1为成功
      "msg": "",  
      "source ": "debox" // 来源
}

API错误码

-2001 ⽤户登录有效性问题，可尝试重新登录
-2004 参数不合法
-2006 交易参数不合法
-2010 获取access token，code过期
-2011 获取access token，无效code
-2012 刷新access token失败
-2013 access token过期
-2014 系统异常，请重试
-2015 access token 校验失败
-2016 重复发起转账请求
-2028 系统异常，请重试
-2030 系统异常，请重试
-7048 余额不⾜，转账失败
-7052 系统异常，请重试

API 文档 登录​

一、消息推送​

Gethttps://open.debox.pro/openapi/messages/group/send​

Parameters​

Query​

Header​

Responses​

200: OK​

Gethttps://open.debox.pro/openapi/messages/group/send​

Parameters​

Query​

Header​

Responses​

200: OK​

Gethttps://open.debox.pro/openapi/messages/private/send​

Parameters​

Query​

Header​

Responses​

200: OK​

二、获取用户昵称、头像及钱包地址等用户信息​

Gethttps://open.debox.pro/openapi/user/info​

Parameters​

Query​

Header​

Responses​

200: OK​

Gethttps://open.debox.pro/openapi/user/is_follow​

Parameters​

Query​

Header​

Responses​

200: OK​

400: Bad Request​

401: Unauthorized​

三、社区（群组）信息​

Gethttps://open.debox.pro/openapi/group/info​

Parameters​

Query​

Header​

Responses​

200: OK​

400: Bad Request​

Gethttps://open.debox.pro/openapi/group/is_join​

Parameters​

Query​

Header​

Responses​

200: OK​

400: Bad Request​

401: Unauthorized​

四、动态、点赞、用户间的关注关系​

Gethttps://open.debox.pro/openapi/moment/praise_info​

Parameters​

Path​

Query​

Header​

Responses​

200: OK​

400: Bad Request​

Gethttps://open.debox.pro/openapi/moment/give_praise​

Parameters​

Query​

Header​

Responses​

200: OK​

400: Bad Request​

Gethttps://open.debox.pro/openapi/moment/receive_praise​

Parameters​

Query​

Header​

Responses​

200: OK​

400: Bad Request​

五、投票、抽奖​

Gethttps://open.debox.pro/openapi/vote/info​

Parameters​

Query​

Header​

Responses​

API 文档登录

一、消息推送

Gethttps://open.debox.pro/openapi/messages/group/send

Parameters

Query

Header

Responses

200: OK

Gethttps://open.debox.pro/openapi/messages/group/send

Parameters

Query

Header

Responses

200: OK

Gethttps://open.debox.pro/openapi/messages/private/send

Parameters

Query

Header

Responses

200: OK

二、获取用户昵称、头像及钱包地址等用户信息

Gethttps://open.debox.pro/openapi/user/info

Parameters

Query

Header

Responses

200: OK

Gethttps://open.debox.pro/openapi/user/is_follow

Parameters

Query

Header

Responses

200: OK

400: Bad Request

401: Unauthorized

三、社区（群组）信息

Gethttps://open.debox.pro/openapi/group/info

Parameters

Query

Header

Responses

200: OK

400: Bad Request

Gethttps://open.debox.pro/openapi/group/is_join

Parameters

Query

Header

Responses

200: OK

400: Bad Request

401: Unauthorized

四、动态、点赞、用户间的关注关系

Gethttps://open.debox.pro/openapi/moment/praise_info

Parameters

Path

Query

Header

Responses

200: OK

400: Bad Request

Gethttps://open.debox.pro/openapi/moment/give_praise

Parameters

Query

Header

Responses

200: OK

400: Bad Request

Gethttps://open.debox.pro/openapi/moment/receive_praise

Parameters

Query

Header

Responses

200: OK

400: Bad Request

五、投票、抽奖

Gethttps://open.debox.pro/openapi/vote/info

Parameters

Query

Header

Responses