开发指引

文章内容

在首页左侧的「团队设置中心」，前往「生态能力」中的「发布应用」新建应用或管理已发布的应用。

创建应用时需填写应用表单。

以下为创建应用各个表单项的解释：

表单项	说明
应用名称	简短的应用名称，应用名称仅支持中字母数字和空格，字符长度需在 2-32 位之间
应用标识	应用的全站唯一标识，不可重复，建议使用网站域名等信息组成。应用标识必须以小写字母数字开头结尾，包含小写字母、数字、字符，字符长度需在 3-32 位之间
回调地址	OAuth2 应用授权回调的地址，地址必须是合法的 Http(s) 地址。
应用主页	OAuth2 应用授权页面展示的应用主页链接地址，地址必须是合法的 Http(s) 地址，非 OAuth2 应用可不填。
应用描述	精简的语言描述清楚应用的主要功能和特性。

如需要对应用信息进行更改，可进入应用详情页右上角的“编辑”按钮进行修改。

应用列表将通过卡片形式展示应用简介，包括应用名、应用图标、应用描述、更新人、更新时间等信息。你可通过页面中的搜索输入框进行搜索，支持通过应用名和应用标识进行关键词搜索。

点击任一应用进入详情页，将展示应用图标、应用名称、应用描述等基本信息。在详情页中将展示应用内的相关功能，包括：版本管理、客户端密钥、令牌权限、权限管理等。

标签页将为您展示应用的版本信息。系统将在首次创建应用时自动创建一个初始版本（v0.0.1）。

版本列表支持通过版本号和构建号进行列表筛选，若数据较多将进行分页展示。

版本详情页将展示版本号等基本信息，同时也会以标签页形式展示版本的其他功能，包括：版本信息、应用配置、开发预览。

版本信息在发布前后均可编辑，以下为版本信息各个表单项的说明：

表单项	说明
版本号	遵循 Semantic Versioning 2.0.0 规范的版本号，具体规则请点击链接查看。
构建号	应用下唯一的构建号，通常建议使用版本控制系统（vcs）中的提交记录 ID
应用入口	安装此版本的应用加载时的链接地址，地址必须是合法的 Http(s) 地址，已发布的版本必须是 Http(s) 链接地址。
描述	精简的语言描述清楚此版本主要改动内容和功能特性

在使用应用的过程中可能需要收集用户的输入项以运行逻辑。此时开发者可以参考“示例配置”设定配置表单项，应用使用者在使用应用的过程中按指引填写表单项并保存。系统在加载运行应用时，会将使用者填写的设置项的内容传输到应用端。

点击页面中“查看示例配置”可弹出示例配置，复制示例配置并修改后进行提交。

开发应用的过程中将生成一个临时的开发预览地址，预览地址默认有效期为 72 小时，且该地址只支持团队内成员访问。开发预览地址支持项目内和项目外的预览，可点击下拉框选择需要进行预览的项目。

客户端密钥用于应用开发和 OAuth2 应用授权流程。

OAuth2 应用授权认证过程需要 ClientId 和 ClientSecret，您可以在此页面点击「生成新的客户端密钥」或者在创建应用后首次进入页面时，复制可查看明文的密钥。

嵌入式应用在开发时，需要使用 ClientId 才能加载应用的上下文数据。

为保证密钥安全性，客户端密钥最多只能生成 5 个，且仅允许首次生成时查看和复制密钥内容，一旦生成后刷新或者离开页面，均不可再次查看和复制密钥内容。

如密钥确实已不再使用，建议将密钥进行删除，避免造成数据泄露等安全问题。

令牌权限用于配置应用的用户会话令牌、OAuth2 令牌访问团队数据接口时的权限范围，请在合理的范围内配置权限范围，避免在安装授权或者 OAuth2 授权时因权限过大而被使用者拒绝授权。

点击具体权限项右侧的下拉框可进行权限范围配置。

此处的权限指的是针对应用的使用与管理权限，系统中预设两项权限组以便快速配置权限，以下是对应权限组的说明：

⚠️ 此权限配置仅针对当前应用生效，如需配置团队级权限，请前往团队权限配置中心。

权限组	功能点说明
应用开发者	查看应用、删除应用、编辑应用、管理客户端密钥、管理应用版本、管理令牌权限
应用管理员	查看应用、删除应用、编辑应用、管理客户端密钥、管理应用版本、管理令牌权限、管理应用权限

问题反馈 >

2023-10-23最近更新

感谢反馈有用

感谢反馈没用