摘要

要将您的应用程序或集成与 Wati 连接,您需要一个 API 令牌和正确的 API 端点 URL。本指南介绍了如何生成新的 API 令牌、配置其过期时间和权限,以及查找适用于 v1、v2 和 v3 API 的正确端点 URL。

操作说明

在 Wati 中生成 API 令牌

请按照以下步骤生成新的 API 令牌:

  • 登录您的 Wati 账户。

  • 转到 Connectors(连接器)> API Tokens(API 令牌)。

  • 点击 Generate new token(生成新令牌)。

  • 如果系统提示,请输入令牌名称。

  • 根据您的需求设置令牌的过期时长。

  • 在 Scope(范围)下,选择您的集成所需的权限。如果您的集成需要所有可用权限,请选择 Select all(全选)。

  • 点击生成选项并复制令牌。

重要提示

  • 您的 API 令牌仅在生成时显示一次。请在关闭窗口前复制并妥善保存。如果您丢失了令牌,则必须生成一个新令牌并更新您的集成。

  • 此前在 API Docs(API 文档)页面提供的旧版 Bearer Token 会在关联用户的密码更改时过期。此行为仅适用于旧版令牌,不适用于新生成的 API 令牌。新 API 令牌在配置的过期日期之前或手动轮换之前保持有效。

查找您的 API 端点

您可以在与令牌相同的页面上找到您的 API 端点。

Wati 使用以下基础 URL(主机)进行 API 请求:

https://live-mt-server.wati.io

端点 URL 格式取决于您使用的 API 版本。

适用于 v1 和 v2 API

在基础 URL 后直接包含您的 Wati 租户 ID,然后跟上 API 路径。

https://live-mt-server.wati.io/{tenantId}/api/v1/...

将 {tenantId} 替换为您的 Wati 租户 ID。

适用于 v3 API

请勿在 URL 中包含租户 ID。直接在基础 URL 后使用 v3 API 路径。

https://live-mt-server.wati.io/api/ext/v3/...

重要提示: 请勿在 v3 API 端点 URL 中添加 /{tenantId}/。否则会导致端点 URL 不正确。

关于 API 令牌的重要说明

  • 令牌过期: 您的 API 令牌在配置的过期日期之前或手动轮换之前保持有效。

  • 令牌安全: 请对您的 API 令牌保密。切勿公开分享或在客户端代码中暴露它。

  • 令牌权限: 生成令牌时,请选择您的集成所需的权限。

  • 令牌更换: 如果您生成了替换令牌,请务必更新您的集成以使用新令牌。

  • 旧版 Bearer Token: 此前在 API Docs 中提供的旧版 Bearer Token 已不再可用。您必须在 Connectors > API Tokens 下生成新的 API 令牌。

Wati 推出了新的令牌生成流程以提高安全性。它允许您配置令牌的过期时长和权限,这是旧版 Bearer Token 所不具备的功能。

有关可用 API 端点和操作的更多信息,请参阅 Wati API 文档。

常见问题解答 (FAQs)

API 令牌生成与身份验证

1. 我在哪里可以生成 Wati API 令牌?

您可以通过登录 Wati 账户并导航至 Connectors > API Tokens 来生成 API 令牌。点击 Generate new token,配置令牌的过期时长和权限,即可生成令牌。

2. API Docs 中的旧版 Bearer Token 是否仍然可用?

不可用。此前在 API Docs 中提供的旧版 Bearer Token 已不再可用。您必须在 Connectors > API Tokens 下生成新的 API 令牌来验证您的 API 请求。

3. 为什么 Wati 要求生成新的 API 令牌?

Wati 推出了新的 API 令牌生成流程以提高安全性。它允许您配置令牌的过期时长并选择授予它的特定权限。

API 令牌管理

4. 我可以找回之前生成的 API 令牌或配置其过期时长吗?

不能。您无法找回之前生成的 API 令牌,因为 Wati 仅在令牌创建时显示一次。

您可以在生成新的 API 令牌时配置其过期时长。令牌在过期或手动轮换之前保持有效。

如果您丢失了 API 令牌,请在 Connectors > API Tokens 下生成一个新令牌,并更新您的集成以使用它。

API 端点 URL

5. 我应该在什么时候将租户 ID 包含在 Wati API 端点 URL 中?

在使用 Wati v1 和 v2 API 端点时,请在基础 URL 后直接包含您的租户 ID。

请勿在 v3 API 端点 URL(使用 /api/ext/v3/ 路径)中包含您的租户 ID。

Did this answer your question?