使用 REST API 更新 Microsoft Edge 加载项

项目
09/25/2024

使用此 REST API 以编程方式更新在 Microsoft Edge 加载项网站上发布的扩展，以自动执行上传和发布新版本扩展的过程。可以将这些 REST API 终结点直接集成到持续集成/持续交付 (CI/CD) 管道中，以在不使用合作伙伴中心的情况下将扩展包更新发布到 Microsoft Edge 加载项网站。

此 REST API 公开以下项的终结点：

上传包以更新现有提交
检查包上传的状态
发布提交
检查发布状态

下面介绍了这些终结点。

若要使用此 REST API，请先使用合作伙伴中心的 “发布 API ”页来启用该 API。

若要最初发布新扩展，请使用合作伙伴中心。若要更新扩展，请手动使用合作伙伴中心，或以编程方式使用此 REST API。

若要提交建议和反馈，请输入有关加载项 API 的问题。

更新 REST API 的版本

从 2024 年 9 月 6 日开始，此更新 REST API 的 v1.1 和 v1 均受支持。稍后将不再支持 v1。 v1 支持的终止日期尚未敲定。

v1.1 使用 API 密钥。合作伙伴中心的 UI 提供 API 密钥。

REST 终结点使用 v1.1 的特定请求标头。

使用更新 REST API 的概述

若要使用更新 REST API，请执行以下命令：

v1.1
v1

在合作伙伴中心开发人员仪表板，通过单击旁边的“启用”按钮来启用新体验，选择加入使用 API 密钥的 UI。有关详细信息，请参阅下面的在合作伙伴中心启用更新 REST API。
记下客户端 ID 和新 API 密钥。
根据需要更新身份验证工作流。
重新配置任何持续集成/持续交付 (CI/CD) 管道，这些管道可能会受到 API 密钥的任何更改的影响，例如，如果要从使用此 REST API 的 v1 进行更改，该 API 使用访问令牌而不是 API 密钥。
使用 REST 终结点时，请在请求标头中指定 ClientID 和 API 密钥。有关详细信息，请参阅下面的使用 API 终结点。

详细信息如下所示。

术语

Term	定义
operation	REST 操作，例如 GET 或 POST。
操作 ID	REST 操作的 ID。
package	包含 `.zip` Microsoft Edge 加载项的文件的包。
产品	Microsoft Edge 扩展或主题。也称为 Microsoft Edge 加载项。
产品 ID	需要发布草稿的产品的产品 ID。产品 ID 是与合作伙伴中心的产品关联的 128 位 GUID。例如：`d34f98f5-f9b7-42b1-bebb-98707202b21d`。
提交	正在合作伙伴中心提交到现有产品的更新。产品的每次更新都是提交，无论状态是 `In Draft`、 `In Review`还是 `In the Store` 发布) (。

在合作伙伴中心启用更新 REST API

若要使用 Microsoft Edge 加载项 API，首先需要通过创建 API 凭据在 Microsoft 合作伙伴中心为项目启用 API，如下所示：

v1.1
v1

在合作伙伴中心开发人员仪表板，登录到用于发布加载项的帐户。
在 “Microsoft Edge 程序”下，选择“ 发布 API”。
在消息“启用新体验”旁边，单击“ 启用” 按钮：

上面的屏幕截图显示了在单击“启用”按钮切换到 v1.1 UI 之前 v1 UI，包括访问令牌 URL 和机密。
在 “发布 API ”页上，单击“ 创建 API 凭据 ”按钮。此步骤可能需要几分钟才能完成。

将自动生成客户端 ID 和新的 API 密钥：

API 凭据现已创建;你已启用或续订 API。以下项现在显示在 “发布 API ”页上：
- 客户端 ID。
- API 密钥。
  - 每个 API 密钥的到期日期。
记下以下内容：
- 客户端 ID。
- 新的 API 密钥。
使用 REST 终结点时，会在请求标头中使用客户端 ID 和 API 密钥。

在合作伙伴中心开发人员仪表板，登录到用于发布加载项的帐户。
在 “Microsoft Edge 程序”下，选择“ 发布 API”。
在 “发布 API ”页上，单击“ 创建 API 凭据 ”按钮。此步骤可能需要几分钟才能完成。

API 凭据现已创建;你已启用或续订 API。以下项现在显示在 “发布 API ”页上：
- 客户端 ID。
- 访问 令牌 URL。
- 客户端机密。
  - 每个机密的 到期日期 。
记下以下内容：
- 客户端 ID。
- 访问令牌 URL。
- 新的 客户端密码。
你将使用客户端 ID、访问令牌 URL 和客户端密码来获取访问令牌（根据检索访问令牌，如下所示）。然后，在使用 REST 终结点时，会在请求标头中使用访问令牌。

重要

现在请务必记下客户端密码，因为它仅在启用或续订 API (（即创建 API 凭据) 之后）后立即可见。不会再次显示此特定机密。

可以为客户端 ID 生成多个客户端密码。例如，可以为多个项目创建多个机密。

检索访问令牌

可以通过将 POST 消息发送到访问令牌 URL 来获取访问令牌。合作伙伴中心 UI 显示访问令牌 URL，与本文中的内容相同。然后，在使用 API 终结点时，在标头中包括访问令牌，例如下面用于上传包以更新现有提交的终结点。

用于获取访问令牌的终结点的说明：

Endpoint: https://login.microsoftonline.com/5c9eedce-81bc-42f3-8823-48ba6258b391/oauth2/v2.0/token
Type: POST
Header Parameters: Content-Type: application/x-www-form-urlencoded

示例请求

例如，若要获取访问令牌，请在命令提示符处输入 curl 命令，将 POST 请求发送到访问令牌 URL，如下所示：

> curl \
-X POST \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "client_id={$Client_ID}" \
-d "scope=https://api.addons.microsoftedge.microsoft.com/.default" \
-d "client_secret={$Client_Secret}" \
-d "grant_type=client_credentials" \
-v \
https://login.microsoftonline.com/5c9eedce-81bc-42f3-8823-48ba6258b391/oauth2/v2.0/token

示例响应

访问令牌将返回给你，例如：

{
  "token_type": "Bearer",
  "expires_in": 3599,
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6Ik1uQ19WWmNBVGZNNXBP..."
}

有关详细信息，请参阅在 Microsoft 标识平台和 OAuth 2.0 客户端凭据流中获取令牌。

使用 API 终结点

更新 REST API 公开以下项的终结点：

上传包以更新现有提交
检查包上传的状态
发布提交
检查发布状态

下面介绍了这些终结点。

若要使用此Microsoft Edge 加载项更新 REST API，必须满足上述条件：

v1.1
v1

API 密钥和客户端 ID。

API 在终结点根 https://api.addons.microsoftedge.microsoft.com处可用。

没有用于以下项的 REST API 终结点：

创建新产品。
更新产品的元数据，例如说明。

若要创建新产品或更新产品的元数据，必须使用 Microsoft 合作伙伴中心。

上传包以更新现有提交

使用此 REST API 终结点更新加载项的包。此 API 上传包以更新加载项产品的现有草稿提交。

另请参阅 REST API 参考中的上传包以更新现有提交，以更新Microsoft Edge 加载项。

终结点说明

v1.1
v1

Endpoint: /v1/products/$productID/submissions/draft/package
Type: POST
Header Parameters: Authorization: ApiKey $ApiKey; X-ClientID: $ClientID; Content-Type: application/zip
Body content: the package file to upload

Endpoint: /v1/products/$productID/submissions/draft/package
Type: POST
Header Parameters: Authorization: Bearer $TOKEN; Content-Type: application/zip
Body content: the package file to upload

$productID 是要更新的 Microsoft Edge 加载项的产品 ID。

若要获取产品 ID，请执行以下操作：

登录到合作伙伴中心开发人员仪表板。
转到 Microsoft Edge>概述。
选择要为其提供产品 ID 的扩展。

此时会打开 “扩展概述 ”页。产品 ID 显示在页面中。 (产品 ID 也显示为地址栏中的 URL 中的 GUID，介于和 /packages之间 microsoftedge/ )
在“ 扩展标识 ”部分 (或从地址栏) ，选择并复制 “产品 ID”。

示例请求

若要上传包以更新现有提交，请在命令提示符处使用命令， curl 如下所示：

v1.1
v1

> curl \
-H "Authorization: ApiKey $ApiKey" \
-H "X-ClientID: $ClientID" \
-H "Content-Type: application/zip" \
-X POST \
-T $FILE_NAME \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/draft/package

> curl \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/zip" \
-X POST \
-T $FILE_NAME \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/draft/package

如果请求成功且更新过程开始，则会收到带有 202 Accepted 标头的 Location 响应状态代码。此位置标头包含 operationID 检查更新操作状态所需的。

另请参阅：

在 REST API 参考中上传包以更新现有提交，以更新Microsoft Edge 加载项。

检查包上传的状态

使用此 API 检查包上传的状态。

$operationID 是在 “上传包以更新现有提交 ”或“ 发布提交”响应标头中返回的操作 ID。

另请参阅有关更新Microsoft Edge 加载项的 REST API 参考中的检查发布状态。

终结点说明

v1.1
v1

Endpoint: /v1/products/$productID/submissions/draft/package/operations/$operationID
Type: GET
Header Parameters: Authorization: ApiKey $ApiKey; X-ClientID: $ClientID

Endpoint: /v1/products/$productID/submissions/draft/package/operations/$operationID
Type: GET
Header Parameters: Authorization: Bearer $TOKEN

示例请求

若要检查包上传的状态，请在命令提示符处使用 curl 命令，如下所示：

v1.1
v1

> curl \
-H "Authorization: ApiKey $ApiKey" \
-H "X-ClientID: $ClientID" \
-X GET \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/draft/package/operations/$operationID

> curl \
-H "Authorization: Bearer $TOKEN" \
-X GET \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/draft/package/operations/$operationID

另请参阅：

在 REST API 参考中检查包上传的状态，以更新Microsoft Edge 加载项。

发布提交

使用此 API 将产品的当前草稿发布到 Microsoft Edge 加载项网站。

另请参阅在 REST API 参考中发布产品草稿提交，以更新Microsoft Edge 加载项。

终结点说明

v1.1
v1

Endpoint: /v1/products/$productID/submissions
Type: POST
Header Parameters: Authorization: ApiKey $ApiKey; X-ClientID: $ClientID
Body content: Notes for certification, in JSON format

Endpoint: /v1/products/$productID/submissions
Type: POST
Header Parameters: Authorization: Bearer $TOKEN
Body content: Notes for certification, in JSON format

示例请求

若要发布提交，请在 curl 命令提示符处使用命令，如下所示：

v1.1
v1

> curl \
-H "Authorization: ApiKey $ApiKey" \
-H "X-ClientID: $ClientID" \
-X POST \
-d '{ "notes"="text value" }' \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions

> curl \
-H "Authorization: Bearer $TOKEN" \
-X POST \
-d '{ "notes"="text value" }' \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions

如果请求成功且发布过程开始，则会收到带有202 AcceptedLocation标头的响应状态代码。此位置标头包含 operationID 检查发布操作状态所需的。

另请参阅：

在 REST API 参考中发布产品草稿提交，以更新Microsoft Edge 加载项。

检查发布状态

使用此 API 检查发布操作的状态。

$operationID 是在 “上传包以更新现有提交 ”或“ 发布提交”响应标头中返回的操作 ID。

另请参阅有关更新Microsoft Edge 加载项的 REST API 参考中的检查发布状态。

终结点说明

v1.1
v1

Endpoint: /v1/products/$productID/submissions/operations/$operationID
Type: GET
Header Parameters: Authorization: ApiKey $ApiKey; X-ClientID: $ClientID

Endpoint: /v1/products/$productID/submissions/operations/$operationID
Type: GET
Header Parameters: Authorization: Bearer $TOKEN

示例请求

若要检查发布状态，请在命令提示符处使用 curl 命令，如下所示：

v1.1
v1

> curl \
-H "Authorization: ApiKey $ApiKey" \
-H "X-ClientID: $ClientID" \
-X GET \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/operations/$operationID

> curl \
-H "Authorization: Bearer $TOKEN" \
-X GET \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/operations/$operationID

另请参阅：

在 REST API 参考中检查发布状态，以更新Microsoft Edge 加载项。

另请参阅

用于更新Microsoft Edge 加载项的 REST API 参考 - 用于更新扩展的 REST API。
Microsoft Edge 扩展支持的 API - 用于开发扩展的 JavaScript API。

GitHub：

Microsoft Edge 开发人员文档的存储库中edge-developer的问题。

Microsoft 标识平台：

Microsoft 标识平台和 OAuth 2.0 客户端凭据流

通过

使用 REST API 更新 Microsoft Edge 加载项

更新 REST API 的版本

使用的组件

使用更新 REST API 的概述

术语

在合作伙伴中心启用更新 REST API

使用 API 终结点

上传包以更新现有提交

终结点说明

示例请求

检查包上传的状态

终结点说明

示例请求

发布提交

终结点说明

示例请求

检查发布状态

终结点说明

示例请求

另请参阅

反馈

其他资源