使用Asana构建应用程序

了解Asana开发平台的基础知识

什么是Asana应用程序?

Asana应用程序可以扩展或增强Asana的功能。许多人构建Asana应用程序以与其他工具集成,添加或提取有关工作图或自动化工作流。

可以构建应用程序,然后与其他Asana用户共享,也可以只为您的组织构建应用程序。例如,可以为个人用户构建应用程序谷歌硬盘将谷歌文件附加到任务。还可以构建应用程序来运行组织级流程。例如,来自奥克塔或运行自定义脚本。

构建应用程序并发布到应用程序目录

如果您正在构建与第三方工具的集成,并打算让任何Asana用户发现它,则可以将应用程序发布到Asana应用程序目录。应用程序目录是用户发现新应用程序的好地方,可以帮助他们充分利用Asana。我们建议访问应用程序目录并尝试使用应用程序来了解有关Asana可以构建的内容的更多信息。

仅为一个组织构建应用程序

如果你的应用程序不适合任何Asana用户使用,那么也可以创建应用程序,然后只与你选择的组织共享。默认情况下,所有应用程序开始时都是开发者专用的。您可以在开发人员控制台内的“管理分发”选项卡中更改应用程序的共享权限。

Asana应用程序使用rest API、应用程序组件和webhook等功能。进一步了解如何使用这些功能为我们的常见用例.


在使用Asana构建应用程序之前,我需要知道什么?

虽然没有两个应用程序是完全相同的。我们有一套通用的最佳实践,可以帮助您与Asana一起构建成功的应用程序。

以下概述了构建应用程序所需遵循的步骤。

规划你的应用程序

在开始构建Asana应用程序之前,我们建议您熟悉工作图,即核心Asana对象及其关系。查看有关理解对象的快速指南.

接下来,我们建议您规划应用程序。此步骤可帮助您定义应用程序要解决的确切问题,并熟悉Asana平台中的功能,这些功能将帮助您构建正确的解决方案。查看我们的用例库,示例应用程序、和目录中的其他应用程序激发灵感。

API入门

下一步是尝试使用API测试其工作方式。Asana平台的主要功能是我们的rest API,因此我们建议您熟悉我们的API的工作原理。

以下是如何开始的简要概述:

  1. 选择您的测试工作区。您可以在任何现有工作区中进行测试,创建免费帐户,或请求开发人员沙箱。开发者沙箱将允许您测试免费帐户中未包含的高级功能。
  2. 选择您的身份验证方法。您的应用程序最终可能会使用OAuth,但大多数开发人员通过创建个人访问令牌(PAT)来测试我们的API,以进行首次API调用。
  3. 在中创建令牌或应用程序开发人员控制台.
  4. 使用令牌进行API调用。访问API参考并了解可用的不同类型的API。我们的嵌入式API浏览器让您尝试使用引用中的API。在文档页面上构建您的请求,按“Try it”,几秒钟后就会看到响应。如果您想要一份进行首次API调用的分步指南,查看我们的快速入门指南.

构建您的应用程序并与其预期受众共享

一旦你计划好了应用程序,并且不再测试API,你就可以构建你的应用程序了。如果您使用PAT或服务帐户令牌进行构建,则您的应用程序只能在您的组织中使用。如果您正在构建应用程序以供任何用户发现,我们建议您创建应用程序并使用OAuth。默认情况下,所有OAuth应用程序都是私下创建的。您需要更改应用程序分发设置,以便仅与特定组织共享应用程序,或与具有OAuth重定向URL的任何人共享应用程序。

  1. 了解更多您可能想考虑的不同功能,如网钩对Asana的变化做出反应或应用程序组件用于将应用程序直接嵌入Asana。
  2. 使用API引用来确定哪种类型的API调用最适合您的用例。
  3. 设置身份验证方法(建议使用OAuth)。了解有关身份验证选项的更多信息.
  4. 编写应用程序代码。如果你想从一个例子开始,您可以查看我们的Github示例应用程序库.
  5. 部署你的应用程序。
    1. 本地-对于简单脚本,创建一个启动作业(或Windows任务计划程序)可能已经足够了,而更复杂的应用程序或那些使用webhooks或应用程序组件等功能的应用程序,将具有更复杂的托管、安全和正常运行时间要求。
    2. 托管-一些开发人员选择使用他们公司的on-prem解决方案,许多人使用托管提供商。如果您的公司还没有可以使用的托管提供商,以下是一些常见的选择:
      亚马逊网络服务(AWS),谷歌云,希罗库,Microsoft Azure(Microsoft Azure),IBM云,活力,Vercel公司
  6. 共享你的应用程序(可选)。当你的应用准备好使用时,我们建议检查你的分发设置。在开发人员控制台>管理分发。在那里,您可以与更多工作区共享应用程序,也可以选择与“任何工作区”共享应用程序。这意味着任何具有OAuth重定向URL的用户都可以对应用程序进行授权。如果您正在使用PAT或服务帐户令牌,则无需共享您的应用程序,因为这些令牌只能在您是用户的工作区中使用。
  7. 发布你的应用程序(可选)。如果你想在Asana应用程序目录中发布你的应用程序。将分发设置为“任何工作区”,然后按照开发人员控制台>提交供审阅页面上的说明进行操作。