WEEX API 文档：如何开始使用 WEEX 交易 API

开始使用 WEEX API，需要准备两样东西：WEEX 官方 API 文档，以及根据所需功能配置的 API 密钥。WEEX 为现货和 USDT-M 合约交易提供 API 资源，文档涵盖行情数据、账户功能、交易操作、REST API 和 WebSocket 连接。

开发者无需身份验证即可访问支持的公开市场数据端点。账户和订单管理等私有功能则需要 API 密钥，并通过身份验证的请求进行访问。

设置流程很简单：选择相关的 WEEX API 文档，创建 API 密钥，配置必要的权限，妥善保管凭证，并将应用连接到相应的 API 端点。

在哪里可以找到 WEEX 官方 API 文档？

WEEX 提供专门的 API 文档，涵盖其支持的产品和接口。API 功能更新时，文档也会相应更新，各个端点页面还包含集成所需的请求和响应示例。 

对于 Spot V3，文档涵盖准备流程、API 域名、身份验证、行情数据、账户功能、订单功能、WebSocket 连接、速率限制及其他技术要求。

WEEX 将 API 分为公开接口和私有接口。公开 API 无需身份验证即可获取配置和行情数据。私有 API 涵盖订单和账户管理等功能，需要通过身份验证的请求进行访问。

集成前，开发者应选择与计划使用的产品相对应的文档，因为现货和合约的端点及技术要求可能有所不同。

如何创建 WEEX API 密钥

要使用 WEEX API 的私有功能，首先需要通过 WEEX 账户创建 API 密钥。根据当前的 Spot V3 文档，基本流程如下：

1. 通过网页平台登录 WEEX。
2. 打开 API 管理并创建新的 API 密钥。
3. 配置集成所需的权限。
4. 根据实际情况绑定 IP 地址。
5. 妥善保存过程中生成或配置的 API 凭证。

目前，每个 WEEX 账户最多可以创建 10 组 API 密钥。这样，用户可以为不同的应用或交易设置分别管理 API 密钥，而不必在所有连接中使用同一个密钥。

创建 API 密钥时，有三项重要凭证： APIKey 用于在身份验证时识别 API 用户。SecretKey 是用于生成请求签名的私钥。

Passphrase 由用户设置，是通过身份验证访问所必需的一部分。如果 Passphrase 丢失，WEEX 表示无法找回；必须创建新的 API 密钥。这些凭证应妥善保管，不应与他人分享。

如何配置 WEEX API 权限

新创建的 WEEX Spot API 密钥默认具有只读权限。该权限允许密钥访问支持的查询功能，但不能执行现货交易操作。

如果应用需要下达或取消现货订单，则必须启用相应的 Spot 权限。

因此，具体权限应取决于应用需要执行的操作。仅用于监控余额、查看交易历史或分析信息的工具可以保持只读权限。用于执行现货订单的应用则需要现货交易权限。

WEEX 还允许用户将 API 密钥绑定到 IP 地址。官方文档警告称，未绑定 IP 地址的 API 密钥存在额外的安全风险，并建议在创建密钥时绑定 IP 地址。

实际操作中，应仅向每个集成授予其确实需要的权限，而不要启用应用不会使用的额外访问权限。

如何连接 WEEX REST API

准备好 API 密钥和权限后，即可将应用连接到 WEEX REST API。WEEX 提供用于行情数据、账户信息和支持的交易操作的 REST API 端点。

公开端点无需身份验证即可获取市场信息。账户和订单功能等私有端点则需要使用 API 凭证进行身份验证，并遵循 WEEX 官方 API 文档中的签名要求。

建议先测试公开行情数据请求，再使用需要身份验证的功能。连接正常后，即可根据 API 密钥启用的权限使用相应的私有端点。

API 端点和技术要求可能会更新，因此配置集成时请务必查阅最新的 WEEX API 文档。

如何检查 WEEX API 连接

开始集成时，一个简单的方法是在添加更复杂的交易功能前，先确认应用能否与 WEEX API 正常通信。

可以先使用公开 API 请求，因为这类请求不需要身份验证。基本连接正常后，再根据分配给 API 密钥的权限测试身份验证请求。

如果身份验证请求失败，可能需要检查设置中的多个方面，包括 API 凭证、权限、请求签名、时间戳、API 域名和 IP 限制。

WEEX 要求身份验证请求使用标准化的签名方法。根据当前的 V3 文档，请求时间戳以毫秒为单位；如果时间戳与 WEEX API 服务器时间相差超过 30 秒，请求可能会被拒绝。 

逐步测试连接有助于判断问题来自网络连接、身份验证、权限，还是具体请求本身。

使用 WEEX API 进行交易前应检查什么？

使用 WEEX API 进行交易前，请检查 API 密钥的权限，确保密钥仅拥有应用所需的访问权限。WEEX 还建议将 API 密钥绑定到可信任的 IP 地址，并妥善保管 API 密钥、SecretKey 和 Passphrase。

开发者还应检查当前的 API 速率限制，并妥善处理请求错误。超出适用限制可能导致请求被拒绝，因此自动化系统应按照官方文档规定的限制运行。

在使用 API 进行实盘交易前，请仔细测试连接、身份验证、权限和订单逻辑。有关最新的安全要求和速率限制，请参阅当前的 WEEX API 文档。

结论

开始使用 WEEX API，需要选择适用的官方文档、创建 API 密钥、配置其权限、妥善保管凭证，并将应用连接到相关的 API 端点。

开发者可以先使用公开 API 请求，再转向需要身份验证的账户或交易功能。有关当前端点、身份验证要求、权限和速率限制，应以最新的 WEEX API 文档作为主要技术参考。

常见问题

1. 在哪里可以找到 WEEX 官方 API 文档？
WEEX 提供专门的文档，涵盖其 API 产品、端点、身份验证、WebSocket 连接、参数和响应示例。开发者应使用最新版本，因为 API 功能可能会随时间更新。

2. 如何创建 WEEX API 密钥？
登录 WEEX 网页平台并打开 API 管理，即可创建和配置 API 密钥。目前，每个账户最多可以创建 10 组 API 密钥。

3. 创建 WEEX API 密钥后，需要保存哪些信息？
请妥善保存 APIKey、SecretKey 和 Passphrase。Passphrase 丢失后无法找回，因此必须创建新的 API 密钥。

4. 新的 WEEX API 密钥拥有哪些权限？
新的 Spot API 密钥默认具有只读权限。若要执行现货交易操作，必须启用相应的 Spot 交易权限。

5. 为什么我的 WEEX API 请求无法正常工作？
常见原因包括凭证错误、权限不足、签名错误、时间戳差异、IP 限制或速率限制。请根据请求返回的错误，检查 WEEX 官方 API 文档中的相关部分。