使用对话 API 密钥

我的服务模式是什么？

Suite

Professional、Enterprise 或 Enterprise Plus

使用 Sunshine Conversations API 发出请求时，需要进行身份验证以验证来电人的身份。您可以使用基本身份验证或 JSON 网络密钥 (JWT) 来验证来电人的身份。这两种方法都需要 API 密钥。您可以使用对话 API 页面创建 API 密钥。

注意：此处所述的 API 密钥与管理中心的整合对话 API 密钥不同。此处所述的对话 API 密钥用于应用级别的身份验证。整合对话 API 密钥特定于对话整合。

对话 API 页面的访问包含在 Zendesk Suite Professional 或更高版本的服务模式中。您必须激活 Zendesk 专员工作区才能看到该页面。如果您需要更多的每月活跃用户 (MAU) 或通知，还可以使用其他附加功能包。如需了解更多信息，请参阅关于 Zendesk Suite 附加功能。

本文章包含以下部分：

• 关于 API 密钥
• 创建和共享 ID 和 API 密钥

关于 API 密钥

API 密钥可识别并验证应用程序或用户，由三部分组成：

• 应用 ID 可识别您的 Zendesk 帐户。
• 密钥 ID 与密钥一起使用时，用作对 JWT 和 API 调用进行身份验证的凭证。
• 密钥是身份验证密码。

使用基本身份验证时，您可以直接使用 API 密钥发出请求。密钥 ID 是用户名，密钥是密码。

使用 JWT，您可以使用 API 密钥对密钥进行签名，然后使用 API 进行身份验证。密钥 ID 作为 kid 属性包含在 JWT 标头中，而密钥对 JWT 进行签名。

API 密钥不如身份验证密钥安全。在生产环境中使用 API 密钥时，请务必遵循良好实践以安全处理凭证。

有关 Sunshine Conversations 身份验证的更多信息，请参阅 API 身份验证。

Sunshine Conversations API 密钥与消息传送身份验证密钥不同。消息传送身份验证密钥用于签署凭证，以便使用 Zendesk SDK 对终端用户进行身份验证。这里的 API 密钥用于服务器到服务器的调用，提供对 Sunshine Conversations 公共 API 的访问，这些 API 支持 app 范围。

创建和共享 ID 和 API 密钥

Zendesk 管理员必须创建一个 API 密钥并分享给开发者。您可以存储最多 10 个密钥。

创建和共享 API 密钥

1. 在管理中心，单击侧栏中的 应用和整合，然后选择 API > 对话 API。
   注意：您必须拥有 Zendesk Suite Professional 或更高版服务模式才能查看此窗口。
2. 单击创建 API 密钥。

   如果您正在创建首个密钥，此按钮将显示在页面底部；如果您之前已创建密钥，它将显示在右上角。

3. 在“创建新密钥”对话框中输入密钥的识别名称，然后单击下一步。
4. 在“复制共享密钥”对话框中，单击每个 ID 和密钥的复制，将其保存到剪贴板，然后单击下一步。

   您将返回 API 窗口，新密钥将显示在列表中。

如果您生成了新密钥，但已达到 10 个密钥的限制，则系统会显示一条通知，要求您删除未使用的密钥。

删除未使用的密钥

1. 在管理中心，单击侧栏中的 应用和整合，然后选择 API > 对话 API。
2. 将鼠标光标悬停在您要删除的密钥上，然后单击选项菜单 ()，然后选择删除。
3. 单击删除确认操作。