使用 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。
記下用戶端識別碼和新的 API 金鑰。
視需要更新您的驗證工作流程。
重新設定任何可能受到 API 金鑰變更影響的持續整合/持續傳遞 (CI/CD) 管線，例如，如果您要從使用此 REST API 的 v1 變更，它會使用存取令牌而非 API 密鑰。
當您使用 REST 端點時，請在要求標頭中指定 ClientID 和 API 金鑰。詳細數據位於下方的使用 API 端點。

詳細數據如下。

術語

術語	定義
操作	REST 作業，例如 GET 或 POST。
作業標識碼	REST 作業的標識碼。
包	`.zip`包含Microsoft Edge 附加元件檔案的套件。
產品	Microsoft Edge 延伸模組或主題。也稱為 Microsoft Edge 附加元件。
產品標識碼	必須發佈草稿之產品的產品標識碼。產品標識碼是與合作夥伴中心的產品相關聯的128位 GUID。例如：`d34f98f5-f9b7-42b1-bebb-98707202b21d`。
提交	正在合作夥伴中心提交至現有產品的更新。產品的每項更新都是提交，不論狀態是 `In Draft`、 `In Review`或 `In the Store` (發佈) 。

在合作夥伴中心啟用更新 REST API

若要使用 Microsoft Edge 附加元件 API，您必須先在 Microsoft 合作夥伴中心中建立 API 認證來啟用專案的 API，如下所示：

v1.1
v1

在合作夥伴中心開發人員儀錶板上，登入您用來發佈附加元件的帳戶。
在 [Microsoft Edge 程式] 底下，選取 [ 發佈 API]。
在 [啟用新體驗] 訊息旁，按兩下 [ 啟用 ] 按鈕：

上述螢幕快照顯示 v1 UI，包括 存取令牌 URL 和秘密，然後按兩下 [ 啟用 ] 按鈕以切換至 v1.1 UI。
在 [ 發佈 API] 頁面上，按兩下 [ 建立 API 認證 ] 按鈕。此步驟可能需要幾分鐘的時間才能完成。

系統會自動產生用戶端識別碼和新的 API 金鑰：

現在已建立 API 認證;您已啟用或更新 API。下列項目現在會顯示在 [發佈 API] 頁面上：
- 您的 用戶端識別碼。
- API 金鑰。
  - 每個 API 金鑰 的到期 日。
記下下列內容：
- 用戶端識別碼。
- 新的 API 金鑰。
使用 REST 端點時，您會在要求標頭中使用用戶端識別碼和 API 金鑰。

在合作夥伴中心開發人員儀錶板上，登入您用來發佈附加元件的帳戶。
在 [Microsoft Edge 程式] 底下，選取 [ 發佈 API]。
在 [ 發佈 API] 頁面上，按兩下 [ 建立 API 認證 ] 按鈕。此步驟可能需要幾分鐘的時間才能完成。

現在已建立 API 認證;您已啟用或更新 API。下列項目現在會顯示在 [發佈 API] 頁面上：
- 您的 用戶端識別碼。
- 您的 存取令牌 URL。
- 客戶端密碼。
  - 每個秘密的 到期日 。
記下下列內容：
- 用戶端識別碼。
- 存 取令牌 URL。
- 新的 客戶端密碼。
您將使用 [用戶端標識符]、[存取令牌 URL] 和 [用戶端密碼]，根據下方的 [擷取存取令牌] 取得存取令牌。然後使用 REST 端點時，您會在要求標頭中使用存取令牌。

重要事項

請務必立即記下用戶端密碼，因為它只會在啟用或更新 API (之後立即顯示，也就是在建立 API 認證之後) 。此特定密碼不會再次顯示。

您可以為用戶端識別碼產生多個客戶端密碼。例如，您可以為多個專案建立多個秘密。

擷取存取令牌

您可以將 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 金鑰和用戶端識別碼。

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 附加元件的產品標識碼。

若要取得產品識別碼：

登入您的合作夥伴中心開發人員儀錶板。
移至 Microsoft Edge>概觀] 。
選取您想要產品識別碼的延伸模組。

[ 延伸模組概觀 ] 頁面隨即開啟。產品標識碼會顯示在頁面中。 (產品識別碼也會顯示為網址列中 URL 中的 GUID，介於和 microsoftedge//packages.)
在 [ 延伸模組身 分識別] 區段 (或從 [網址列]) 中，選取並複製 [產品標識符]。

範例要求

若要上傳套件以更新現有的提交，請在命令提示字元使用 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 是上傳套件以更新現有提交或發佈提交之響應標頭中傳回的作業標識碼。

另請參閱在 REST API 參考中檢查發佈狀態， 以更新Microsoft Edge 附加元件。

端點描述

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 Accepted 具有標頭的響應狀態代碼 Location 。這個位置標頭包含 operationID 檢查發佈作業狀態所需的。

另請參閱:

在 REST API 參考中發佈產品草稿提交，以更新Microsoft Edge 附加元件。

檢查發佈狀態

使用此 API 來檢查發佈作業的狀態。

$operationID 是上傳套件以更新現有提交或發佈提交之響應標頭中傳回的作業標識碼。

另請參閱在 REST API 參考中檢查發佈狀態， 以更新Microsoft Edge 附加元件。

端點描述

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：

edge-developer Microsoft Edge 開發人員檔的存放庫問題。

Microsoft 身分識別平台：

Microsoft 身分識別平台和 OAuth 2.0 用戶端認證流程

共用方式為

使用 REST API 更新 Microsoft Edge 附加元件

更新 REST API 的版本

使用的元件

使用更新 REST API 的概觀

術語

在合作夥伴中心啟用更新 REST API

擷取存取令牌

範例要求

範例回應

使用 API 端點

上傳套件以更新現有的提交

端點描述

範例要求

檢查套件上傳的狀態

端點描述

範例要求

發佈提交

端點描述

範例要求

檢查發佈狀態

端點描述

範例要求

另請參閱

意見反應

其他資源