Utilisation de l’API REST pour la mise à jour des modules complémentaires Microsoft Edge

La version 1.1 utilise une clé API. L’interface utilisateur de l’Espace partenaires fournit des clés API.

Les points de terminaison REST utilisent des en-têtes de requête spécifiques pour la version 1.1.

La version 1 nécessite l’envoi d’un jeton d’accès au point de terminaison d’API. Vous obtenez le jeton d’accès en envoyant un message POST à une URL de jeton d’accès. L’interface utilisateur de l’Espace partenaires affiche l’URL du jeton d’accès.

La version 1 utilise secrets. L’interface utilisateur de l’Espace partenaires fournit des secrets.

Les points de terminaison REST utilisent des en-têtes de requête spécifiques pour v1.

1. Dans le tableau de bord du développeur de l’Espace partenaires, optez pour l’interface utilisateur qui utilise des clés API en cliquant sur le bouton Activer en regard d’activer la nouvelle expérience. Vous trouverez plus d’informations dans Activer l’API REST de mise à jour dans l’Espace partenaires, ci-dessous.

2. Notez l’ID client et la nouvelle clé API.

3. Mettez à jour vos workflows d’authentification, si nécessaire.

4. Reconfigurez tous les pipelines d’intégration continue/livraison continue (CI/CD) susceptibles d’être affectés par les modifications apportées à la clé API, par exemple si vous utilisez la version v1 de cette API REST, qui utilise des jetons d’accès au lieu de clés API.

5. Lorsque vous utilisez un point de terminaison REST, spécifiez le ClientID et la clé API dans l’en-tête de requête. Pour plus d’informations, consultez Utilisation des points de terminaison d’API ci-dessous.

1. Dans le tableau de bord du développeur de l’Espace partenaires, obtenez un jeton d’accès à partir de l’URL du jeton d’accès. Vous trouverez plus d’informations dans Activer l’API REST de mise à jour dans l’Espace partenaires, ci-dessous.

2. Générez votre ClientID et vos secrets. Vous pouvez générer plusieurs secrets client pour votre ID client. Par exemple, vous pouvez créer plusieurs secrets pour plusieurs projets.

3. Mettez à jour vos workflows d’authentification, si nécessaire.

4. Reconfigurez tous les pipelines d’intégration continue/livraison continue (CI/CD) existants susceptibles d’être affectés par les modifications apportées à l’URL du jeton d’accès.

5. Récupérez le jeton d’accès. Pour plus d’informations, consultez Récupérer le jeton d’accès ci-dessous.

6. Lorsque vous utilisez un point de terminaison REST, spécifiez le jeton d’accès dans l’en-tête de requête. Pour plus d’informations, consultez Utilisation des points de terminaison d’API ci-dessous.

1. Dans le tableau de bord du développeur de l’Espace partenaires, connectez-vous au compte que vous avez utilisé pour publier un module complémentaire.

2. Sous le programme Microsoft Edge , sélectionnez Publier l’API.

3. En regard du message « Activer la nouvelle expérience », cliquez sur le bouton Activer :

   

   La capture d’écran ci-dessus montre l’interface utilisateur v1, y compris l’URL du jeton d’accès et les secrets, avant de cliquer sur le bouton Activer pour basculer vers l’interface utilisateur v1.1.

4. Dans la page Publier l’API , cliquez sur le bouton Créer des informations d’identification d’API . Cette étape peut prendre quelques minutes.

   L’ID client et une nouvelle clé API sont générés automatiquement :

   

   Les informations d’identification de l’API ont été créées ; vous avez activé ou renouvelé l’API. Les éléments suivants s’affichent désormais dans la page Publier l’API :

   • Votre ID client.
   • Clés API.
     • Date d’expiration de chaque clé API.

5. Notez les éléments suivants :

   • ID client.
   • Nouvelle clé API.

   Vous utiliserez l’ID client et la clé API dans l’en-tête de requête lors de l’utilisation d’un point de terminaison REST.

1. Dans le tableau de bord du développeur de l’Espace partenaires, connectez-vous au compte que vous avez utilisé pour publier un module complémentaire.

2. Sous le programme Microsoft Edge , sélectionnez Publier l’API.

3. Dans la page Publier l’API , cliquez sur le bouton Créer des informations d’identification d’API . Cette étape peut prendre quelques minutes.

   Les informations d’identification de l’API ont été créées ; vous avez activé ou renouvelé l’API. Les éléments suivants s’affichent désormais dans la page Publier l’API :

   • Votre ID client.
   • URL de votre jeton d’accès.
   • Clés secrètes client.
     • Date d’expiration de chaque secret.

   

4. Notez les éléments suivants :

   • ID client.
   • URL du jeton d’accès.
   • Nouvelle clé secrète client.

   Vous allez utiliser l’ID client, l’URL du jeton d’accès et la clé secrète client pour obtenir un jeton d’accès, par récupération du jeton d’accès, ci-dessous . Vous utiliserez ensuite le jeton d’accès dans l’en-tête de requête lors de l’utilisation d’un point de terminaison REST.

Vous pouvez générer plusieurs secrets client pour votre ID client. Par exemple, vous pouvez créer plusieurs secrets pour plusieurs projets.

Récupérer le jeton d’accès

Vous obtenez un jeton d’accès en envoyant un message POST à une URL de jeton d’accès. L’interface utilisateur de l’Espace partenaires affiche l’URL du jeton d’accès, qui est identique à celle de cet article. Vous incluez ensuite le jeton d’accès dans l’en-tête lors de l’utilisation d’un point de terminaison d’API, tel que le point de terminaison pour le chargement d’un package pour mettre à jour une soumission existante, ci-dessous.

Description du point de terminaison à utiliser pour obtenir un jeton d’accès :

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

Exemple de demande

Par exemple, pour obtenir un jeton d’accès, envoyez une requête POST à l’URL du jeton d’accès, en entrant une curl commande à l’invite de commandes, comme suit :

> 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

Exemple de réponse

Un jeton d’accès vous est retourné, par exemple :

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

Pour plus d’informations, consultez Obtenir un jeton dans Plateforme d'identités Microsoft et le flux d’informations d’identification du client OAuth 2.0.

Une clé API et un ID client.

Jeton d’accès.

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

> 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

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

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

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