Créer et gérer des soumissions

  • Article
  • 9 minutes de lecture

Utilisez l’API de soumission Microsoft Store pour interroger et créer par programmation des soumissions pour les applications, les modules complémentaires et les versions d’évaluation de package pour votre compte espace partenaires ou votre organisation. Cette API est utile si votre compte gère beaucoup d’applications ou d’extensions et que vous voulez automatiser et optimiser le processus de soumission de ces ressources. Cette API utilise Azure Active Directory (Azure AD) pour authentifier les appels en provenance de votre application ou service.

Les étapes suivantes décrivent le processus de bout en bout de l’utilisation de l’API de soumission Microsoft Store :

  1. Vérifiez que vous avez rempli toutes les conditions préalables.
  2. Avant d’appeler une méthode dans l’API de soumission du Microsoft Store, obtenez un jeton d’accès Azure AD. Une fois le jeton obtenu, vous avez 60 minutes pour l’utiliser dans les appels à l’API de soumission au Microsoft Store avant expiration. Une fois le jeton arrivé à expiration, vous pouvez en générer un nouveau.
  3. Appelez l’API de soumission Microsoft Store.

Important

Si vous utilisez cette API pour créer une soumission pour une application, une version d’évaluation de package ou un module complémentaire, veillez à apporter d’autres modifications à la soumission uniquement à l’aide de l’API, plutôt que dans l’Espace partenaires. Si vous utilisez l’Espace partenaires pour modifier une soumission que vous avez créée à l’origine à l’aide de l’API, vous ne pourrez plus modifier ou valider cette soumission à l’aide de l’API. Dans certains cas, la soumission peut être laissée dans un état d’erreur où elle ne peut pas se poursuivre dans le processus de soumission. Si cela se produit, vous devez supprimer la soumission et en créer une nouvelle.

Important

Vous ne pouvez pas utiliser cette API pour publier des soumissions pour des achats en volume via le Microsoft Store pour Entreprises et Microsoft Store pour Éducation ou pour publier des soumissions pour les applications métier directement auprès des entreprises. Pour ces deux scénarios, vous devez utiliser publier la soumission dans l’Espace partenaires.

Notes

Cette API ne peut pas être utilisée avec des applications ou des modules complémentaires qui utilisent des mises à jour d’application obligatoires et des modules complémentaires consommables gérés par le Store. Si vous utilisez l’API de soumission Microsoft Store avec une application ou un module complémentaire qui utilise l’une de ces fonctionnalités, l’API retourne un code d’erreur 409. Dans ce cas, vous devez utiliser l’Espace partenaires pour gérer les soumissions pour l’application ou le module complémentaire.

Étape 1 : Remplir les conditions préalables à l’utilisation de l’API de soumission Microsoft Store

Avant de commencer à écrire du code pour appeler l’API de soumission au Microsoft Store, vérifiez que vous avez rempli les conditions préalables suivantes.

  • Vous (ou votre organisation) devez disposer d’un annuaire Azure AD et de l’autorisation Administrateur général sur l’annuaire. Si vous utilisez déjà Microsoft 365 ou d’autres services professionnels de Microsoft, vous disposez déjà d’un annuaire Azure AD. Sinon, vous pouvez créer un nouvel Azure AD dans l’Espace partenaires sans frais supplémentaires.

  • Vous devez associer une application Azure AD à votre compte Espace partenaires et récupérer votre ID tenant, votre ID client et votre clé. Ces valeurs sont nécessaires pour obtenir un jeton d’accès Azure AD, que vous utiliserez dans les appels à l’API de soumission au Microsoft Store.

  • Préparez votre application à utiliser avec l’API de soumission du Store Microsoft :

    • Si votre application n’existe pas encore dans l’Espace partenaires, vous devez créer votre application en réservant son nom dans l’Espace partenaires. Vous ne pouvez pas utiliser l’API de soumission du Store Microsoft pour créer une application dans l’Espace partenaires ; vous devez travailler dans l’Espace partenaires pour la créer, puis vous pouvez utiliser l’API pour accéder à l’application et créer par programmation des soumissions pour celle-ci. En revanche, vous pouvez vous servir de l’API pour créer des extensions et des versions d’évaluation de package par programmation avant de créer des soumissions pour ces ressources.

    • Avant de pouvoir créer une soumission pour une application donnée à l’aide de cette API, vous devez d’abord créer une soumission pour l’application dans l’Espace partenaires, y compris répondre au questionnaire d’évaluation de l’âge . Après quoi, vous pourrez créer des soumissions par programmation pour cette application à l’aide de l’API. Vous n’avez pas besoin de créer une soumission d’extension ou de version d’évaluation de package avant d’utiliser l’API pour ces types de soumission.

    • Si vous créez ou mettez à jour une soumission d’application et que vous devez inclure un package d’application, préparez le package d’application.

    • Si vous créez ou mettez à jour une soumission d’application et que vous devez inclure des captures d’écran ou des images à des fins de présentation sur le Store, préparez les captures d’écran et les images de l’application.

    • Si vous créez ou mettez à jour une soumission d’extension et que vous devez inclure une icône, préparez le package l’icône.

Associer une application Azure AD à un compte Espace partenaires

Avant de pouvoir utiliser l’API de soumission Microsoft Store, vous devez associer une application Azure AD à votre compte Espace partenaires, récupérer l’ID de locataire et l’ID client de l’application et générer une clé. L’application Azure AD représente l’application ou le service à partir duquel vous souhaitez appeler l’API de soumission Microsoft Store. Il vous faut l’ID tenant, l’ID client et la clé pour obtenir un jeton d’accès Azure AD à transmettre à l’API.

Notes

Vous n’avez besoin d’effectuer cette tâche qu’une seule fois. Une fois que vous les avez, vous pouvez réutiliser l’ID tenant, l’ID client et la clé chaque fois que vous devez créer un jeton d’accès Azure AD.

  1. Dans l’Espace partenaires, associez le compte Espace partenaires de votre organisation à l’annuaire Azure AD de votre organisation.

  2. Ensuite, sur la page Utilisateurs de la section Paramètres de compte de l’Espace partenaires, ajoutez l’application Azure AD représentant l’application ou le service que vous utiliserez pour accéder aux soumissions de votre compte Espace partenaires. Veillez à attribuer à cette application le rôle Gestionnaire. Si l’application n’existe pas encore dans votre annuaire Azure AD, vous pouvez créer une application Azure AD dans l’Espace partenaires.

  3. Revenez à la page Utilisateurs, cliquez sur le nom de votre application Azure AD pour accéder à ses paramètres, puis copiez les valeurs ID tenant et ID client.

  4. Cliquez sur Ajouter une nouvelle clé. Sur l’écran suivant, copiez la valeur Clé. Vous ne pourrez plus accéder à cette information une fois que vous aurez quitté cette page. Pour plus d’informations, voir Gérer les clés pour une application Azure AD.

Étape 2 : Obtenir un jeton d’accès Azure AD

Avant d’appeler l’une des méthodes de l’API de soumission du Microsoft Store, vous devez d’abord obtenir un jeton d’accès Azure AD que vous passez à l’en-tête d’autorisation de chaque méthode de l’API. Une fois que vous avez récupéré le jeton d’accès, vous avez 60 minutes pour l’utiliser avant qu’il n’expire. Une fois le jeton arrivé à expiration, vous pouvez l’actualiser pour pouvoir continuer à l’utiliser dans d’autres appels à l’API.

Pour obtenir le jeton d’accès, suivez les instructions présentées dans l’article Appels de service à service à l’aide des informations d’identification du client pour envoyer une requête HTTP POST au point de terminaison https://login.microsoftonline.com/<tenant_id>/oauth2/token. Voici un exemple de requête.

POST https://login.microsoftonline.com/<tenant_id>/oauth2/token HTTP/1.1
Host: login.microsoftonline.com
Content-Type: application/x-www-form-urlencoded; charset=utf-8

grant_type=client_credentials
&client_id=<your_client_id>
&client_secret=<your_client_secret>
&resource=https://manage.devcenter.microsoft.com

Pour la valeur tenant_id dans l’URI POST et les paramètres client_id et client_secret , spécifiez l’ID de locataire, l’ID client et la clé de votre application que vous avez récupérés à partir de l’Espace partenaires dans la section précédente. Pour le paramètre resource, vous devez spécifier https://manage.devcenter.microsoft.com.

Une fois votre jeton d’accès arrivé à expiration, vous pouvez l’actualiser en suivant les instructions fournies ici.

Pour obtenir des exemples qui montrent comment obtenir un jeton d’accès à l’aide de code C#, Java ou Python, consultez les exemples de code de l’API de soumission Microsoft Store.

Étape 3 : Utiliser l’API de soumission au Microsoft Store

Une fois que vous disposez d’un jeton d’accès Azure AD, vous pouvez appeler des méthodes dans l’API de soumission au Microsoft Store. L’API propose diverses méthodes qui sont regroupées dans des scénarios pour applications, extensions et versions d’essai de package. Pour créer ou mettre à jour des soumissions, vous appelez généralement plusieurs méthodes dans l’API de soumission Microsoft Store dans un ordre spécifique. Pour plus d’informations sur chaque scénario et sur la syntaxe de chacune de ces méthodes, voir les articles indiqués dans le tableau suivant.

Notes

Une fois que vous avez obtenu un jeton d’accès, vous disposez de 60 minutes pour appeler des méthodes dans l’API de soumission au Microsoft Store avant l’expiration du jeton.

Scénario Description
Applications Récupérez les données de toutes les applications inscrites sur votre compte Espace partenaires et créez des soumissions pour les applications. Pour plus d’informations sur ces méthodes, voir les articles suivants :
Modules complémentaires Obtient, crée ou supprime des extensions pour vos applications, puis obtient, crée ou supprime des soumissions pour les extensions. Pour plus d’informations sur ces méthodes, voir les articles suivants :
Versions d’évaluation de package Obtient, crée ou supprime des versions d’évaluation de package pour vos applications, puis obtient, crée ou supprime des soumissions pour les versions d’évaluation de package. Pour plus d’informations sur ces méthodes, voir les articles suivants :

Exemples de code

Les articles suivants fournissent des exemples de code détaillés qui montrent comment utiliser l’API de soumission Microsoft Store dans plusieurs langages de programmation différents :

Module StoreBroker PowerShell

En guise d’alternative à l’appel direct de l’API d’envoi Microsoft Store, nous fournissons également un module PowerShell open source qui implémente une interface de ligne de commande sur l’API. Ce module est appelé StoreBroker. Vous pouvez utiliser ce module pour gérer vos soumissions d’application, de version d’évaluation et de complément à partir de la ligne de commande au lieu d’appeler directement l’API de soumission du Store Microsoft, ou vous pouvez simplement parcourir la source pour voir d’autres exemples d’appel de cette API. Le module StoreBroker est activement utilisé dans Microsoft comme principal moyen de soumettre de nombreuses applications internes au Store.

Pour plus d’informations, consultez notre page StoreBroker sur GitHub.

Dépannage

Problème Résolution
Après avoir appelé l’API d’envoi Microsoft Store à partir de PowerShell, les données de réponse de l’API sont endommagées si vous les convertissez au format JSON en objet PowerShell à l’aide de l’applet de commande ConvertFrom-Json, puis revenez au format JSON à l’aide de l’applet de commande ConvertTo-Json. Par défaut, le paramètre -Depth de l’applet de commande ConvertTo-Json est défini sur 2 niveaux d’objets, ce qui est trop superficiel pour la plupart des objets JSON retournés par l’API de soumission du Store Microsoft. Quand vous appelez l’applet de commande ConvertTo Json, attribuez au paramètre -Depth une valeur supérieure, par exemple 20.

Aide supplémentaire

Si vous avez des questions sur l’API de soumission Microsoft Store ou si vous avez besoin d’aide pour gérer vos soumissions avec cette API, utilisez les ressources suivantes :

  • Posez vos questions sur nos forums.
  • Visitez notre page de support et demandez l’une des options de support assisté pour l’Espace partenaires. Si vous êtes invité à choisir un type de problème et une catégorie, choisissez respectivement Soumission d’application et certification et Soumission d’une application.