Partilhar via


API do painel de hardware

Use as APIs de Hardware da Microsoft para consultar e criar submissões programaticamente para produtos de hardware na conta do Partner Center da sua organização. Essas APIs são úteis se sua conta gerencia muitos produtos e você deseja automatizar e otimizar o processo de envio desses ativos. Essas APIs usam o Microsoft Entra ID (Microsoft Entra ID) para autenticar as chamadas do seu aplicativo ou serviço.

Somente contas que pertencem ao programa Hardware Partner Center podem usar as APIs do painel de hardware. Aqui está o processo de ponta a ponta do uso da API de Hardware da Microsoft:

  1. Preencha os pré-requisitos na próxima seção.

  2. Obtenha um token de acesso do Microsoft Entra ID antes de chamar um método na API de hardware da Microsoft. Depois de ter um token, você tem 60 minutos para usá-lo em chamadas para a API de envio da Microsoft Store antes que o token expire. Depois que o token expirar, você poderá gerar um novo.

  3. Chame a API de hardware da Microsoft.

Preencha os pré-requisitos para usar a API de Hardware da Microsoft

Antes de começar a escrever código para chamar a API de hardware da Microsoft, você deve concluir estes pré-requisitos necessários:

Atribuindo as funções de Hardware apropriadas ao seu aplicativo Microsoft Entra ID

Depois de concluir os pré-requisitos, atribua as funções apropriadas para que a aplicação Microsoft Entra ID possa criar e gerenciar submissões e etiquetas de envio.

  1. From Partner Center, select the gear icon (near the upper right corner of the dashboard) and then select Developer settings. In the Settings menu, select Users.

  2. On the Users page, select Microsoft Entra ID applications and the Microsoft Entra ID application that represents the app or service you use to access submissions for your Partner Center account.

  3. On this page, under Roles, select Hardware.

    Uma captura de tela mostrando a guia Hardware na seção Funções.

    Select Driver Submitter, Shipping Label owner, and if available, Shipping Label promoter. Saiba mais sobre essas funções

Obter um token de acesso do Microsoft Entra ID

Before you call any of the methods in the Microsoft Hardware API, you must first obtain a Microsoft Entra ID access token that you pass to the Authorization header of each method in the API. Depois de obter um token de acesso, você tem 60 minutos para usá-lo antes que ele expire. Depois que o token expirar, você poderá atualizá-lo, para que possa continuar a usá-lo em outras chamadas para a API. Para obter o token de acesso, siga as instruções em "Service to Service Calls Using Client Credentials" para enviar um HTTP POST para o endpoint https://login.microsoftonline.com/<tenant_id>/oauth2/token. Aqui está uma solicitação de exemplo.

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

For the tenant_id value in the POST URI and the client_id and client_secret parameters, specify the tenant ID, client ID, and the key for your application that you retrieved from Partner Center in the previous section. For the resource parameter, you must specify https://manage.devcenter.microsoft.com.

Depois que o token de acesso expirar, você poderá atualizá-lo seguindo as instruções em Atualizando os tokens de acesso.

Usar a API de hardware da Microsoft

Depois de ter um token de acesso do Microsoft Entra ID, você pode chamar métodos na API de hardware da Microsoft. A API inclui muitos métodos que são agrupados em cenários. Para criar ou atualizar envios, normalmente você chama vários métodos na API de Hardware da Microsoft em uma ordem específica. Para obter informações sobre cada cenário e a sintaxe de cada método, consulte os artigos na tabela a seguir.

Scenario Description
Drivers Obtenha, crie e atualize drivers registrados em sua conta do Partner Center. Para obter mais informações sobre esses métodos, consulte os seguintes artigos:

Code sample

O exemplo de código a seguir fornece uma solução completa pré-criada de ponta a ponta criada pela equipe do Microsoft Surface e Dispositivos:

More help

If you have questions about the Microsoft Store submission API or need assistance managing your submissions with this API, visit the support page and request help.