文档 API参考

Zendesk应用开发者的最佳实践亚博

简介

使用Zendesk apps框架构建的所有应用都应该遵循本文概述亚博的最佳实践。这些最佳实践可以在各个层面上提供帮助。它们使您更容易确保您的应用程序不会影响Zendesk帐户的性能或恶化代理的体验。亚博它们可以帮助迁移框架版本更快、更流畅。它们可以潜在地帮助您避免破坏性的更改。他们可以帮助你在首次提交后通过公共应用程序的审批过程。

无论您是为自己的公司还是为所有Zendesk客户开发应用程序，我们都强烈建议您遵循这些指导方针和最佳实践。亚博

如果您对以下任何一点不确定，对审批流程有疑问，或者您希望获得指导或帮助构建您的第一个Zendesk应用程序，请随时与我们联系亚博(电子邮件保护)．

最佳实践

  • 使用CDN框架版本的ZAF SDK。

  • 使用亚博Zendesk花园从npm。

  • 不要重复自己．对你自己的代码要严格。如果您发现在代码中重复做了相同的事情，那么可以通过创建可以在多个地方使用的helper函数来简化。

  • 清理。使用生命周期事件app.deactivated和app.willDestroy整理你的应用程序的状态。这些事件的目的，以及一般的最佳实践，是清理应用程序可能设置的任何不再需要的、可能影响主机产品性能的东西。清理的主要候选对象是通过创建的间隔setInterval或setTimeout．您应该始终存储对上述方法返回的ID的引用，以便能够调用clearInterval或clearTimeout．

  • 使用承诺来处理异步指令。看到JavaScript承诺:简介在谷歌的开发者门户网站上有一个很好的介绍。

  • 当数据不经常更改时，缓存承诺和API请求的结果。

  • 使用安全设置用于任何敏感设置，如API令牌或密码。

  • 使用一个domainWhitelist使用安全设置时。

  • 不要试图读取安全设置。这是行不通的。安全设置只能用作由服务器替换的占位符。

  • 当向Zendesk API发出AJAX请求时，避免在循环中请求所有亚博页面。如果必须获取所有数据，请确保在调用之间添加延迟以避免速率限制。

  • 遵循开发人员更新在Ze亚博ndesk帮助保持最新的变化。

  • 确保你定义了一个应用程序版本。应用程序版本将帮助你和其他使用该应用程序的人跟踪安装的内容。如果发现了一个错误，而你需要提供一个应用程序的新版本，这将特别有用。

  • 当在电话应用程序中创建票据，请确保您将via_id设置为44(语音邮箱)，45(入站呼叫)或46(外呼)，这取决于呼叫的类型。这确保Zendesk管理员和代理能够亚博在Zendesk内部正确地报告这些票据。

  • 更喜欢大部分电话尽可能的单次通话。

  • 指定自动装载:假对于不需要显示用户界面的位置，使用背景使用实例API来与这些位置交互。这减少了应用程序需要创建的iframe的数量，从而节省内存和CPU。看到示例应用程序关于这个技巧的例子。

  • 使用亚博Zendesk React应用程序脚手架脚手架包括许多功能来帮助你维护和扩展你的应用程序。

  • 使用签署的url在开发服务器端应用程序时验证请求是否合法。

  • 在提交应用程序之前，清理console.log和调试器语句。