API de painel de hardware
Use as APIs de Hardware da Microsoft para consultar e criar envios programaticamente para produtos de hardware na conta do Partner Center da sua organização. Essas APIs são úteis caso sua conta gerencie muitos produtos e você queira 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 as 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:
Conclua os pré-requisitos na próxima seção.
Obtenha um token de acesso da ID do Microsoft Entra antes de chamar um método na API de Hardware da Microsoft. Depois de ter um token, você terá 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.
Conclua 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 do Microsoft Entra ID e você deve ter permissão de administrador global para o diretório. Se já usa o Microsoft 365 ou outros serviços empresariais da Microsoft, você já tem o diretório do Microsoft Entra ID. Caso contrário, você pode criar uma nova ID do Microsoft Entra no Partner Center sem custo adicional.
Se um aplicativo do Microsoft Entra ID ainda não existir, você deverá criar um.
Você deve associar um aplicativo do Microsoft Entra ID à sua conta do Partner Center e atribuir a ele a função de gerente.
Colete a ID do locatário do aplicativo, a ID do cliente e a chave do Microsoft Entra ID. Imprima ou copie essas informações da chave, pois você não poderá acessá-las novamente depois de sair da página de criação de chaves.
Atribuir as funções de hardware apropriadas ao seu aplicativo do Microsoft Entra ID
Depois de concluir os pré-requisitos, atribua as funções apropriadas para que o aplicativo Microsoft Entra ID possa criar e gerenciar envios 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 menú Configurações, selecione Usuários.
Na página Usuários, selecione os aplicativos do Microsoft Entra ID e o aplicativo do Microsoft Entra ID que representa o aplicativo ou o serviço que você utiliza para acessar envios para sua conta do Partner Center.
Nesta página, em Funções, selecione Hardware.
Selecione Remetente de driver, Proprietário de Rótulo de Remessa e, se disponível, Promotor de Rótulo de Remessa. 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, primeiro obtenha um token de acesso do Microsoft Entra ID que é passado para o cabeçalho de Autorização de cada método na API. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar. Depois de expirar, é possível renovar o token para que você possa continuar a usá-lo em chamadas futuras para a API. Para obter o token de acesso, siga as instruções em Chamadas de Serviço para Serviço Usando Credenciais do Cliente para enviar um HTTP POST para o ponto de extremidade 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 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, especifique https://manage.devcenter.microsoft.com.
Depois que o token de acesso expirar, você poderá atualizá-lo seguindo as instruções em Atualizar os tokens de acesso.
Usar a API de Hardware da Microsoft
Quando você tiver um token de acesso do Microsoft Entra ID, poderá 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 chamam-se 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, confira os artigos na tabela a seguir.
| Cenário | Descrição |
|---|---|
| Drivers | Obtenha, crie e atualize os drivers registrados em sua Conta do Partner Center. Para obter mais informações sobre esses métodos, confira os seguintes artigos: |
Exemplo de código
O exemplo de código a seguir fornece uma solução predefinida de ponta a ponta completa criada pela equipe do Microsoft Surface and Devices:
Mais ajuda
Se você tiver dúvidas sobre a API de envio da Microsoft Store ou precisar de assistência para gerenciar seus envios com essa API, acesse a página de suporte e solicite ajuda.