文档 API参考

构建第一个Support应用程序——第1部分:奠定基础

在这个五部分的系列教程中，您将学习如何从头到尾构建Zendesk应用程序。亚博您将构建的应用程序称为Requester X-ray。

本教程涵盖了构建应用程序的第一步:

本系列的其他教程教你如何构建和安装应用程序:

因为这些教程是建立在彼此的基础上的，所以要按顺序处理它们，并在进入下一个教程之前完成每个教程。

要下载本教程中应用程序的完整源代码，请单击xr_app.zip．您可以在执行或检查工作时检查代码。

免责声明: 亚博Zendesk提供本文仅用于教学目的。亚博Zendesk不为这些内容提供支持。如有问题，请在亚博Zendesk Apps框架(ZAF)社区，或在网上寻找解决方案。

你需要什么

要构建和上传私人支持应用程序，您必须拥有Zendesk Suite增长计划或更高版本，或支持专业计划或更高版本。亚博如果你加入了团队计划，Zendesk会为开发者提供一个免亚博费的企业账户，用于测试和调试应用程序。我们只要求您不要使用它来提供实际的支持。指请求赞助测试帐户．

你也可以在试用账户中试用应用程序，这样你就可以使用企业版的所有功能。

规划应用程序

在开始开发应用程序之前，你应该对应用程序的外观和工作方式有一个很好的想法。请求者x射线应用程序将显示关于请求者的以下信息:

  • 请求者的名字
  • 在Zendesk Support中应用到请求程序的任何用户标记亚博
  • 请求者添加到Zendesk Support的日期亚博
  • 请求者最后一次登录Zendesk Support的时间亚博

当代理在Zendesk Support代理界面中打开票据时，应用程序将在右侧的应用程序面板中显示此信息。亚博

该应用程序将包含一个“报告错误”链接，允许代理通过电子邮件向应用程序的作者报告错误。

下面是用户界面的模型:

安装ZCLI

在本节中，您将安装Zendesk命令行接口(ZCLI)。亚博ZCLI让你:

  • 自动为新应用程序创建所有必要的文件和文件夹
  • 在浏览器中测试你的应用
  • 验证你的应用
  • 打包应用进行上传

安装ZCLI是一次性任务。安装完成后，你就可以在所有Zendesk应用项目中使用ZCLI了。亚博请按照安装和更新ZCLI．您还需要使用Zendesk帐户验证ZCLI。亚博看到身份验证在ZCLI文档中。完成后，返回这里继续本教程。

注意:ZCLI取代了Zendesk App亚博s Tools (ZAT)， ZAT目前处于维护模式。若要改用ZAT，请参阅安装和使用ZAT．

创建应用程序文件

在安装ZCLI之后，您可以开始构建应用程序。第一步是为名为ZCLI的新应用程序创建启动器文件请求者x射线在一个名为xr_app．您可以使用ZCLI来完成这个任务。

创建应用程序文件

  1. 在您的命令行界面(Windows中的命令提示符或macOS中的Terminal)中，导航到您希望将应用程序文件保存在子文件夹中的文件夹。

    使用cd命令(用于更改目录)导航到子文件夹。例子:

                   
    
                
    cd项目

  2. 运行:

                   
    
                
    zcli应用:新

  3. 在提示符下，输入以下值:

    • 目录名称:xr_app
    • 作者姓名:您的姓名
    • 作者邮箱:您的邮箱地址
    • 作者网站:留空并按Enter。
    • 应用名称:请求者x射线

    中创建应用程序启动器文件xr_app文件夹中。

  4. 打开文件浏览器并导航到这些文件。

    该文件夹包含资产而且翻译文件夹，加上manifest.json而且README.md文件。当你构建应用程序时，你可以添加尽可能多的文件，但现在它是你开始构建应用程序所需要的全部。

    因为它是一个iframe应用程序，你可以在Zendesk Support或远程服务器上使用任何你想要的技亚博术堆栈托管应用程序。如果你只使用客户端技术，就像你在这里一样，你可以简单地在Zendesk Support中托管它。亚博

一切都准备就绪，可以开始建造了。在下一篇教程中，您将更多地了解要嵌入Zendesk Support的HTML文件。亚博中指定的设计要求，您将添加页脚、添加一些样式表并替换徽标规划应用程序以上。开始:第2部分-设计用户界面．