> For the complete documentation index, see [llms.txt](https://tcminersystem.gitbook.io/tcminersystem/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tcminersystem.gitbook.io/tcminersystem/api-shi-yong-zhu-yi-shi-xiang-bi-du.md).

# API使用注意事项(必读)

此API为用户端接口，即TCMINERSYSTEM默认自带后台中所有接口，用户可根据自己需求调用API开发自己的用户端工具，例如网页、APP或管理工具。

注意：

接口调用地址为

```
用户端访问地址:端口+安全地址
(如果未设置安全地址，则调用路径为用户端访问地址:端口)

例：

例如您的用户端访问地址为 http://127.0.0.1/{安全地址}/
则API调用地址则为 http://127.0.0.1/{安全地址}/{APIURL}

如未设置安全地址, 则直接调用根路径即可
```

【**注意**】 **所有接口除登录外，均需要在header处使用Authorization字段来传入token以验证身份, toekn获取方式详见**[**登录、获取TOKEN**](https://tcminersystem.gitbook.io/tcminersystem/deng-lu-huo-qu-token-copy)**, 调用其他接口时header应传入**

请求头的ContentType应为'application/json'

<a class="button secondary">Copy</a>

```
Authorization: Bearer 获取到的TOKEN
```

部分接口需要传入滑动验证码成功后的返回值, 关于滑动验证码调用请参考[滑动验证码](https://tcminersystem.gitbook.io/tcminersystem/diao-yong-huo-qu-hua-dong-yan-zheng-ma)。

注意：

由于历史原因，所有接口需要传入币种的参数均需要加入特殊标记，例如BTC需要传PI-BTC, 以下为币种参数对照表。

BTC: **PI-BTC**

LTC: **VA-LTC （赠币跟随主币, 例如DOGE为VA-DOGE）**

KAS: **KAS**

ETC: **ETC**
