对外 API 文档
本文档面向第三方调用方,覆盖以下内容:
- 公共参数约定
- API Key 获取方式
- 公共错误码
- 能量下单接口
- 激活接口
基础信息
- OpenAPI 前缀:
/api/v1/openapi - 数据格式:
application/json - 鉴权方式:
- 获取 API Key 使用 JWT(
Authorization: Bearer <token>) - OpenAPI 业务接口使用查询参数
apikey
- 获取 API Key 使用 JWT(
统一响应结构
{
"code": 200,
"message": "SUCCESS",
"data": {}
}
说明:
code: 业务码(非 HTTP 状态码)message: 业务提示信息data: 业务数据(不同接口结构不同)
公共参数
本章节说明 OpenAPI 接口的公共请求参数。
查询参数
所有 OpenAPI 业务接口使用 GET + Query 参数:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
apikey | string | 是 | 用户 API Key |
add | string | 是 | TRON 地址 |
示例
curl -G "https://api.gotoken.net/api/v1/openapi/getenergy" \
--data-urlencode "apikey=your_api_key" \
--data-urlencode "add=TRXxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
--data-urlencode "value=32000" \
--data-urlencode "hour=24"
注意事项
apikey由登录后的用户在用户接口中获取。add为目标地址字段,参数名固定为add。- 所有业务错误通过响应体
code/message返回。
公共错误码
下表为对外接口常见公共错误码。
| 错误码 | 含义 |
|---|---|
100001 | 服务器内部错误 |
100002 | 服务暂时不可用 |
101001 | 参数错误 |
102001 | 资源不存在 |
错误响应示例
{
"code": 101001,
"message": "参数错误: hour 不合法"
}
接口文档
本章节包含当前对外开放的 OpenAPI 接口:
- 能量下单
- 激活
每个接口均提供以下信息:
- 接口地址
- 请求参数
- 返回参数
- 代码示例
- 接口错误码
能量下单
该接口用于按套餐规则发起能量订单。
接口地址
- 方法:
GET - 地址:
/api/v1/openapi/getenergy
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
apikey | string | 是 | 用户 API Key |
add | string | 是 | 接收能量的 TRON 地址 |
value | int | 是 | 能量值(要求与套餐匹配),可选:32000/65000/130000/131000 |
hour | int | 是 | 时长(小时),可选:1/24/72/168/336/720 |
返回参数
| 字段 | 类型 | 说明 |
|---|---|---|
code | int | 业务码,成功为 200 |
message | string | 提示信息 |
data.orderId | string | 订单ID |
data.amount | string | 本次消费金额(TRX) |
代码示例
curl -G "https://api.gotoken.net/api/v1/openapi/getenergy" \
--data-urlencode "apikey=your_api_key" \
--data-urlencode "add=TRXxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
--data-urlencode "value=32000" \
--data-urlencode "hour=24"
成功响应示例:
{
"code": 200,
"message": "SUCCESS",
"data": {
"orderId": "019c8ef8-2608-7e9e-aec8-712095c3ec79",
"amount": "12.34"
}
}
激活
该接口用于对指定 TRON 地址执行激活操作。
接口地址
- 方法:
GET - 地址:
/api/v1/openapi/activation
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
apikey | string | 是 | 用户 API Key |
add | string | 是 | 需要激活的 TRON 地址 |
返回参数
| 字段 | 类型 | 说明 |
|---|---|---|
code | int | 业务码,成功为 200 |
message | string | 提示信息 |
data.txid | string | 激活哈希值 |
data.amount | string | 本次消费金额(TRX) |
代码示例
curl -G "https://api.gotoken.net/api/v1/openapi/activation" \
--data-urlencode "apikey=your_api_key" \
--data-urlencode "add=TRXxxxxxxxxxxxxxxxxxxxxxxxxxxx"
成功响应示例:
{
"code": 200,
"message": "SUCCESS",
"data": {
"txid": "4f7a...e991",
"amount": "2.50"
}
}
地址已激活示例:
{
"code": 702001,
"message": "地址已激活,无需激活"
}
接口错误码
| 错误码 | 含义 |
|---|---|
702001 | 地址已激活,无需激活 |