简介

已完成

您可以创建一个开放源自定义连接器并对其进行认证,以便所有用户都可轻松获得。 开放源可确保您的连接器将发布到 Microsoft Power Platform GitHub 存储库。 从存储库中,任何用户都可以将您的自定义连接器定义导入到环境中并使用,或者为您的连接器做出贡献,以供您考虑采用。 当您创建自定义连接器时,它仅可供您本人以及您明确与之共享连接器的用户使用。 连接器需要经过认证后,才能显示在 Microsoft Power Automate、Microsoft Power Apps 或 Microsoft Azure 逻辑应用的任何用户的正式连接器列表中。

何时认证自定义连接器

认证自定义连接器的原因很多,但最主要的原因有易于使用、可见性和扩大 API 的普及范围。 如果自定义连接器提供对 API 的访问权限,而该 API 对广泛受众有用且不以内部为中心,则可认证您的自定义连接器。 您不必在 Microsoft 技术上托管 API 基础服务。 事实上,连接器有助于将 Microsoft Power Platform 解决方案与非 Microsoft 解决方案集成。 您可以免费或使用付费的 API 认证连接器。

经过认证的连接器将接受审核,以在发布前确保其符合认证条件。 连接器发布者可分为两种类型,即已验证发布者和独立发布者。

  • 已验证发布者 - 一个重要要求是您必须拥有基础服务或提供使用 API 的明确权限,并提供与产品良好匹配的用户应用场景。

  • 独立发布者 - 不负责其连接器背后的基础服务。 例如,不隶属于某公司的 API 用户可以提交该 API 的连接器以进行认证。 这种类型使社区中的人员能够参与到 Power Platform 连接器的生态系统中。

连接器初次认证和更新是免费的。 下一单元将进一步解释认证流程。

何时创建开放源自定义连接器

如果您确定其他人可以从您生成的任何自定义连接器中受益,则该连接器可以成为开放源的候选者。 当您认证连接器时,第一步是使定义成为开放源。 首先,检查存储库中是否存在您要构建的 API 的现有自定义连接器定义。 如果您找到定义,我们建议您通过提交拉取请求来参与修改该定义,使其更加完善,而不是尝试创建重复的连接器。

以下示例说明在什么情况下适合/不适合创建开放源自定义连接器。

适合使用开放源 不适合使用开放源
公开供任何人使用的 API 的连接器 仅在公司网络内提供的专用 API 的连接器

大多数贡献要求您同意贡献者许可协议 (CLA),并声明您有权(并且确实有权)授予我们使用您的贡献的权利。 有关详细信息,请参阅贡献者许可协议

GitHub 存储库有三个主要文件夹中包含连接器:custom-connectorsindependent-publisher-connectorscertified-connectors

custom-connectors 文件夹包含功能完整的连接器示例,可部署到 Microsoft Power Platform 以进行扩展和使用。 这些示例可能不是经过认证的连接器,但由开放源社区创建和维护,以提供有用的方案或连接器概念示例。

independent-publisher-connectors 文件夹中包含的连接器,是由不负责其连接器背后的基础服务的发布者提交的。 这些连接器作为高级连接器在 Power Platform 中部署和提供。 任何人都可以在此文件夹中提交新的连接器,向此文件夹中的连接器添加功能,并解决与此文件夹中的连接器相关的问题。 该文件夹由独立发布者连接器社区管理,该社区中包括独立发布者和项目协调员。 主分支由 Microsoft 连接器认证团队维护,该团队可确保连接器版本与部署在 Power Platform 中的连接器版本相同。 开发分支由连接器维护者和 Microsoft 连接器认证团队共同维护,以便在认证和部署某版本之前允许社区开发该连接器。

certified-connectors 文件夹包含已认证的连接器,这些连接器已经在 Microsoft Power Platform 中部署且可直接使用。 Microsoft 连接器认证计划的一个要求是,新的已认证连接器必须是可供社区参与编辑的开放源。 Microsoft Connector 认证团队管理经认证的连接器文件夹,以确保在分支中,连接器版本与部署在 Microsoft Power Platform 中的连接器版本相同。 开发分支由连接器所有者和 Microsoft 连接器认证团队维护,以便在认证和部署版本之前允许社区开发连接器。

要为 GitHub 存储库做出贡献,您首先要获取自己的存储库副本(或创建分支)。 相关步骤在创建分叉文档中进行了说明。 创建分叉后,别人即可通过使用拉取请求参与编辑您的连接器。 您可以使用 Microsoft Power Platform 连接器 CLI 下载连接器资产。

使用 Microsoft Power Platform 连接器 CLI 进行下载

为了准备好必要的文件以创建开放源连接器,请使用 Microsoft Power Platform 连接器 CLI 中的 paconn download 命令。

通过运行以下命令下载自定义连接器文件:

paconn download

运行本命令时,它将通过设备登录来允许 paconn 代表您访问您的 Microsoft Power Platform 环境。 您通过身份验证后,paconn 将提供环境列表供您选择,然后提供连接器列表供您选择。

如果您知道您的环境 ID 和连接器 ID,则可以使用以下命令行语法避免显示提示:

paconn download -e [Microsoft Power Platform Environment GUID] -c [Connector ID]

下载内容包括四个文件:

  • apiDefintion.swagger.json - 您的连接器的 OpenAPI 定义,包括所有触发器和操作。

  • apiProperties.json - 定义策略模板和其他未包含在 OpenAPI 说明中的扩展连接器属性。

  • icon.png - 一个小图标,当用户使用连接器时,设计器中使用该图标表示该服务。

  • settings.json - 供使用,而不是向 paconn 提供参数。

将自定义连接器设为开放源,然后对其进行认证,可帮助您的 API 获得更多曝光度。 通过将连接器定义贡献给开放源存储库,您的自定义连接器将可供其他人使用。 人们使用经过认证的连接器时,他们使用的是在您发布更新时自动更新的定义。 使用开放源连接器定义时,用户需要将更新应用于自己的副本。 本模块的其余部分将探讨如何认证自定义连接器以及如何在您不断完善连接器的过程中管理其生命周期。