Appearance
默认模块 接口文档
基本信息
- OpenAPI:
3.1.0 - 版本:
1.0.0 - Base URL:
https://api.example.com
鉴权
- 请求头:
X-Token - 获取方式: 请联系客服获取。
接口总览
| Method | Path | Summary |
|---|---|---|
| GET | /chains | 查询系统支持的链列表（仅返回启用状态的链）。 |
| GET | /tokens | 查询可用 Token 列表。 |
| GET | /chains/{chainCode}/tokens | 查询指定链下的可用 Token 列表。 |
| POST | /wallets/{userId}/getAddresses | 获取用户地址 |
GET /chains
说明: 查询系统支持的链列表（仅返回启用状态的链）。
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| X-Token | header | string | 是 | 请联系客服获取 |
请求体
无
响应
| 状态码 | Content-Type | Schema | 说明 |
|---|---|---|---|
| 200 | application/json | MultiResponseChainInfoView | 支持链列表 |
调用示例
bash
curl -X GET "https://api.example.com/chains" \
-H "X-Token: <请联系客服获取>"GET /tokens
说明: 查询可用 Token 列表。
可通过 chainCode 过滤指定链；不传则返回所有启用链下的可用 Token。
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| X-Token | header | string | 是 | 请联系客服获取 |
| chainCode | query | string | 否 | 链编码（可选），如 ETH、BSC、TRON |
请求体
无
响应
| 状态码 | Content-Type | Schema | 说明 |
|---|---|---|---|
| 200 | application/json | MultiResponseAllowedTokenView | 可用 Token 列表 |
调用示例
bash
curl -X GET "https://api.example.com/tokens?chainCode=<string>" \
-H "X-Token: <请联系客服获取>"GET /chains/{chainCode}/tokens
说明: 查询指定链下的可用 Token 列表。
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| X-Token | header | string | 是 | 请联系客服获取 |
| chainCode | path | string | 是 | 链编码，如 ETH、BSC、TRON |
请求体
无
响应
| 状态码 | Content-Type | Schema | 说明 |
|---|---|---|---|
| 200 | application/json | MultiResponseAllowedTokenView | 该链下的可用 Token 列表 |
调用示例
bash
curl -X GET "https://api.example.com/chains/:chainCode/tokens" \
-H "X-Token: <请联系客服获取>"POST /wallets/{userId}/getAddresses
说明: 获取用户地址
参数
| 名称 | 位置 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| X-Token | header | string | 是 | 请联系客服获取 |
| userId | path | string | 是 | - |
请求体
| Content-Type | Schema | 说明 |
|---|---|---|
| application/json | AddressCreateRequest | - |
响应
| 状态码 | Content-Type | Schema | 说明 |
|---|---|---|---|
| 200 | application/json | SingleResponseAddressView | - |
调用示例
bash
curl -X POST "https://api.example.com/wallets/:userId/getAddresses" \
-H "X-Token: <请联系客服获取>" \
-H "Content-Type: application/json" \
-d '{
"chainCode": "string"
}'数据模型 (Schemas)
AddressCreateRequest
- 类型:
object
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| chainCode | string | 否 | - |
AddressView
- 类型:
object
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| chainId | integer | 否 | - |
| chainCode | string | 否 | - |
| address | string | 否 | - |
| derivationPath | string | 否 | - |
| status | string | 否 | - |
AllowedTokenView
- 类型:
object
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| tokenId | integer | 否 | Token 主键 ID。 |
| tokenCode | string | 否 | Token 编码，例如 USDT、BTC、ETH。 |
| tokenName | string | 否 | Token 名称。 |
| chainId | integer | 否 | 链主键 ID。 |
| chainCode | string | 否 | 链编码，例如 ETH、BSC、TRON。 |
| chainName | string | 否 | 链名称。 |
| contractAddress | string | 否 | 合约地址（原生币为空）。 |
| decimals | integer | 否 | 精度（decimals）。 |
| depositEnabled | boolean | 否 | 是否允许充值。 |
| withdrawEnabled | boolean | 否 | 是否允许提现。 |
| minDepositAmount | number | 否 | 最小充值金额。 |
| minWithdrawAmount | number | 否 | 最小提现金额。 |
| withdrawFee | number | 否 | 提现手续费。 |
| explorerUrlTemplate | string | 否 | 浏览器链接模板。 |
ChainInfoView
- 类型:
object
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | integer | 否 | 链主键 ID。 |
| code | string | 否 | 链编码，例如 ETH、BSC、TRON。 |
| name | string | 否 | 链名称。 |
| chainId | string | 否 | 链 ID（EVM chainId 或链自身标识）。 |
MultiResponseAllowedTokenView
- 类型:
object
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | boolean | 否 | - |
| errCode | string | 否 | 错误码 |
| errMsg | string | 否 | 错误信息 |
| data | array<AllowedTokenView> | 否 | - |
MultiResponseChainInfoView
- 类型:
object
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | boolean | 否 | - |
| errCode | string | 否 | 错误码 |
| errMsg | string | 否 | 错误信息 |
| data | array<ChainInfoView> | 否 | - |
SingleResponseAddressView
- 类型:
object
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | boolean | 否 | - |
| errCode | string | 否 | 错误码 |
| errMsg | string | 否 | 错误信息 |
| data | AddressView | 否 | - |