API接口文档
为开发人员提供完整的API接口参考,帮助快速集成和使用我们的服务。
API版本
v1.0.0
接口总数
6 个接口
接口列表
浏览和查找所有可用的API接口,包括请求参数和响应格式。
创建地址(需要验签)
POST
创建地址
/api/v1/watch/address
生成地址时需要验签,form-data 格式
请求体
{"body": "string","nonce": "string","timestamp": "string","sign": "string","api_key": "string"}
{"body": "{"main_coin_id": "int"}}
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| body | string | 是 | body为json格式 |
| nonce | string | 是 | 6位随机数 |
| timestamp | string | 是 | 时间戳(秒) |
| sign | string | 是 | 签名,格式为Md5(body+api_secret+nonce+timestamp) |
| api_key | string | 是 | APIKey(平台获取) |
| 以下为body配置参数 | |||
| main_coin_id | int | 是 | 获取token信息接口返回的chain_id(配置body的参数) |
响应格式
{ "code": 200, "data": "0x44e172688B7d2aECE45C850451B31Ac27D44d203", "msg": "" }
返回参数数据模型
响应根结构
| 字段名 | 类型 | 描述 |
|---|---|---|
| code | int | 响应状态码 |
| message | string | 响应消息 |
| data | string | 响应数据 |
创建提现申请(需要验签)
POST
创建提现申请
/api/v1/withdraw
创建提现申请时需要验签,form-data 格式
请求体
{"body": "string","nonce": "string","timestamp": "string","sign": "string","api_key": "string"}
{"body": "{"main_coin_id": "int","address":"string","coin_address":"string","amount":"string","business_id":"string","open_id":"string","memo":"string"}"}
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| body | string | 是 | body为json格式 |
| nonce | string | 是 | 6位随机数 |
| timestamp | string | 是 | 时间戳(秒) |
| sign | string | 是 | 签名,格式为Md5(body+api_secret+nonce+timestamp) |
| api_key | string | 是 | APIKey(平台获取) |
| 以下为body配置参数 | |||
| main_coin_id | int | 是 | 获取token信息接口返回的chain_id(配置body的参数) |
| coin_address | string | 是 | 代币地址(配置body的参数) |
| address | string | 是 | 提现地址(配置body的参数) |
| amount | string | 是 | 提现金额(配置body的参数) |
| business_id | string | 是 | 业务编码,确保唯一即可(配置body的参数) |
| open_id | string | 是 | 标识,用户下不可重复(配置body的参数) |
| memo | string | 否 | 备注(配置body的参数) |
响应格式
{ "code": 200, "data": "", "msg": "成功" }
返回参数数据模型
响应根结构
| 字段名 | 类型 | 描述 |
|---|---|---|
| code | int | 响应状态码 |
| message | string | 响应消息 |
| data | string | 返回数据 |
充值回调通知(需要验签)
POST
充值回调通知
接口地址需要在平台配置
充值回调通知时需要验签,form-data 格式
请求体
{"body": "string","nonce": "string","timestamp": "string","sign": "string"}
{"body": "{"uuid": "string","from": "string","to": "string","network": "string", "hash": "string","gas": "string","amount": "string","events": [{"from": "string","to": "string","amount": "string","token_id": "string","ca": "string"},{"from": "string","to": "string","amount": "string","token_id": "string","ca": "string"}]}}
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| body | string | 是 | body为json格式 |
| nonce | string | 是 | 6位随机数 |
| timestamp | string | 是 | 时间戳(秒) |
| sign | string | 是 | 签名,格式为Md5(body+api_secret+nonce+timestamp) |
| 以下为body配置参数 | |||
| uuid | string | 是 | 回调的唯一 ID(配置body的参数) |
| from | string | 是 | 发送地址(配置body的参数) |
| to | string | 是 | 接收地址(配置body的参数) |
| network | string | 是 | 主网id 也就是chain_id(配置body的参数) |
| hash | string | 是 | 交易哈希(配置body的参数) |
| gas | string | 是 | 手续费(配置body的参数) |
| amount | string | 是 | 金额(配置body的参数) |
| events | string | 是 |
events[0]:主币交易(ca = "1" 表示主币,等于 network) events[1]:代币交易(ca 合约地址)(配置body的参数) |
| 以下为events配置参数 | |||
| token_id | string | 是 | 币种id(配置events的参数) |
| ca | string | 是 |
events[0]:主币地址(ca = "1" 表示主币,等于 network) events[1]:代币合约地址(配置events的参数) |
响应格式
{ "code": 200, "data": "", "msg": "" }
返回参数数据模型
响应根结构
| 字段名 | 类型 | 描述 |
|---|---|---|
| code | int | 响应状态码 |
| message | string | 响应消息 |
| data | string | 返回数据 |
提现回调通知(需要验签)
POST
提现回调通知
接口地址需要在平台配置
提现回调通知时需验签,form-data 格式
请求体
{"body": "string","nonce": "string","timestamp": "string","sign": "string"}
{"body": "{"address": "string","amount": "string","coin_type": "string","decimals": "string","main_coin_type": "string","trade_id": "string","business_id": "string","tx_hash": "string","status": "int","memo": "string"}"}
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| body | string | 是 | body为json格式 |
| nonce | string | 是 | 6位随机数 |
| timestamp | string | 是 | 时间戳(秒) |
| sign | string | 是 | 签名,格式为Md5(body+api_secret+nonce+timestamp) |
| 以下为body配置参数 | |||
| address | string | 是 | 提现地址(配置body的参数) |
| amount | string | 是 | 提现金额(配置body的参数) |
| coin_type | string | 是 | 提现币种(配置body的参数) |
| decimals | string | 是 | 提现币种精度(配置body的参数) |
| main_coin_type | string | 是 | chain_id bsc是56(配置body的参数) |
| trade_id | string | 是 | 提现id(配置body的参数) |
| business_id | string | 是 | 提现业务id(配置body的参数) |
| status | int | 是 | 状态(配置body的参数) 待审核1 审核成功2 审核驳回3 交易成功4 交易失敗5 |
| tx_hash | string | 是 | 交易哈希(配置body的参数) |
| memo | string | 是 | 提现备注(配置body的参数) |
响应格式
{ "code": 200, "data": "", "msg": "" }
返回参数数据模型
响应根结构
| 字段名 | 类型 | 描述 |
|---|---|---|
| code | int | 响应状态码 |
| message | string | 响应消息 |
| data | string | 返回数据 |
获取所有token
GET
获取token
/api/v1/tokens/all
获取所有token,无需验签
响应格式
{ "code": 200, "data": {"id": "string","chain_name": "string","chain_id": "string","address": "string","name": "string", "symbol": "string","decimals": "string","total_supply": "string","is_erc20": "string","type": "string"} ,"msg": "" }
返回参数数据模型
响应根结构
| 字段名 | 类型 | 描述 |
|---|---|---|
| code | int | 响应状态码 |
| message | string | 响应消息 |
| data | string |
响应数据下拉查看
|
响应数据
创建openID(需要验签)
POST
创建openID
/api/v1/openID
生成地址时需要验签,form-data 格式
请求体
{"body": "string","nonce": "string","timestamp": "string","sign": "string","api_key": "string"}
{"body": "{"open_id": "string"}"}
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| body | string | 是 | body为json格式 |
| nonce | string | 是 | 6位随机数 |
| timestamp | string | 是 | 时间戳(秒) |
| sign | string | 是 | 签名,格式为Md5(body+api_secret+nonce+timestamp) |
| api_key | string | 是 | APIKey(平台获取) |
| 以下为body配置参数 | |||
| open_id | string | 是 | 标识,用户下不可重复(配置body的参数) |
响应格式
{ "code": 200, "data": "", "msg": "" }
返回参数数据模型
响应根结构
| 字段名 | 类型 | 描述 |
|---|---|---|
| code | int | 响应状态码 |
| message | string | 响应消息 |
| data | string | 响应数据 |
使用指南
如何有效地使用我们的API接口。
Code码
| 状态码 | 描述 | 说明 |
|---|---|---|
| 200 | OK | 请求成功 |
| 40122 | The Nonce cannot be empty | Nonce不能为空 |
| 40124 | The Timestamp cannot be empty | 时间戳不能为空 |
| 40123 | The Sign cannot be empty | 签名不能为空 |
| 40125 | Body parsing error | Body解析错误 |
| 10103 | Parameter binding error | 参数绑定错误 |
| 40139 | The IP is not on the whitelist | IP不在白名单中 |
| 40127 | Invalid main currency configuration | 主币配置无效 |
| 40128 | RPC connection failed | 连接RPC失败 |
| 40137 | Address format error | 地址格式错误 |
| 40129 | Sign error | 签名错误 |