> For the complete documentation index, see [llms.txt](https://www.vipor.top/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.vipor.top/kuang-chi-jie-dian-yong-hu-duan-api/api-shi-yong-zhu-yi-shi-xiang-bi-du.md).

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

此API为用户端接口，即

<div align="left"><figure><img src="https://3324214588-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fn7Tvjzuy04UcRcsKcpeH%2Fuploads%2F21aUZ6cVu6yQ3tMISyvg%2Fimage.avif?alt=media&amp;token=8bc5c10f-d578-4660-ac30-a505d25bfacc" alt="" width="300"><figcaption></figcaption></figure></div>

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

注意：

接口调用地址为

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

例：

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

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

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

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

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

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