Verwenden der REST-API zum Aktualisieren von Microsoft Edge-Add-Ons

Verwenden Sie diese REST-API, um eine Erweiterung, die auf der Microsoft Edge-Add-Ons-Website veröffentlicht wurde, programmgesteuert zu aktualisieren, um den Prozess des Hochladens und Veröffentlichens neuer Versionen Ihrer Erweiterung zu automatisieren. Sie können diese REST-API-Endpunkte direkt in Ihre CI/CD-Pipeline (Continuous Integration/Continuous Delivery) integrieren, um Erweiterungspaketupdates auf der Microsoft Edge-Add-Ons-Website zu veröffentlichen, ohne Partner Center zu verwenden.

Diese REST-API macht Endpunkte für Folgendes verfügbar:

• Hochladen eines Pakets zum Aktualisieren einer vorhandenen Übermittlung
• Überprüfen der status eines Paketuploads
• Veröffentlichen der Übermittlung
• Überprüfen der Veröffentlichungs-status

Diese Endpunkte werden unten beschrieben.

Um diese REST-API zu verwenden, verwenden Sie zunächst die Seite Api veröffentlichen im Partner Center, um die API zu aktivieren.

Um zunächst eine neue Erweiterung zu veröffentlichen, verwenden Sie Partner Center. Um die Erweiterung zu aktualisieren, verwenden Sie entweder manuell Partner Center, oder verwenden Sie diese REST-API programmgesteuert.

Um Vorschläge und Feedback zu übermitteln, geben Sie ein Problem zur Add-Ons-API ein.

Versionen der Update-REST-API

Ab dem 6. September 2024 werden sowohl v1.1 als auch v1 dieser Update-REST-API unterstützt. Der Support für v1 endet am 31. Dezember 2024.

Verwendete Komponenten

v1.1

v1.1 verwendet einen API-Schlüssel. Die Benutzeroberfläche im Partner Center stellt API-Schlüssel bereit.

Die REST-Endpunkte verwenden bestimmte Anforderungsheader für v1.1.

v1

v1 erfordert das Senden eines Zugriffstokens an den API-Endpunkt. Sie erhalten das Zugriffstoken, indem Sie eine POST-Nachricht an eine Zugriffstoken-URL senden. Auf der Partner Center-Benutzeroberfläche wird die Zugriffstoken-URL angezeigt.

v1 verwendet Geheimnisse. Die Benutzeroberfläche im Partner Center enthält Geheimnisse.

Die REST-Endpunkte verwenden bestimmte Anforderungsheader für v1.

Übersicht über die Verwendung der Update-REST-API

So verwenden Sie die Update-REST-API:

v1.1

1. Melden Sie sich in Ihrem Partner Center-Entwickler-Dashboard für die Benutzeroberfläche an, die API-Schlüssel verwendet, indem Sie neben auf die Schaltfläche Aktivieren klicken, um die neue Benutzeroberfläche zu aktivieren. Details finden Sie unten unter Aktivieren der Update-REST-API im Partner Center.

2. Notieren Sie sich die Client-ID und den neuen API-Schlüssel.

3. Aktualisieren Sie Bei Bedarf Ihre Authentifizierungsworkflows.

4. Konfigurieren Sie alle CI/CD-Pipelines (Continuous Integration/Continuous Delivery), die möglicherweise von Änderungen am API-Schlüssel betroffen sind, z. B. wenn Sie von der Verwendung von v1 dieser REST-API wechseln, die Zugriffstoken anstelle von API-Schlüsseln verwendet.

5. Wenn Sie einen REST-Endpunkt verwenden, geben Sie die ClientID und den API-Schlüssel im Anforderungsheader an. Details finden Sie weiter unten unter Verwenden der API-Endpunkte.

v1

1. Rufen Sie in Ihrem Partner Center-Entwickler-Dashboard ein Zugriffstoken aus der Zugriffstoken-URL ab. Details finden Sie unten unter Aktivieren der Update-REST-API im Partner Center.

2. Generieren Sie Ihre ClientID und Geheimnisse. Sie können mehrere geheime Clientschlüssel für Ihre Client-ID generieren. Sie können beispielsweise mehrere Geheimnisse für mehrere Projekte erstellen.

3. Aktualisieren Sie Bei Bedarf Ihre Authentifizierungsworkflows.

4. Konfigurieren Sie alle vorhandenen CI/CD-Pipelines (Continuous Integration/Continuous Delivery), die möglicherweise von den Änderungen an der Zugriffstoken-URL betroffen sind.

5. Rufen Sie das Zugriffstoken ab. Details finden Sie weiter unten unter Abrufen des Zugriffstokens.

6. Wenn Sie einen REST-Endpunkt verwenden, geben Sie das Zugriffstoken im Anforderungsheader an. Details finden Sie weiter unten unter Verwenden der API-Endpunkte.

Details finden Sie unten.

Begrifflichkeiten

Begriff	Definition
operation	Ein REST-Vorgang wie GET oder POST.
Vorgangs-ID	Die ID eines REST-Vorgangs.
package	Das .zip Paket, das die Dateien für Ihr Microsoft Edge-Add-On enthält.
Produkt	Eine Microsoft Edge-Erweiterung oder ein Design. Wird auch als Microsoft Edge-Add-On bezeichnet.
Produkt-ID	Die Produkt-ID des Produkts, dessen Entwurf veröffentlicht werden muss. Die Produkt-ID ist eine 128-Bit-GUID, die einem Produkt im Partner Center zugeordnet ist. Beispiel: d34f98f5-f9b7-42b1-bebb-98707202b21d.
Unterwerfung	Ein Update, das an ein vorhandenes Produkt im Partner Center übermittelt wird. Jedes Update an einem Produkt ist eine Übermittlung, unabhängig davon, ob die status , In Reviewoder In the Store (veröffentlicht) istIn Draft.

Aktivieren der Update-REST-API im Partner Center

Um die Microsoft Edge-Add-Ons-API verwenden zu können, müssen Sie zunächst die API für Ihr Projekt im Microsoft Partner Center aktivieren, indem Sie API-Anmeldeinformationen wie folgt erstellen:

v1.1

1. Melden Sie sich bei Ihrem Partner Center-Entwickler-Dashboard bei dem Konto an, das Sie zum Veröffentlichen eines Add-Ons verwendet haben.

2. Wählen Sie unter dem Microsoft Edge-Programm die Option Api veröffentlichen aus.

3. Klicken Sie neben der Meldung "Neue Benutzeroberfläche aktivieren" auf die Schaltfläche Aktivieren :

   

   Der obige Screenshot zeigt die Benutzeroberfläche v1, einschließlich Zugriffstoken-URL und Geheimnisse, bevor Sie auf die Schaltfläche Aktivieren klicken, um zur Benutzeroberfläche v1.1 zu wechseln.

4. Klicken Sie auf der Seite API veröffentlichen auf die Schaltfläche API-Anmeldeinformationen erstellen . Dieser Schritt kann einige Minuten dauern.

   Die Client-ID und ein neuer API-Schlüssel werden automatisch generiert:

   

   Die API-Anmeldeinformationen wurden jetzt erstellt. Sie haben die API aktiviert oder erneuert. Die folgenden Elemente werden jetzt auf der Seite Api veröffentlichen angezeigt:

   • Ihre Client-ID.
   • API-Schlüssel.
     • Das Ablaufdatum für jeden API-Schlüssel.

5. Notieren Sie sich Folgendes:

   • Die Client-ID.
   • Der neue API-Schlüssel.

   Sie verwenden die Client-ID und den API-Schlüssel im Anforderungsheader, wenn Sie einen REST-Endpunkt verwenden.

v1

1. Melden Sie sich bei Ihrem Partner Center-Entwickler-Dashboard bei dem Konto an, das Sie zum Veröffentlichen eines Add-Ons verwendet haben.

2. Wählen Sie unter dem Microsoft Edge-Programm die Option Api veröffentlichen aus.

3. Klicken Sie auf der Seite API veröffentlichen auf die Schaltfläche API-Anmeldeinformationen erstellen . Dieser Schritt kann einige Minuten dauern.

   Die API-Anmeldeinformationen wurden jetzt erstellt. Sie haben die API aktiviert oder erneuert. Die folgenden Elemente werden jetzt auf der Seite Api veröffentlichen angezeigt:

   • Ihre Client-ID.
   • Ihre Zugriffstoken-URL.
   • Geheime Clientschlüssel.
     • Das Ablaufdatum jedes Geheimnisses.

   

4. Notieren Sie sich Folgendes:

   • Die Client-ID.
   • Die Zugriffstoken-URL.
   • Der neue geheime Clientschlüssel.

   Sie verwenden die Client-ID, die Zugriffstoken-URL und den geheimen Clientschlüssel, um ein Zugriffstoken zu erhalten, siehe Abrufen des Zugriffstokens unter . Anschließend verwenden Sie das Zugriffstoken im Anforderungsheader, wenn Sie einen REST-Endpunkt verwenden.

Wichtig

Notieren Sie sich den geheimen Clientschlüssel jetzt, da er nur unmittelbar nach dem Aktivieren oder Erneuern der API (d. a. nach dem Erstellen von API-Anmeldeinformationen) sichtbar ist. Dieses bestimmte Geheimnis wird nicht erneut angezeigt.

Sie können mehrere geheime Clientschlüssel für Ihre Client-ID generieren. Sie können beispielsweise mehrere Geheimnisse für mehrere Projekte erstellen.

Abrufen des Zugriffstokens

Sie erhalten ein Zugriffstoken, indem Sie eine POST-Nachricht an eine Zugriffstoken-URL senden. Auf der Partner Center-Benutzeroberfläche wird die Zugriffstoken-URL angezeigt, die mit der in diesem Artikel beschriebenen url identisch ist. Fügen Sie dann das Zugriffstoken in den Header ein, wenn Sie einen API-Endpunkt verwenden, z. B. den Endpunkt für das Hochladen eines Pakets zum Aktualisieren einer vorhandenen Übermittlung( unten).

Beschreibung des Endpunkts, der zum Abrufen eines Zugriffstokens verwendet werden soll:

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

Beispielanfrage

Um beispielsweise ein Zugriffstoken abzurufen, senden Sie eine POST-Anforderung an die Zugriffstoken-URL, indem Sie einen curl Befehl an der Eingabeaufforderung wie folgt eingeben:

> 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

Beispielantwort

Ein Zugriffstoken wird an Sie zurückgegeben, z. B.:

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

Weitere Informationen finden Sie unter Abrufen eines Tokens in Microsoft Identity Platform und im Flow für OAuth 2.0-Clientanmeldeinformationen.

Verwenden der API-Endpunkte

Die Update-REST-API macht Endpunkte für Folgendes verfügbar:

• Hochladen eines Pakets zum Aktualisieren einer vorhandenen Übermittlung
• Überprüfen der status eines Paketuploads
• Veröffentlichen der Übermittlung
• Überprüfen der Veröffentlichungs-status

Diese Endpunkte werden unten vorgestellt.

Um diese Update-REST-API für Microsoft Edge-Add-Ons verwenden zu können, müssen Sie über Folgendes verfügen:

v1.1

Ein API-Schlüssel und eine Client-ID.

v1

Ein Zugriffstoken.

Die API ist im Endpunktstamm https://api.addons.microsoftedge.microsoft.comverfügbar.

Es gibt keine REST-API-Endpunkte für:

• Erstellen eines neuen Produkts.
• Aktualisieren der Metadaten eines Produkts, z. B. der Beschreibung.

Um ein neues Produkt zu erstellen oder die Metadaten eines Produkts zu aktualisieren, müssen Sie Microsoft Partner Center verwenden.

Hochladen eines Pakets zum Aktualisieren einer vorhandenen Übermittlung

Verwenden Sie diesen REST-API-Endpunkt, um das Paket für ein Add-On zu aktualisieren. Diese API lädt ein Paket hoch, um einen vorhandenen Entwurf der Übermittlung eines Add-On-Produkts zu aktualisieren.

Weitere Informationen zum Aktualisieren von Microsoft Edge-Add-Ons finden Sie unter Hochladen eines Pakets zum Aktualisieren einer vorhandenen Übermittlung in der REST-API-Referenz.

Endpunktbeschreibung

v1.1

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

v1

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 ist die Produkt-ID des Microsoft Edge-Add-Ons, das Sie aktualisieren möchten.

So rufen Sie die Produkt-ID ab:

1. Melden Sie sich bei Ihrem Partner Center-Entwickler-Dashboard an.

2. Wechseln Sie zu Microsoft Edge>Übersicht.

3. Wählen Sie die Erweiterung aus, für die Sie die Produkt-ID verwenden möchten.

   Die Seite Mit der Erweiterungsübersicht wird geöffnet. Die Produkt-ID wird auf der Seite angezeigt. (Die Produkt-ID wird auch als GUID in der URL in der Adressleiste zwischen microsoftedge/ und /packagesangezeigt.)

4. Wählen Sie im Abschnitt Erweiterungsidentität (oder in der Adressleiste) die Produkt-ID aus, und kopieren Sie sie.

Beispielanfrage

Um ein Paket hochzuladen, um eine vorhandene Übermittlung zu aktualisieren, verwenden Sie den curl Befehl an einer Eingabeaufforderung wie folgt:

v1.1

> 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

v1

> 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

Wenn die Anforderung erfolgreich ist und der Aktualisierungsprozess beginnt, erhalten Sie eine 202 Accepted Antwort status Code mit einem Location Header. Dieser Speicherortheader enthält die , die operationID zum Überprüfen der status des Aktualisierungsvorgangs erforderlich ist.

Siehe auch:

• Laden Sie ein Paket hoch, um eine vorhandene Übermittlung in der REST-API-Referenz zum Aktualisieren von Microsoft Edge-Add-Ons zu aktualisieren.

Überprüfen der status eines Paketuploads

Verwenden Sie diese API, um die status des Paketuploads zu überprüfen.

$operationID ist die Vorgangs-ID, die im Antwortheader von Hochladen eines Pakets zum Aktualisieren einer vorhandenen Übermittlung oder Veröffentlichen der Übermittlung zurückgegeben wird.

Informationen zum Aktualisieren von Microsoft Edge-Add-Ons finden Sie unter Überprüfen der Veröffentlichungs-status in der REST-API-Referenz.

Endpunktbeschreibung

v1.1

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

v1

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

Beispielanfrage

Um die status eines Paketuploads zu überprüfen, verwenden Sie den curl Befehl an der Eingabeaufforderung wie folgt:

v1.1

> 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

v1

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

Siehe auch:

• Überprüfen Sie die status eines Paketuploads in der REST-API-Referenz zum Aktualisieren von Microsoft Edge-Add-Ons.

Veröffentlichen der Übermittlung

Verwenden Sie diese API, um den aktuellen Entwurf des Produkts auf der Microsoft Edge-Add-Ons-Website zu veröffentlichen.

Informationen zum Aktualisieren von Microsoft Edge-Add-Ons finden Sie unter Veröffentlichen der Produktentwurfsübermittlung in der REST-API-Referenz.

Endpunktbeschreibung

v1.1

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

v1

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

Beispielanfrage

Um die Übermittlung zu veröffentlichen, verwenden Sie den curl Befehl an der Eingabeaufforderung wie folgt:

v1.1

> 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

v1

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

Wenn die Anforderung erfolgreich ist und der Veröffentlichungsprozess beginnt, erhalten Sie eine 202 Accepted Antwort status Code mit einem Location Header. Dieser Speicherortheader enthält die , die operationID zum Überprüfen der status des Veröffentlichungsvorgangs erforderlich ist.

Siehe auch:

• Veröffentlichen Sie die Produktentwurfsübermittlung in derREST-API-Referenz zum Aktualisieren von Microsoft Edge-Add-Ons.

Überprüfen der Veröffentlichungs-status

Verwenden Sie diese API, um die status des Veröffentlichungsvorgangs zu überprüfen.

$operationID ist die Vorgangs-ID, die im Antwortheader von Hochladen eines Pakets zum Aktualisieren einer vorhandenen Übermittlung oder Veröffentlichen der Übermittlung zurückgegeben wird.

Informationen zum Aktualisieren von Microsoft Edge-Add-Ons finden Sie unter Überprüfen der Veröffentlichungs-status in der REST-API-Referenz.

Endpunktbeschreibung

v1.1

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

v1

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

Beispielanfrage

Um die Veröffentlichungs-status zu überprüfen, verwenden Sie den curl Befehl an der Eingabeaufforderung wie folgt:

v1.1

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

v1

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

Siehe auch:

• Überprüfen Sie die Veröffentlichungs-status in der REST-API-Referenz zum Aktualisieren von Microsoft Edge-Add-Ons.

Siehe auch

• REST-API-Referenz zum Aktualisieren von Microsoft Edge-Add-Ons : REST-API zum Aktualisieren einer Erweiterung.
• Unterstützte APIs für Microsoft Edge-Erweiterungen : JavaScript-APIs zum Entwickeln einer Erweiterung.

GitHub:

• Probleme im edge-developer Repository für Microsoft Edge Developer-Dokumentation.

Microsoft Identity Platform:

• Microsoft Identity Platform und den Flow für OAuth 2.0-Clientanmeldeinformationen