我的服务模式是什么?
所有 Suite: Team、Growth、Professional、Enterprise 或 Enterprise Plus
Support Team、Professional 或 Enterprise

整合生成器支持标准授权类型,包括 API 密钥、不记名令牌、用户名和密码,以及OAuth 2.0。但是,根据您组织的需求和工作流程,标准授权可能还不够。因此,整合生成器还支持自定义仅身份验证整合类型,适用于您组织的身份验证和授权解决方案。

本文章包含以下主题:

  • 关于自定义授权
  • 配置自定义授权
  • 创建数据整合
  • 测试自定义授权

关于自定义授权

自定义的仅限身份验证整合会请求输入令牌及其有效期,然后将其传递给数据或主整合以进行授权,然后再发出数据请求。

总体而言,自定义授权流程如下:

  1. 授权请求。已配置的仅限身份验证整合会向服务器发送请求,请求授予权限以检索访问密钥。如果服务器通过对请求(来自人工智能专员)的身份验证,则授权检索访问密钥及其过期时间(如可用)。
  2. 处理令牌。在服务器使用访问令牌响应后,整合会存储两个关键信息:令牌参数本身及其 expiresIn 参数,该参数决定了令牌的有效时间。
  3. 将令牌传递到数据整合。这两个参数(token 和 expiresIn)将传递到下一步,即数据整合。此令牌用于对数据整合发出的后续请求进行身份验证。密钥在内部设置和处理,不会暴露在会话或对话数据中。
  4. 数据的自定义授权请求。访问密钥设置到位后,数据整合即已被授权检索必要数据,以扩充对话。

以下流程图说明了自定义授权流程。

配置自定义授权

您可以在整合生成器中配置自定义授权,这是正常创建整合流程的一部分。

注意:请勿一次使用多个环境进行自定义授权。如果您要拆分到生产环境、沙盒环境等,请将它们拆分为单独的授权整合。

在整合生成器中配置自定义授权

  1. 在主菜单中,单击API 整合。
  2. 在右上角,单击添加整合。
  3. 在添加整合窗口中:
    1. 在整合名称字段中,为您的整合指定一个描述性名称。
    2. (可选)在描述字段中,输入整合的描述,以帮助您记住整合的用途。
    3. 选择设置为“仅限身份验证”整合。
    4. 单击保存。
  4. 在左侧栏中的场景下,将鼠标悬停在失败上,选择选项菜单 ( ),然后选择删除。 
    对于自定义授权,您只需要成功场景,并且必须删除失败场景。但是,您无法删除回退场景。
  5. 在成功场景页面上,使用以下详情创建两个会话参数(通过单击+按钮):
    • 密钥
      • 密钥:令牌(必须与此完全相同)
      • 查询:输入一个定义令牌的值。例如:data.access_token
    • expiresIn
      • 键值: expiresIn (必须完全这样写)
      • 查询:输入一个定义令牌过期时间的值。例如:data.expires_in
        您的数据响应中可能不包含密钥过期信息。在这种情况下,您可以硬编码一个所选值(以秒为单位)。例如:3600
        我们强烈建议设置令牌过期时间。如果您在测试时遇到错误,这是颁发新令牌之前您需要等待的时间。如果令牌没有过期时间,则设置为无限期,这意味着在故障排除期间您将无法颁发新令牌。
  6. 单击保存。

创建数据整合

接下来,创建一个数据整合,该整合将使用您在上述步骤中创建的自定义“仅限身份验证”整合。就像创建新整合时一样。如需帮助,请参阅整合生成器说明。

创建数据整合

  1. 在左侧栏中的环境下,选择一个环境(例如 Production)。
  2. 在授权标签的授权类型下拉字段中,选择自定义。
  3. 在API 授权整合下拉字段中,选择您在上面创建的自定义仅限身份验证整合。
  4. 选择标头标签,然后单击添加标头。
  5. 填写以下字段:
    • 键值:授权
    • 值:不记名{{apiToken}}(必须完全这样写)
  6. 单击保存。

测试自定义授权

我们建议您在配置自定义的仅限身份验证整合后对其进行测试。如需帮助,请参阅测试功能。

故障排除 statusCode:null

此外,在测试整合时,您可能会遇到如下图所示的消息“statusCode: null”:

首先,仔细检查您的仅限身份验证的自定义整合是否已根据上述步骤正确配置。

接下来,记下发生错误的位置。如果是在身份验证整合中,则可能存在某些配置不正确,或者您发出请求的 URL 可能有误。在这种情况下,建议咨询您的工程师,他们可能会提供更多关于故障原因的信息。

如果您已执行上述步骤,但仍遇到此错误,请等到令牌过期后再重试。

如果您已尝试所有这些故障排除步骤,但整合仍然无法工作,请联系您的客户服务经理以获得更多帮助。

 

翻译免责声明:本文章使用自动翻译软件翻译,以便您了解基本内容。 我们已采取合理措施提供准确翻译,但不保证翻译准确性

如对翻译准确性有任何疑问,请以文章的英语版本为准。

由 Zendesk 提供技术支持