Microsoft Edge アドオン REST API の使用
Microsoft Edge アドオン API には、Microsoft Edge アドオン ストアに送信されたアドオンに更新プログラムをプログラムで公開するための一連の REST エンドポイントが用意されています。 これらの REST エンドポイントを使用すると、新しいバージョンのアドオンを Microsoft Edge アドオン ストアにアップロードして公開するプロセスを自動化できます。 パートナー センターの [API の発行] ページを使用して、これらのエンドポイントを操作します。
提案とフィードバックを送信するには、 アドオン API に関する問題を入力します。
用語
| 用語 | 定義 |
|---|---|
| operation | GET や PUT などの REST 操作。 |
| 操作 ID | REST 操作の ID。 |
| package | .zip Microsoft Edge アドオンのファイルを含むパッケージ。 |
| 製品 | Microsoft Edge 拡張機能またはテーマ。 Microsoft Edge アドオンとも呼ばれます。 |
| 製品 ID | 下書きを発行する必要がある製品の製品 ID。 製品 ID は、パートナー センターの製品に関連付けられている 128 ビット GUID です。 例: d34f98f5-f9b7-42b1-bebb-98707202b21d。 |
| 提出 | パートナー センターで既存の製品に送信される更新プログラム。 製品に対するすべての更新は、状態が 、、または In the Store (公開済み) であるかどうかに関係なく、申請です。In DraftIn Review |
開始する前に
Microsoft Edge アドオン API を使用するには、API 資格情報を作成して、Microsoft パートナー センターでプロジェクトの API を有効にする必要があります。 API 資格情報を作成するには、次の手順に従います。
Microsoft パートナー センターにアクセスし、アドオンの発行に使用したアカウントにサインインします。
Microsoft Edge プログラムで、[API の発行] を選択します。
[ API の発行 ] ページで、[ API 資格情報の作成 ] ボタンをクリックします。 この手順が完了するまでに数分かかる場合があります。
これで API 資格情報が作成されました。API を有効または更新しました。 クライアント ID、クライアント シークレット、有効期限、アクセス トークン URL が [API の発行] ページに表示されるようになりました。
![[API 資格情報の作成] をクリックした後、パートナー センターの [API の発行] ページに、クライアント ID、クライアント シークレット、および認証トークン URL が表示されるようになりました](using-addons-api-images/create-api-credentials-button.png)
クライアント ID、クライアント シークレット、アクセス トークン URL を書き留めます。 次の手順では、これらの値を使用してアクセス トークンを取得します。
重要
API を有効または更新した直後 (つまり、API 資格情報を作成した後) にのみ表示されるので、クライアント シークレットを今すぐ書き留めておいてください。 この特定のシークレットは再び表示されません。
クライアント ID に対して複数のクライアント シークレットを生成できます。 たとえば、複数のプロジェクトに対して複数のシークレットを作成できます。
アクセス トークンの取得
アプリケーションに必要な承認を取得したら、API のアクセス トークンを取得します。 クライアント資格情報の付与を使用してトークンを取得するには、アクセス トークン URL (OAuth トークン) に POST 要求を送信します。 テナント情報は、上記の「 開始する前 に」で受け取った URL で確認できます。
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 \
-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 ID プラットフォームの OAuth 2.0 クライアント資格情報フローに関するページを参照してください。
API エンドポイントの使用
アクセス トークンを取得したら、Microsoft Edge アドオン API を使用できます。 この API は、製品の一覧の取得、製品の更新、および製品の発行のためのエンドポイントを公開します。
注:
新しい製品を作成したり、製品のメタデータを更新したりするための API はありません。 たとえば、説明です。 これらのタスクは、Microsoft パートナー センターで手動で完了する必要があります。
API はエンドポイントで使用できます https://api.addons.microsoftedge.microsoft.com
既存の申請を更新するためのパッケージのアップロード
この API を使用して、アドオンのパッケージを更新します。 この API は、アドオン製品の既存の下書き申請を更新するパッケージをアップロードします。
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 パートナー センターにサインインします。
[Microsoft Edgeの概要] > に移動します。
製品 ID が必要な拡張機能を選択します。
[ 拡張機能の概要] ページが開きます。 製品 ID がページに表示されます。 (製品 ID は、 と の間
microsoftedge//packagesのアドレス バーの URL にも GUID として表示されます)。[ 拡張機能 ID ] セクション (またはアドレス バーから) で、 製品 ID を選択してコピーします。
要求のサンプル
> 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 更新操作の状態を確認するために必要な が含まれています。
関連項目:
- API リファレンス: パッケージをアップロードして既存の申請を更新する
パッケージのアップロードの状態を確認する
この API を使用して、パッケージのアップロードの状態をチェックします。
Endpoint: /v1/products/$productID/submissions/draft/package/operations/$operationID
Type: GET
Header Parameters: Authorization: Bearer $TOKEN
要求のサンプル
> curl \
-H "Authorization: Bearer $TOKEN" \
-X GET \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/draft/package/operations/$operationID
関連項目:
- API リファレンス: パッケージのアップロードの状態を確認する
申請の発行
この API を使用して、製品の現在のドラフトを Microsoft Edge アドオン Web サイトに公開します。
Endpoint: /v1/products/$productID/submissions
Type: POST
Header Parameters: Authorization: Bearer $TOKEN
Body content: Notes for certification, in JSON format
要求のサンプル
> 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 発行操作の状態を確認するために必要な が含まれています。
関連項目:
- API リファレンス: 製品ドラフト申請を発行する
発行状態の確認
発行操作の状態をチェックするには、この API を使用します。
Endpoint: /v1/products/$productID/submissions/operations/$operationID
Type: GET
Header Parameters: Authorization: Bearer $TOKEN
要求のサンプル
> curl \
-H "Authorization: Bearer $TOKEN" \
-X GET \
-v \
https://api.addons.microsoftedge.microsoft.com/v1/products/$productID/submissions/operations/{operationID}
関連項目: