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:
Preencha os pré-requisitos na próxima seção.
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.
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:
Você (ou sua organização) deve ter um diretório de ID do Microsoft Entra e deve ter permissão de de administrador global para o diretório. Se você já usa o Microsoft 365 ou outros serviços empresariais da Microsoft, você já tem o diretório Microsoft Entra ID. Caso contrário, você pode criar uma nova ID do Microsoft Entra no Partner Center sem nenhum custo extra.
Se ainda não existir uma aplicação Microsoft Entra ID, deve criar uma.
Você deve associar um aplicativo Microsoft Entra ID à sua conta do Partner Center e atribuir-lhe a função de Gestor .
Reúna sua ID de locatário do aplicativo Microsoft Entra ID, ID do cliente ede chave. Certifique-se de imprimir ou copiar essas informações de chave, pois você não poderá acessá-las novamente depois de sair da página de criação de chaves.
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.
No Partner Center, selecione o ícone de engrenagem (próximo ao canto superior direito do painel) e, em seguida, selecione Configurações do desenvolvedor. No menu Configurações, selecione Utilizadores.
Na página Usuários, selecione Aplicações Microsoft Entra ID e a aplicação Microsoft Entra ID que representa a aplicação ou serviço que utiliza para acessar as submissões na sua conta do Partner Center.
Nesta página, em Funções, selecione Hardware.
Selecione o remetente dos motoristas , o proprietário da etiqueta de envio e, se disponível, o promotor da etiqueta de envio . Saiba mais sobre essas funções
Obter um token de acesso do Microsoft Entra ID
Antes de chamar qualquer um dos métodos na API de Hardware da Microsoft, você deve primeiro obter um token de acesso do Microsoft Entra ID que você passa para o cabeçalho de Autorização de cada método na 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
Para obter o valor tenant_id no URI POST e os parâmetros client_id e client_secret, especifique a ID do locatário, a ID do cliente e a chave do aplicativo que você recuperou do Partner Center na seção anterior. Para o parâmetro resource, você deve especificar 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.
| Cenário | Descrição |
|---|---|
| Motoristas | 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: |
Exemplo de código
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:
Mais ajuda
Se você tiver dúvidas sobre a API de envio da Microsoft Store ou precisar de ajuda para gerenciar seus envios com essa API, visite a página de suporte e solicite ajuda.