配置 API

配置查询 API 用于获取收银台信息、网络列表、代币列表等公共配置数据。

接口列表

接口
方法
说明
认证

/admin/api/v2/pub/cashier/info

GET

查询收银台配置信息

需要 API Key

/admin/api/v2/pub/coin/list

GET

查询支持的代币列表

公开接口

/admin/api/v2/pub/network/list

GET

查询支持的网络列表

公开接口

环境

环境
Base URL

生产环境

https://open.blockatm.net

测试环境

https://test-open.blockatm.net


查询收银台配置信息

获取指定收银台的详细配置信息,包括支持的代币、网络、支付方式等。

请求

GET /admin/api/v2/pub/cashier/info?cashierId={cashierId}
Content-Type: application/json
BlockATM-API-Key: your_api_key

请求参数

参数
类型
位置
必填
说明

cashierId

String

Query

收银台 ID

响应示例

响应字段说明

字段
类型
说明

cashierId

String

收银台 ID

merchantId

String

商户 ID

merchantName

String

商户名称

supportedNetworks

Array

支持的网络列表

supportedNetworks[].chainId

String

网络 Chain ID

supportedNetworks[].networkName

String

网络名称

supportedNetworks[].symbol

String

主网代币符号

supportedCoins

Array

支持的代币列表

supportedCoins[].symbol

String

代币符号

supportedCoins[].contractAddress

String

代币合约地址

supportedCoins[].minAmount

String

最小支付金额

supportedCoins[].maxAmount

String

最大支付金额

paymentMethods

Array

支付方式列表

webhookUrl

String

Webhook 通知地址

status

String

收银台状态:active/inactive


查询代币列表

获取 BlockATM 支持的所有代币信息。

请求

circle-info

说明:此接口为公开接口,无需 API Key 认证。

响应示例

响应字段说明

字段
类型
说明

symbol

String

代币符号

name

String

代币全称

networks

Array

支持的网络列表

networks[].chainId

String

网络 Chain ID

networks[].contractAddress

String

代币合约地址

networks[].decimals

Number

代币精度

networks[].minAmount

String

最小交易金额

networks[].maxAmount

String

最大交易金额

networks[].withdrawFee

String

提现手续费


查询网络列表

获取 BlockATM 支持的所有区块链网络信息。

请求

circle-info

说明:此接口为公开接口,无需 API Key 认证。

响应示例

响应字段说明

字段
类型
说明

chainId

String

网络 Chain ID

networkName

String

网络全称

shortName

String

网络简称

symbol

String

主网代币符号

decimals

Number

代币精度

explorerUrl

String

区块浏览器 URL

rpcUrl

String

RPC 节点 URL

status

String

网络状态:active/maintenance

avgBlockTime

Number

平均出块时间(秒)

avgGasFee

String

平均 Gas 费用


错误码

错误码
说明
解决方案

0

成功

-

ERROR_000101

收银台不存在

检查 cashierId 是否正确

ERROR_000102

收银台已关闭

联系管理员启用收银台

ERROR_000401

未授权访问

检查 API Key 是否正确

ERROR_000500

服务器内部错误

联系技术支持

使用示例

cURL 示例

JavaScript 示例

最佳实践

1. 缓存配置数据

配置数据变化不频繁,建议在应用启动时获取并缓存:

2. 错误处理

3. 网络切换

根据用户选择自动切换网络:

下一步

Last updated