API de tableau de bord matériel

  • Article

Utilisez les API de matériel Microsoft pour interroger et créer par programmation des soumissions de produits matériels dans le compte Espace partenaires de votre organization. Ces API sont utiles si votre compte gère de nombreux produits et que vous souhaitez automatiser et optimiser le processus d’envoi de ces ressources. Ces API utilisent Microsoft Entra ID (ID Microsoft Entra) pour authentifier les appels de votre application ou service. Les étapes suivantes décrivent le processus de bout en bout de l’utilisation de l’API matérielle Microsoft :

  1. Ces API ne peuvent être utilisées que par les comptes qui appartiennent au programme De l’Espace partenaires matériel.

  2. Vérifiez que vous avez rempli les conditions préalables ci-dessous.

  3. Avant d’appeler une méthode dans l’API matérielle Microsoft, obtenez un jeton d’accès d’ID Microsoft Entra, comme illustré ci-dessous. 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.

  4. Appelez l’API de matériel Microsoft.

Remplir les conditions préalables à l’utilisation de l’API matérielle Microsoft

Avant de commencer à écrire du code pour appeler l’API de matériel Microsoft, assurez-vous que vous avez rempli les conditions préalables requises suivantes.

Affectation des rôles matériels appropriés à votre application d’ID Microsoft Entra

Une fois que vous avez rempli les conditions préalables ci-dessus, nous devons maintenant attribuer les rôles appropriés afin que l’application ID Microsoft Entra puisse créer et gérer les soumissions et les étiquettes d’expédition.

  1. Dans l’Espace partenaires, sélectionnez l’icône d’engrenage (près du coin supérieur droit du tableau de bord), puis sélectionnez Paramètres du développeur. Dans le menu Paramètres , sélectionnez Utilisateurs.

  2. Dans la page Utilisateurs, sélectionnez Microsoft Entra applications d’ID et l’application ID Microsoft Entra qui représente l’application ou le service que vous utiliserez pour accéder aux soumissions pour votre compte Espace partenaires.

  3. Dans cette page, sous Rôles, sélectionnez Matériel.

    image montrant l’onglet Matériel de la section Rôles.

    Sélectionnez Driver Submitter, Shipping Label owner et, si disponible, Shipping Label promoter. En savoir plus sur ces rôles

Obtenir un jeton d’accès d’ID Microsoft Entra

Avant d’appeler l’une des méthodes de l’API matérielle Microsoft, vous devez d’abord obtenir un jeton d’accès d’ID Microsoft Entra que vous passez à l’en-tête d’autorisation de chaque méthode dans 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 expiré, vous pouvez l’actualiser afin de 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 expiré, vous pouvez l’actualiser en suivant les instructions fournies dans Actualisation des jetons d’accès.

Utiliser l’API matérielle Microsoft

Une fois que vous disposez d’un jeton d’accès d’ID Microsoft Entra, vous pouvez appeler des méthodes dans l’API matérielle Microsoft. L’API inclut de nombreuses méthodes qui sont regroupées dans des scénarios. Pour créer ou mettre à jour des soumissions, vous appelez généralement plusieurs méthodes dans l’API matériel Microsoft 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.

Scénario Description
Pilotes Obtenez, créez et mettez à jour des pilotes inscrits sur votre compte espace partenaires. Pour plus d’informations sur ces méthodes, voir les articles suivants :

Exemples de code

L’exemple suivant fournit un code détaillé qui montre comment utiliser l’API matériel Microsoft ainsi qu’une solution prédéfinie complète de bout en bout créée par l’équipe Microsoft Surface et Appareils :

Exemples d’API de tableau de bord matériel (GitHub)

Outil Surface Dev Center Manager (GitHub)

Aide supplémentaire

Si vous avez des questions sur l’API de soumission au Microsoft Store ou si vous avez besoin d’aide pour gérer vos soumissions avec cette API, visitez la page de support et demandez de l’aide.

Qu’est-ce que Microsoft Entra ID ?