集成清单
每个集成必须在一个已知的公共URL上显示一个清单。清单描述了集成的功能，并提供了Zendesk Support与集成交互所需的信息。亚博
您可以在构建的应用程序中指定清单的URL，以便在Zendesk Support中安装集成。亚博有关更多信息，请参见通道安装程序．
对清单的更改不会立即应用。亚博Zendesk Support轮询您的清单，并在轮询后应用更改。例如，如果你改变pull_url对于您的集成，Zendesk支持可能会继续连亚博接到旧的URL数小时。为了避免中断，在对服务进行更改时，应该至少保持几天的向后兼容性。亚博Zendesk支持将遵循301移动永久重定向您的清单URL。
清单格式
清单被表示为带有以下键的JSON对象。
| 名字 | 类型 | 最大字符 | 强制性的 | 评论 |
|---|---|---|---|---|
| 名字 | 字符串 | 255 | 是的 | 积分的名称。在Zendesk Support中用作通道集成的默认名称亚博 |
| id | 字符串 | 511 | 是的 | 集成的唯一标识符。建议使用唯一的URI或GUID |
| 版本 | 字符串 | 255 | 没有 | 此清单的版本。亚博Zendesk Support使用它来发现清单数据的本地缓存是否过期 |
| 作者 | 字符串 | 255 | 没有 | 作者或所有者的名称(纯文本字符串) |
| push_client_id | 字符串 | 127 | 没有 | 用于为推送支持生成令牌的OAuth客户机的ID。看到推 |
| channelback_files | 布尔 | 没有 | 这个集成是否支持带文件附件的Channelbacks ? | |
| create_followup_tickets | 布尔 | 没有 | 当集成返回一个thread_id，它对应于一个现有的已关闭的Zendesk票据，并且Zendesk创建了一个新票据，它是否应该被标记为“后续”票据?亚博大多数集成都应该使用真正的，但可能会使用面向消息或聊天的集成假．默认为真正的 |
|
| url | 对象 | 是的 | 请参见下面的urls对象 |
url对象
url被表示为带有以下键的JSON对象。所有url必须是SSL。支持相对URL，并将被解释为相对于清单本身的URL。
| 名字 | 类型 | 最大字符 | 强制性的 | 评论 |
|---|---|---|---|---|
| admin_ui | 字符串 | 511 | 是的 | URL到HTML界面，Zendesk Support管理员使用亚博该界面配置集成。看到管理界面 |
| pull_url | 字符串 | 511 | 没有 | 亚博Zendesk Support定期向该端点发出请求以导入新内容。看到把请求 |
| channelback_url | 字符串 | 511 | 没有 | 当代理在Zendesk Support中添加响应时，会向该端点发出亚博POST请求，以将注释推回原始服务。看到Channelback |
| clickthrough_url | 字符串 | 511 | 没有 | 代理单击到此端点的链接以查看源系统中的外部资源。看到点击端点 |
| about_url | 字符串 | 511 | 没有 | 亚博Zendesk支持管理员可以通过此URL获取该服务的丰富描述 |
| dashboard_url | 字符串 | 511 | 没有 | 亚博Zendesk支持管理员可以通过此URL查看有关服务状态的详细信息，例如正常运行时间或最近的异常 |
不指定可选URL将禁用集成中的该特性。
例子
｛“名称”：“Instagram集成”，“id”：“亚博zendesk-internal-instagram-integration”，“作者”：“贾里德·谢”，“版本”：“v3.7.5”，“channelback_files”：真正的，“create_followup_tickets”：真正的，“url”：｛“admin_ui”：“https://omniwear.com/integrations/instagram/admin_ui”，“pull_url”：“https://omniwear.com/integrations/instagram/pull”，“channelback_url”：“https://omniwear.com/integrations/instagram/channelback”，“clickthrough_url”：“https://omniwear.com/integrations/instagram/clickthrough”｝｝