服务状态与 OpenAPI
以下两个 GET 接口不需要 appID、签名或 accessToken,也不需要请求体和业务参数。
服务状态
GET /healthz
用于检查接口服务是否可用。成功不代表钱包余额已同步完成,也不代表某笔转账成功;资金结果仍通过到账或归集接口查询。
成功响应
HTTP 200:
json
{
"code": 0,
"message": "",
"data": {
"status": "ok",
"network": "nile"
}
}| 字段 | 类型 | 说明 |
|---|---|---|
| code | integer | 成功为 0 |
| message | string | 成功时为空字符串 |
| data | object | 服务状态对象 |
| data.status | string | ok 表示接口服务可用 |
| data.network | string | 资产网络:main 或 nile |
失败时返回相应 HTTP 状态码及标准错误对象,包含 code、error_code、message、trace_id,不包含 data。处理方式见错误码与排查。
OpenAPI 接口定义
GET /openapi.json
HTTP 200 直接返回完整的 OpenAPI 3.1 JSON,没有 code/message/data 外层。
也可下载 OpenAPI 3.1 JSON并导入 Apifox、Postman 等工具。导入后配置平台单独提供的 API 域名;请求签名仍按签名规则生成。
| 字段 | 类型 | 说明 |
|---|---|---|
| openapi | string | OpenAPI 格式版本 |
| info | object | 接口文档标题与版本 |
| paths | object | 按路径和 HTTP 方法定义的接口 |
| components | object | 共用的请求头、认证和数据结构 |
只需完整下载时不要发送 Range 或条件缓存请求头。该资源支持 HTTP 文件响应,可能返回 206、304 或下载错误;先检查 HTTP 状态和 Content-Type,再解析 JSON。