亚博Zendesk Support管理员需要一种方法来配置集成实例的设置。设置的示例包括源服务的授权信息,每篇文章要导入多少评论到Zendesk Support,或者源服务上的用户白名单。亚博

您需要在HTML中构建此接口并远程托管它。指定接口的URL为admin_ui集成清单。界面以iframe形式显示在Zendesk Support中。亚博

admin_uiURL兼作端点,用于在Zendesk Support中存储和检索数据。亚博我们建议将集成实例的设置存储在Zendesk Support中,而不是存储在您的系统中。亚博看到元数据和状态。使用admin_ui端点在您的集成服务和Zendesk Support之间交换数据。亚博看到数据交换示例在下面。

一个admin_ui每个集成服务都需要端点。

舱单条目示例:

             
“url”{“admin_ui”“https://亚博zendesk_experts.com/integrations/instagram/admin_ui”}

数据交换示例

  1. Ze亚博ndesk Support管理员导航到Zendesk Support中的页面以创建集成帐户。事件触发一个POST请求admin_ui具有以下信息的端点:

    • 返回URL
    • Zendesk Support实例的子域亚博
    • Zendesk Support管理员亚博的语言环境
  2. 您的集成服务使用这些信息来动态更改要在Zendesk Support实例中构建的管理界面的内容。亚博例如,它可以使用区域设置来提供接口的本地化版本。

  3. 管理员使用Zendesk Support中的自定义管理界面配置新的集成帐户,并将值提交给集成服务。亚博例如,管理员指定他们的Instagram用户名是“omniwear”。这个信息叫做元数据积分帐户的。

  4. 您的集成服务通过返回HTML将值传递回Zendesk Support进行存储,该HTML将包含相关数据亚博的表单发送到步骤1中Zendesk Support提供的返回URL。亚博Zendesk Support存储数据。它不会以任何方式解析或使用它。

  5. 稍后,Zendesk 亚博Support管理员决定对集成帐户进行更改。管理员导航到Zendesk Support中的页面来编辑帐户。亚博浏览器向您的admin_ui端点。POST主体向您的集成服务提供以下信息:

    • 存储在Zendesk Support中的元数据亚博
    • 集成帐户的名称
    • 存储在Zendesk Support中的状态信息(如果有的话)亚博
    • 返回URL
    • Zendesk Support实例的子域亚博
    • Zendesk Support管理员亚博的语言环境
  6. 您的集成服务使用这些信息动态地更改管理接口。例如,它用“omniwear”填充用户名字段。

  7. 管理员使用定制的管理界面将用户名更改为“omniwear_beta”,并将信息提交给您的集成服务。

  8. 集成服务通过呈现一个HTML表单将更新后的元数据传递回Zendesk Support进行存储,该表单向返回URL发出POS亚博T请求。

动态更改管理界面

当管理员在Zendesk Support中创建或编辑集成帐户时,他们的浏览器将以url编码的表单POST格式发出POST请求,并将亚博以下数据发送到admin_ui在集成清单中指定的端点。使用这些信息动态地调整集成帐户的管理接口。

文章的格式

名字 类型 评论
元数据 字符串 关于集成实例的字符串化数据。新的集成实例为空白。看到元数据和状态
状态 字符串 关于当前状态的字符串化数据。看到元数据和状态
名字 字符串 该名称用于让用户在Zendesk Support界面中识别集成的这个特定实例。亚博新的集成实例为空白
return_url 字符串 在Zendesk Su亚博pport中,新值应该发布到的URL。看到在Zendesk支持中存储数据亚博
子域名 字符串 用于调用Zendesk API的子域亚博
语言环境 字符串 查看UI的管理员的RFC-1766兼容的区域设置字符串

例子

管理员要编辑一个已存在的帐户:

             
名字OmniwearInstagram元数据{“instagram_username”“omniwear”“instagram_oauth_token”“xyzabc”}状态{“last_msg”“1234”}return_urlhttps//omniwear亚博com/亚博/渠道/integration_service_instances/editor_finalizer子域名omniwear亚博com语言环境古银-太瓦

管理员想要创建一个集成帐户:

             
名字元数据状态return_urlhttps//omniwear亚博com/亚博/渠道/integration_service_instances/editor_finalizer子域名omniwear亚博com语言环境古银-太瓦

在Zendesk支持中存储数据亚博

您可以通过创建一个HTML表单将管理数据发送回Zendesk S亚博upport进行存储return_url参数由Zendesk Support亚博发送。有关如何POST数据的示例,请参见admin_ui_2方法示例集成在Github上。

您可以发送名称、元数据和状态信息。元数据和状态存储在Zendesk Support中。亚博亚博Zendesk不以任何方式解析或使用它们。元数据和状态值必须是字符串。看到元数据和状态

文章的格式

亚博Zendesk支持期望POST请求包含以下属性。的元数据状态属性必须是字符串,而不是JSON对象。

名字 类型 最大字符 评论
名字 字符串 255 集成的名称
元数据 字符串 5000 关于集成实例的字符串化数据。看到元数据和状态
状态 字符串 5000 关于当前状态的字符串化数据。看到元数据和状态

例子

             
名字Omniwear元数据{“instagram_username”“omniwear”“instagram_oauth_token”“xyzabc”“max_comments_per_message”“120”“whitelisted_users”“罗伯特,西蒙。”}状态{“last_msg”“1234”}