使用OAuth 2.0构建Sell应用程序-第1部分:奠定基础
在这个由五部分组成的系列教程中,您将学习如何从头到尾为Zendesk Sell构建一个React应用程序。亚博该应用程序将使用OAuth 2.0授权框架,该框架对应用程序的API请求进行认证。亚博
本教程涵盖了构建应用程序的第一步:
本系列的其他教程教你如何构建和安装应用程序:
本教程系列使用亚博Zendesk应用框架(ZAF)用于销售应用程序的React骨架它适用于有经验的web开发人员,他们可以轻松使用高级web工具,如Webpack, Node和npm包,以及其他技术。
因为这些教程是建立在彼此的基础上的,所以要按顺序处理它们,并在进入下一个教程之前完成每个教程。
要下载本教程中应用程序的完整源代码,请单击sellmailchimptutorialapp.zip.您可以在执行或检查工作时检查代码。
请注意: 亚博Zendesk提供本文仅用于教学目的。亚博Zendesk不为这些内容提供支持。如有问题,请在亚博Zendesk Apps框架(ZAF)社区,或在网上寻找解决方案。
你需要什么
要构建和上传私有销售应用程序,您必须在增长计划或更高级别上拥有Zendesk销售。亚博销售帐户还必须链接到Zendesk支持帐户。亚博如果您还没有Zendesk Sell帐户亚博,您可以创建一个14天免费试用.
规划应用程序
在开始开发应用程序之前,你应该对应用程序的外观和工作方式有一个很好的想法。该应用程序旨在列出销售联系人订阅的受众。了解更多有关Mailchimp的观众.
要从Mailchimp获取受众,需要设置OAuth以向Mailchimp API发出请求。该应用程序将有一个简单的界面和一个受众列表。每个条目将显示观众名称和订阅者数量。以下是应用程序界面的模型:
在销售中查看个人卡片时,应用程序将出现在右侧侧边栏。
当用户打开个人卡片时,应用程序将自动向Mailchimp API发出与该用户相关的HTTP请求。然后,该应用程序会列出该联系人已订阅的受众。
使用脚手架模板
首先,你需要克隆并下载应用程序脚手架模板,它允许你引导一个基于react的应用程序。
下载app脚手架模板
- 去ZAF React Skeleton for Sell Apps存储库,然后单击使用这个模板.
- 完成正在创建的存储库的详细信息,然后单击从模板创建存储库.
- 将存储库克隆到本地机器。
接下来,安装依赖项。
安装依赖关系
在命令行工具中,运行以下命令在package.json文件:
$ NPM install
进入模板文件夹,执行如下命令:
运行start
免责声明: 亚博Zendesk不支持第三方技术,如Webpack、Node.js或npm包,也不能调试自定义脚手架配置或代码。
安装ZCLI
的亚博Zendesk命令行接口是一个工具,它允许您执行以下任务:
- 自动为新应用程序创建所有必要的文件和文件夹
- 在浏览器中测试你的应用
- 验证你的应用
- 打包应用进行上传
安装ZCLI是一次性任务。安装完成后,你就可以在所有Zendesk应用项目中使用ZCLI了。亚博请按照安装和更新ZCLI.您还需要使用Zendesk帐户验证ZCLI。亚博看到身份验证在ZCLI文档中。完成后,返回这里继续本教程。
如果已经安装了ZCLI,请确保使用的是最新版本。
读了ZCLI应用程序部分熟悉所使用的命令。但是,不要运行$ zcli apps:新
命令,因为模板包含了构建应用程序所需的所有启动文件。
在你克隆的应用程序项目中,ZCLI命令可以作为npm脚本,你可以在你的命令行工具中运行。他们可以在package.json在“脚本”
财产。例如,构建你运行的应用程序运行构建
运行zcli应用:验证
而且zcli应用:包
来验证和打包应用程序。稍后您将使用这些命令。
注意:ZCLI取代了Zendesk App亚博s Tools (ZAT), ZAT目前处于维护模式。若要改用ZAT,请参阅安装和使用ZAT.
App文件概述
在之前克隆的apps模板文件夹中经销文件夹包含所有必须包含在应用程序安装它在Zendesk销售文件。亚博看到文件的要求获取更多信息。
的src文件夹是存放源代码的地方。在构建应用程序时,您可以添加尽可能多的文件。提供的文件将帮助您开始。
该项目还包括README.md在这里你可以找到关于为Zendesk Sell创建应用程序的信息。亚博
在下一个教程中,您将指定应用程序的位置,然后在Zendesk Sell中私下安装应用程序以测试它。亚博您还将学习如何在本地开发应用程序。开始:第2部分:在Zendesk Sell中安装应用程序亚博.