Freigeben über

Verwenden der Rest-API für Microsoft Edge-Add-Ons

  • Artikel

Die Microsoft Edge-Add-Ons-API stellt eine Reihe von REST-Endpunkten zum programmgesteuerten Veröffentlichen von Updates für Add-Ons bereit, die an den Microsoft Edge-Add-Ons-Store übermittelt werden. Sie können diese REST-Endpunkte verwenden, um den Prozess des Hochladens und Veröffentlichens neuer Versionen Ihrer Add-Ons im Microsoft Edge-Add-Ons-Store zu automatisieren. Sie verwenden die Seite API veröffentlichen im Partner Center, um mit diesen Endpunkten zu arbeiten.

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

Begrifflichkeiten

Begriff Definition
operation Ein REST-Vorgang wie GET oder PUT.
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.
Vorlage 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.

Bevor Sie beginnen:

Um die Microsoft Edge-Add-Ons-API verwenden zu können, müssen Sie die API für Ihr Projekt im Microsoft Partner Center aktivieren, indem Sie API-Anmeldeinformationen erstellen. Führen Sie die folgenden Schritte aus, um API-Anmeldeinformationen zu erstellen.

  1. Besuchen Sie Microsoft Partner Center, und melden Sie sich 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 Client-ID, der geheime Clientschlüssel, das Ablaufdatum und die Zugriffstoken-URL werden jetzt auf der Seite ApIs veröffentlichen angezeigt:

    Die Seite

  4. Notieren Sie sich die Client-ID, den geheimen Clientschlüssel und die Zugriffstoken-URL. Sie verwenden diese Werte im nächsten Schritt, um ein Zugriffstoken abzurufen.

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

Nachdem Sie die erforderliche Autorisierung für Ihre Anwendung erworben haben, rufen Sie Zugriffstoken für APIs ab. Um ein Token mithilfe der Clientanmeldeinformationen zu erhalten, senden Sie eine POST-Anforderung an die Zugriffstoken-URL (das OAuth-Token). Die Mandanteninformationen sind in der URL verfügbar, die Sie in den obigen Schritten vor Beginn erhalten haben.

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

> 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

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

Weitere Informationen finden Sie unter Flow für OAuth 2.0-Clientanmeldeinformationen auf der Microsoft Identity Platform.

Verwenden der API-Endpunkte

Nachdem Sie über ein Zugriffstoken verfügen, können Sie die Microsoft Edge-Add-Ons-API verwenden. Diese API macht Endpunkte verfügbar, um eine Liste von Produkten zu erhalten, Produkte zu aktualisieren und Produkte zu veröffentlichen.

Hinweis

Es gibt keine API zum Erstellen eines neuen Produkts oder Aktualisieren der Metadaten eines Produkts. Beispiel: Die Beschreibung. Sie müssen diese Aufgaben manuell im Microsoft Partner Center ausführen.

Die API ist am Endpunkt verfügbar. https://api.addons.microsoftedge.microsoft.com

Hochladen eines Pakets zum Aktualisieren einer vorhandenen Übermittlung

Verwenden Sie diese API, 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.

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.

Führen Sie die folgenden Schritte aus, um die Produkt-ID abzurufen:

  1. Melden Sie sich beim Microsoft Partner Center 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

> 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:

Überprüfen der status eines Paketuploads

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

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

Beispielanfrage

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

Siehe auch:

Veröffentlichen der Übermittlung

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

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

Beispielanfrage

> 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:

Überprüfen der Veröffentlichungs-status

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

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

Beispielanfrage

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

Siehe auch: