API de hardware dashboard

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 se sua conta gerencia muitos produtos e você deseja automatizar e otimizar o processo de envio desses ativos. Essas APIs usam Microsoft Entra ID (Microsoft Entra ID) para autenticar as chamadas do seu aplicativo ou serviço. As etapas a seguir descrevem o processo de ponta a ponta do uso da API de Hardware da Microsoft:

1. Essas APIs só podem ser usadas por contas que pertencem ao programa do Hardware Partner Center.

2. Verifique se você concluiu os pré-requisitos abaixo.

3. Antes de chamar um método na API de Hardware da Microsoft, obtenha um token de acesso Microsoft Entra ID, conforme ilustrado abaixo. Depois de obter um token, você tem 60 minutos para usá-lo em chamadas para a API de envio da Microsoft Store antes que ele expire. Depois que o token expirar, será possível gerar um novo.

4. 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, verifique se você concluiu os pré-requisitos necessários a seguir.

• Você (ou sua organização) deve ter um diretório de ID de Microsoft Entra e deve ter Administrador global permissão para o diretório. Se você já usa o Microsoft 365 ou outros serviços de negócios da Microsoft, já tem Microsoft Entra diretório de ID. Caso contrário, você poderá criar uma nova ID de Microsoft Entra no Partner Center sem custo adicional.

• Se um aplicativo de ID de Microsoft Entra ainda não existir, você deverá criar um.

• Você deve associar um aplicativo de ID de Microsoft Entra à sua conta do Partner Center e atribuir a ele a função Gerente.

• Reúna a ID do locatário do aplicativo de ID Microsoft Entra, a ID do cliente e a chave. Certifique-se de imprimir ou copiar essas informações de chave, pois você não poderá acessá-la novamente depois de sair da página de criação da chave.

Atribuir as funções de hardware apropriadas ao aplicativo de ID de Microsoft Entra

Depois de concluir os pré-requisitos acima, agora devemos atribuir as funções apropriadas para que o aplicativo de ID de Microsoft Entra possa criar e gerenciar envios e etiquetas de envio.

1. No Partner Center, selecione o ícone de engrenagem (próximo ao canto superior direito do dashboard) e selecione Configurações do desenvolvedor. No menu Configurações , selecione Usuários.

2. Na página Usuários, selecione Microsoft Entra aplicativos de ID e o aplicativo de ID de Microsoft Entra que representa o aplicativo ou serviço que você usará para acessar envios para sua conta do Partner Center.

3. Nesta página, em Funções, selecione Hardware.

   

   Selecione Encaminhador de Driver, Proprietário da Etiqueta de Remessa e, se disponível, Promotor de Etiqueta de Remessa. Saiba mais sobre essas funções

Obter um token de acesso de ID de Microsoft Entra

Antes de chamar qualquer um dos métodos na API de Hardware da Microsoft, primeiro você deve obter um token de acesso Microsoft Entra ID que você passa para o cabeçalho 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 que o token expirar, você poderá atualizar o token, para que possa continuar a usá-lo em outras chamadas para a API. Para obter o token de acesso, siga as instruções em Chamadas de serviço a 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á um exemplo de solicitação.

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

Depois de ter um token de acesso 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, você normalmente 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
Drivers	Obtenha, crie e atualize os drivers registrados em sua conta do Partner Center. Para obter mais informações sobre esses métodos, consulte os seguintes artigos: Obter dados do produto Gerenciar envios de produtos Obter dados de etiqueta de remessa Gerenciar etiquetas de envio

Exemplos de código

O exemplo a seguir fornece um código detalhado que demonstra como usar a API de Hardware da Microsoft juntamente com uma solução predefinida completa de ponta a ponta criada pela equipe do Microsoft Surface and Devices:

• Exemplo de C#

exemplos de API de hardware dashboard (GitHub)

Ferramenta Do Gerenciador do Centro de Desenvolvimento do Surface (GitHub)

Ajuda adicional

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, visite a página de suporte e solicite ajuda.

Tópicos relacionados

O que é o Microsoft Entra ID?