API概览

CatFee.IO Rest API 调用指南

Previous通过 API购买能量 NextJava调用示例

Last updated 12 days ago

Was this helpful?

API概览

CatFee.IO Rest API 调用指南

1. 介绍

CatFee.IO 提供了一套安全、标准化的 API，支持高效的资源访问。通过该 API，用户可以进行诸如订单创建、账户查询等多种操作。所有请求都需要通过签名验证机制，确保请求的安全性和有效性。

2. Base URL 说明

生产环境：https://api.catfee.io
测试环境：https://nile.catfee.io
如何获得波场的测试币，您可以到获取波场尼罗河测试币(每天可以领2000个trx)，领取完可以到波场nile链上查询。

请根据您的需求选择相应的环境进行调用。

3. 签名机制

为了确保 API 调用的安全性，CatFee.IO 使用 HMAC-SHA256 签名机制对请求进行身份验证。请求需要提供正确的签名，以确保请求未被篡改，并且有效。

4. 签名生成规则

4.1 签名字符串拼接规则

签名字符串是由以下部分拼接而成：

sign = timestamp + method + requestPath

timestamp：请求的时间戳，格式为 ISO 8601，例如：2023-08-26T12:34:56.789Z。
method：HTTP 方法，例如 GET、POST、PUT 或 DELETE。
requestPath：API 请求路径，包含查询参数（如果有）。例如：
- /v1/order?quantity=65000&receiver=TRON_ADDRESS&duration=1h
- 注意：query parameters 应包括在 requestPath 中。

4.2 签名生成流程

签名的生成步骤如下：

拼接签名字符串：timestamp + method + requestPath。
使用 HMAC-SHA256 算法，对拼接后的字符串进行加密，使用您的 API Secret 作为密钥。
对加密结果进行 Base64 编码，生成最终的签名。

4.3 示例

假设我们有以下信息：

timestamp = 2023-08-26T12:34:56.789Z
method = POST
requestPath = /v1/order?quantity=65000&receiver=TRON_ADDRESS&duration=1h

拼接后的签名字符串为：

2023-08-26T12:34:56.789ZPOST/v1/order?quantity=65000&receiver=TRON_ADDRESS&duration=1h

然后，使用 HMAC-SHA256 算法和 API Secret 对该字符串进行加密，最后对结果进行 Base64 编码，得到最终的签名。

5. 请求头参数

每次请求都必须包含以下 HTTP 请求头：

Content-Type：请求的内容类型，一般为 application/json。
CF-ACCESS-KEY：您的 API Key。
CF-ACCESS-SIGN：请求的签名值。
CF-ACCESS-TIMESTAMP：请求的 UTC 时间戳。

6. 示例请求

6.1 示例 POST 请求

假设您要创建一个订单，API 请求的路径为 /v1/order，并且包含以下查询参数：

quantity=65000
receiver=TRON_ADDRESS
duration=1h

生成请求 URL：

https://api.catfee.io/v1/order?quantity=65000&receiver=TRON_ADDRESS&duration=1h

请求头应包含以下内容：

Content-Type: application/json
CF-ACCESS-KEY: your_api_key
CF-ACCESS-SIGN: generated_signature
CF-ACCESS-TIMESTAMP: 2023-08-26T12:34:56.789Z

6.2 示例 GET 请求

假设您要查询订单配置，API 请求的路径为 /v1/config，并且没有查询参数。生成请求 URL：

https://api.catfee.io/v1/config

请求头应包含以下内容：

Content-Type: application/json
CF-ACCESS-KEY: your_api_key
CF-ACCESS-SIGN: generated_signature
CF-ACCESS-TIMESTAMP: 2023-08-26T12:34:56.789Z

7. 响应数据格式

所有请求的响应数据通常包含以下结构：

{
  "code": "0",
  "msg": "",
  "data": {
    "key": "value"
  }
}

code：响应代码，0 表示请求成功。
msg：响应消息，可能包含错误信息或说明。
data：返回的实际数据，通常是一个包含键值对的 JSON 对象。

Previous通过 API购买能量 NextJava调用示例

Last updated 12 days ago

Was this helpful?

1. 介绍

2. Base URL 说明

生产环境：https://api.catfee.io
测试环境：https://nile.catfee.io
如何获得波场的测试币，您可以到获取波场尼罗河测试币(每天可以领2000个trx)，领取完可以到波场nile链上查询。

请根据您的需求选择相应的环境进行调用。

3. 签名机制

为了确保 API 调用的安全性，CatFee.IO 使用 HMAC-SHA256 签名机制对请求进行身份验证。请求需要提供正确的签名，以确保请求未被篡改，并且有效。

4. 签名生成规则

4.1 签名字符串拼接规则

签名字符串是由以下部分拼接而成：

sign = timestamp + method + requestPath

timestamp：请求的时间戳，格式为 ISO 8601，例如：2023-08-26T12:34:56.789Z。
method：HTTP 方法，例如 GET、POST、PUT 或 DELETE。
requestPath：API 请求路径，包含查询参数（如果有）。例如：
- /v1/order?quantity=65000&receiver=TRON_ADDRESS&duration=1h
- 注意：query parameters 应包括在 requestPath 中。

4.2 签名生成流程

签名的生成步骤如下：

拼接签名字符串：timestamp + method + requestPath。
使用 HMAC-SHA256 算法，对拼接后的字符串进行加密，使用您的 API Secret 作为密钥。
对加密结果进行 Base64 编码，生成最终的签名。

4.3 示例

假设我们有以下信息：

timestamp = 2023-08-26T12:34:56.789Z
method = POST
requestPath = /v1/order?quantity=65000&receiver=TRON_ADDRESS&duration=1h

拼接后的签名字符串为：

2023-08-26T12:34:56.789ZPOST/v1/order?quantity=65000&receiver=TRON_ADDRESS&duration=1h

然后，使用 HMAC-SHA256 算法和 API Secret 对该字符串进行加密，最后对结果进行 Base64 编码，得到最终的签名。

5. 请求头参数

每次请求都必须包含以下 HTTP 请求头：

Content-Type：请求的内容类型，一般为 application/json。
CF-ACCESS-KEY：您的 API Key。
CF-ACCESS-SIGN：请求的签名值。
CF-ACCESS-TIMESTAMP：请求的 UTC 时间戳。

6. 示例请求

6.1 示例 POST 请求

假设您要创建一个订单，API 请求的路径为 /v1/order，并且包含以下查询参数：

quantity=65000
receiver=TRON_ADDRESS
duration=1h

生成请求 URL：

https://api.catfee.io/v1/order?quantity=65000&receiver=TRON_ADDRESS&duration=1h

请求头应包含以下内容：

Content-Type: application/json
CF-ACCESS-KEY: your_api_key
CF-ACCESS-SIGN: generated_signature
CF-ACCESS-TIMESTAMP: 2023-08-26T12:34:56.789Z

6.2 示例 GET 请求

假设您要查询订单配置，API 请求的路径为 /v1/config，并且没有查询参数。生成请求 URL：

https://api.catfee.io/v1/config

请求头应包含以下内容：

Content-Type: application/json
CF-ACCESS-KEY: your_api_key
CF-ACCESS-SIGN: generated_signature
CF-ACCESS-TIMESTAMP: 2023-08-26T12:34:56.789Z

7. 响应数据格式

所有请求的响应数据通常包含以下结构：

{
  "code": "0",
  "msg": "",
  "data": {
    "key": "value"
  }
}

code：响应代码，0 表示请求成功。
msg：响应消息，可能包含错误信息或说明。
data：返回的实际数据，通常是一个包含键值对的 JSON 对象。