> ## Documentation Index
> Fetch the complete documentation index at: https://developer.wooxpro.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API基本信息

# 基本信息

1. 本篇列出接口的rest baseurl: [https://cloud-api.wooxpro.com](https://cloud-api.wooxpro.com)
2. 所有接口的响应都是 JSON 格式。

### 请求参数设置

* `GET`, `DELETE` 方法的接口, 参数必须在 `query string`中发送, 即`URL?`后拼接的参数。
* `POST`, `PUT` 方法的接口, 参数在 `request body` 中发送，格式是JSON。

### HTTP 返回代码

* HTTP 4XX 错误码用于指示错误的请求内容、行为、格式。问题在于请求者。
* HTTP 403 错误码表示违反限制(被禁止调用)。
* HTTP 429 错误码表示警告访问频次超限，即将被封IP。
* HTTP 418 表示收到429后继续访问，于是被封了。
* HTTP 5XX 错误码用于指示WOO X Pro服务出现的问题。

### API 返回内容

* `code` 错误码
* `message` 错误描述
* `trace` 每次请求事件跟踪ID，服务端对每次请求都会返回
* `data` 用户数据