开发人员空间 - 开发扩展程序
您可通过开发人员空间中的“开发扩展程序”部分创建自己的 eWidget 扩展程序。您创建的扩展程序可以供其他用户从 Marketplace 安装并使用。
Zoho Marketplace
Zoho Marketplace 是一个在线平台,提供扩展程序和小部件,可帮助用户增强跨多个应用程序的工作流程。用户可以从 Zoho Marketplace 安装扩展程序,从而在 Zoho 应用程序的现有功能基础上加以扩展。
除了已经可用的扩展程序外,开发人员现在还可以为 Zoho Mail 创建更全面的扩展程序。可以构建这些扩展以将 Zoho Mail 的功能与第三方应用程序的功能集成在一起。这有助于用户构建适合自定义要求的扩展程序。
构建扩展程序后,必须将其提交以供审核。分析功能后,您的扩展程序将获得批准,并将在 Zoho Marketplace 上发布,所有 Zoho 用户都可以安装和使用该应用程序。
开发扩展程序
您可以使用预先填充的 Zoho Mail 插件清单直接从 Zoho Sigma 平台开始构建扩展程序。或者,您也可以使用 ZET CLI 构建扩展程序,然后将文件上传到 Zoho Sigma 进行提交。
在 Zoho Sigma 中创建扩展程序
首先,在 Zoho Sigma 中为自己创建一个工作区,步骤如下:
- 登录到 Zoho Sigma
- 输入您的工作区名称
- 单击创建工作区
创建工作空间后,单击右上角的新建扩展程序按钮。输入详细信息,例如名称和描述,然后从服务部分中选择 Zoho Mail。然后单击另存为草稿并按照此帮助页面中提供的详细说明,开始在 Sigma 中创建扩展程序。
使用 ZET CLI 创建扩展程序
命令行界面 (CLI) 用于创建和打包小组件。Zet 命令是用于为 Zoho Mail 打包小部件的 CLI。
先决条件
为了为 Zoho Mail 创建自己的小部件,您需要下载 nodejs。您可以从这里下载它。(不支持 7 以下版本)
您可以通过运行以下命令来验证节点:
$ node -v 验证节点的版本。
$ npm -v 验证 npm 的版本。
安装
使用以下命令安装 ZET(Zoho 扩展套件)CLI。
$ npm install -g zoho-extension-toolkit@latest
运行以下 ZET 命令来验证安装。将显示有关各种支持命令的帮助详细信息:
$ zet
创建一个项目
使用以下命令创建项目:
$ zet init
将显示 Zoho 服务的列表。选择 Zoho Mail 然后按 Enter 键。
系统将提示您提供项目名称。键入首选项目名称,然后按 Enter 键。
包括资源
输入项目名称后,将在系统上创建同名目录。它包含所有必需的文件夹、文件和软件包。
导航到项目目录并打开“App”文件夹。将小部件的资源包含到相关的子文件夹中。
运行服务器
运行以下命令启动在本地运行扩展程序的 http 服务器:
$ zet run
此命令使用本地计算机的 5000 端口。在启动服务器之前,请确保 5000 端口未被占用。
要验证服务器是否成功运行,请在浏览器中打开给定的 URL:
http://127.0.0.1:5000/
验证并打包
执行以下命令验证您的扩展程序:
$ zet validate
您的扩展程序需要遵循下面给出的规范。运行 validate 命令将识别任何违反规范的行为(如果有)。任何此类违规行为都需要在上传 zip 之前得到纠正。
运行以下 pack 命令来创建一个 zip 文件,其中包含运行扩展程序所需的所有文件和文件夹:
$ zet pack
zip 位于项目目录的 dist 文件夹中。您可以将此 zip 上传到 Marketplace。
规格
您的扩展的项目目录包含一个 plugin-manifest.json 文件。此文件包含扩展程序的配置详细信息。此文件中包含的密钥需要遵循以下配置:
- locale:这是扩展的默认语言环境。项目目录的 translation 文件夹应包含所有翻译文件。文件的格式应为“<locale-code>.json”。
- *service:为其创建扩展程序的 Zoho 产品。
- 在为 Zoho Mail 创建扩展程序时,服务密钥将在清单中自动填充为 "service": "MAIL"。
- storage:如果您希望扩展程序存储应用程序数据,则应将此键的值设置为“true”。
- logo:您希望用作扩展程序徽标的图像的文件路径。例如:“apps/images/logo.png”
- *modules:小组件是用于 Zoho 邮件扩展程序的模块。它是扩展程序详细信息构成的阵列。小组件模块必须具有以下一组属性。
- location:您的小组件在 Zoho 产品中的位置。对于 Zoho Mail 来说,它必须是“zoho.mail.preview.rightpanel”。
- name:小组件的项目目录的名称。这是自动填充的。
- url:这是为您的小组件定义的路径。
清单示例:
"modules": {
"widgets": [
{
"location": "zoho.mail.preview.rightpanel",
"name": "extension_name",
"url": "/app/widget.html"
}
]
}
- connectors:连接器允许您将扩展程序与第三方应用程序集成。单击此处了解更多关于连接器的信息
连接器键需要具有以下结构:"connectors": [
{
"serviceName": "name_of_the_service"
}
] - config:此键包含在安装扩展程序期间需要配置的参数。config 键的结构应如下所示:
"config": [
{
"name": "Param name",
"mandatory": "true/false",
"secure": "true/false",
"inputType": "text /dropdown/ checkbox"
"option": [{
"text": "option1"
"value": "1"
}]
}
]参数 值 name* 表示参数名称的字段。 mandatory* true - 如果参数必须是必需的
false - 如果参数并非必需secure* true - 如果输入的值应该隐藏
false - 如果不需要隐藏这些值inputType* 文本/下拉/复选框 选项 仅当所选的 inputType 为下拉列表时才需要。它用于表示下拉列表中的不同选项及其对应的值。
* 强制性
测试扩展程序
您可以通过几个简单的步骤在本地测试您的扩展程序:
- 打开您的终端并导航到您的项目目录。
- 执行以下命令运行扩展:zet run
- 登录到您的 Zoho Mail 帐户并访问 https://mail.zoho.com/zm/sandbox.do URL。
- 转到设置 >> 集成 >> 开发人员空间
- 通过单击集成图标来打开 eWidget 窗格。
- 打开开发人员模式开关。
此处将列出您在本地运行的扩展程序,以供进一步测试。
提交扩展程序
打包扩展程序后,您需要将 zip 提交到 Zoho Marketplace 进行审核。
上传 Zip
- 登录到 Zoho 帐户。
- 转到 Sigma 网站。
- 单击页面右上角的新建扩展程序按钮。
- 输入以下详细信息:
- 名称 - 您要提交的扩展程序的名称
- 描述 - 您的扩展程序的简短描述
- 服务 - 从列表中选择 Zoho Mail 图标
- 如果您有要上传的插件清单 ZIP 文件,请将“上传现有文件”开关转到开启。
- 选择我同意条款和条件按钮,然后单击另存为草稿。
- 此时将会打开插件清单编辑器窗口。保存所做的任何更改并关闭窗口。所有扩展程序都将显示为卡片。
- 将鼠标悬停在您要提交的扩展程序上,然后单击扩展程序详细信息图标。
- 然后单击页面右上角的发布按钮。
- 应用程序可见性弹出窗口将打开。选择是希望扩展程序为公开还是私有,然后单击发布。
- 私有 - 如果要在一个小组内使用扩展程序,可以选择私有选项。私有扩展程序只能供您共享了安装链接的人员使用。
- 公开 - 如果您想在 Zoho Marketplace 上发布您的扩展程序供客户安装,您需要选择公开选项。
根据您选择的是私有上传还是公开上传,前两个步骤中要求您提供的数据会有所不同。如下所示:
公开扩展程序
输入以下详细信息以在 Zoho Marketplace 中发布公开扩展程序:
- 主要:
- 请提供以下信息:
- 类别 - 选择适合扩展程序用途和性质的标签。
- 隐私政策 - 输入链接以获取扩展程序的隐私详细信息。
- 服务条款 - 输入扩展程序的服务条款文档的 URL。
- 选中我同意 Marketplace 供应商协议复选框。
- 单击下一步。
- 请提供以下信息:
- 先决条件:
- 从受支持的版本下拉列表中选择要为该扩展程序支持哪种价格版本。
- 单击下一步。
- 图像:
- 上传您的扩展程序的以下文件:
- 扩展程序图标 - 分辨率 180 x 180
- 缩略图 - 分辨率 740 x 340
- 屏幕截图 - 为扩展程序添加所需的屏幕截图。
- 单击下一步
- 上传您的扩展程序的以下文件:
- 摘要:
- 输入以下详细信息:
- 宣传语
- 描述
- 主要功能
- 用户培训链接
- 帮助视频链接
- 单击下一步
- 输入以下详细信息:
- 定价:
- 输入以下详细信息:
- 全球可用 - 选择是否希望扩展程序在全球范围内可用。
- 定价 - 选择扩展程序的定价。
- 单击提交。
- 输入以下详细信息:
现在,您的附加信息已提交给 Zoho Mail 团队进行审核。测试应用程序的功能和可用性,如果需要,可以提出改进建议。审核过程完成后,该应用程序将在 Zoho Marketplace 上发布,供用户安装。
共享您的扩展程序
您可以通过 Zoho Mail 中的集成设置与组织成员共享创建的扩展程序。
扩展程序将提交给管理员批准。一旦获得组织管理员的批准,该扩展程序将可供其他组织成员安装和使用。了解更多。
更新您的扩展程序
您可以更新扩展程序的版本以添加功能或修复错误。
- 转到 Sigma 应用程序列表,然后将鼠标悬停在要更新的扩展程序上。
- 单击扩展程序详细信息按钮。
- 单击右上角的编辑扩展程序按钮。
- 编辑构建器窗口将会打开。进行必要的更改,然后单击保存。关闭窗口。
- 单击页面右上角的发布按钮以提交更新后的扩展程序。
审核过程完成后,您的应用程序的更新版本将在 Zoho Marketplace 中提供。如果是私有扩展程序,则将获取更新后的应用程序的安装链接。
开发人员空间 SDK
开发人员空间 API 是用于在您创建的应用程序中融入各种 Zoho Mail 功能的命令。有关所有命令的列表,请参阅此帮助页面。
示例扩展程序
该示例扩展程序使您可以探索 Zoho Mail 开发人员空间提供的功能。示例扩展程序的功能旨在让您尝试可以整合到自定义扩展程序中的不同操作。
在此处下载示例扩展程序。您还可以从 Zoho Sigma 扩展程序库中测试示例应用程序。
注意:
- 开发人员空间仅适用于付费组织用户。
- 开发人员空间需要由组织管理员为组织成员启用。如果没有访问权限,请联系您的管理员。了解详情