文档 API参考

概述

本指南是为实现Zendesk Support Channel集成的开发人员编写的。亚博它描述了如何构建一个双向集成服务，允许Zendesk Support和外部系统相互通信。亚博它还记录了集成服务必须实现的接口。你可能还会对教程．

渠道集成允许Zendesk Support从外部系统(亚博如Facebook、Twitter或Instagram)的数据中创建门票和评论。渠道整合具有以下特征:

  • 该集成将外部系统中的数据映射到Zendesk Support中的票据和评论。亚博
  • Zendesk支持中并没有硬编码集成。亚博亚博Zendesk Support通过定义的接口调用外部服务。
  • 集成是面向票证的。它不用于代理和客户之间的同步通信，例如聊天。

管理员在Zendesk Support中使用亚博亚博Zendesk应用你所提供的。有关更多信息，请参见通道安装程序．

集成的工作流

创建通道集成通常包括以下步骤:

  • 创建集成服务
  • 创建Zendesk亚博应用程序，在Zendesk支持实例中安装渠道集成
  • 托管清单文件
  • 创建并托管一个HTML管理界面
  • 创建一个管理接口端点
  • 创建拉取端点(可选)
  • 创建一个点击端点(可选)
  • 创建一个channelback端点(可选)
  • 创建一个关于页面(可选)

术语

  • 应用程序——一个亚博Zendesk应用用于打包和安装Zendesk支持中的通道。亚博应用程序也是一种传递机制，可以让你在市场上销售和营销你的渠道。看到通道安装程序．

  • Channelback- 亚博Zendesk支持代理可以处理从外部资源创建的票据。亚博电脑端当他们创建注释时，他们可以选择将这些注释镜像到源服务。这种镜像被称为channelback．例如，代理人可能正在处理基于Instagram评论的罚单。当代理对票据进行评论时，系统会在Instagram中创建一个新的评论，其中包含Zendesk Support评论的文本。亚博看到Channelback．

  • 点进- Zendesk S亚博upport票证中的链接，供代理查看外部资源亚博电脑端在源系统(见下文)。例如，Instagram集成可能会在Zendesk Support中显示Instagram评论。亚博代理人可以在Zendesk Support中点击评论上的链接，在Instagram中查看评亚博论。看到点进．

  • 外部资源-原始服务中的数据在Zendesk Support中镜像为票据或评论。亚博例子:Instagram评论。

  • 集成服务-连接Zendesk Support和原始服务的服务亚博。可以把它看作是源服务API和本文档中描述的Zendesk API接口之间的转换器。亚博

  • 集成实例—Zendesk Support实例中配置的集成通道。亚博例如，Zendesk Supp亚博ort管理员可能会安装Instagram集成。接下来，他们可能会为名为Omniwear的Instagram用户设置一个集成实例。

  • 元数据—集成实例的配置数据。例如，当Zendesk Support管亚博理员为Omniwear Instagram帐户设置了Instagram集成时，Omniwear帐户的Instagram ID可以存储在该集成实例的元数据中。看到元数据和状态．

  • 源服务-包含Zendesk Support中用于跟踪票据的数据的外部系统。亚博例子:Instagram或Facebook。

  • 拉- pull请求。亚博Zendesk Support定期向集成服务中的端点发出拉取请求，以查找新内容。亚博Zendesk Support从集成服务中提取数据，而不是直接从原始服务中提取数据。看到把请求．

  • 推集成服务可以直接将内容推送到Zendesk Support，而不需要等待它定期拉取内容。亚博看到推．

  • 线程-一组外部资源的组合。亚博电脑端亚博Zendesk Support在导入每个外部资源时为其标识会话线程，并使用该信息将数据添加到适当的票据或注释中。线程大致对应Zendesk Support中的票据。亚博看到对话线程．

职责和选择

当一个集成服务将Zendesk Support与一个源服务连接起来时，Ze亚博ndesk Support将处理调度、线程、票据创建和事件监控。集成服务处理与源服务通信的所有细节。

第三方数据可以通过调用Zendesk的公共API进行集成。亚博然而，Channel框架处理了许多细节，允许集成开发人员专注于业务逻辑。它可以跟踪状态，将外部资源与正确的票据相关联，允许Zendesk支持代理将评论发送回原始服亚博电脑端务，等等。亚博

安全注意事项

当向您的服务提供的端点发出请求时，Zendesk无法知道这些端点是如何实现的，实现是否遵循最佳安全实践，甚至是由谁创建的实现。亚博亚博Zendesk Support管理员在使用实现之前必须独立于Zendesk Support评估其可靠性。

此外，Zendes亚博k并没有指定您的集成服务应该如何验证对端点的请求实际上来自Zendesk。您可以在元数据中包含安全API令牌，包括每个集成的秘密，或使用适合您需要的任何其他方法。强烈建议您仔细考虑公开api的安全影响。

Zendesk Support发送的元数据和状态信息亚博拉而且channelback您的集成服务可以使用请求来确定请求是否合法。