Gerenciar pagamentos usando a API do Serviço de Pagamento

Este artigo explica como você pode acessar dados de pagamento por meio das APIs do Serviço de Pagamento em vez da interface do usuário do Partner Center. Essas APIs fornecem uma maneira programática de fornecer a funcionalidade do recurso Exportar dados no Partner Center.

Importante

O Azure Active Directory (Azure AD) Graph foi preterido a partir de 30 de junho de 2023. No futuro, não faremos mais investimentos no Azure AD Graph. As APIs do Graph do Azure AD não têm SLA ou compromisso de manutenção além de correções relacionadas à segurança. Os investimentos nos novos recursos e funcionalidades só serão feitos no Microsoft Graph.

Desativaremos o Azure AD Graph em etapas incrementais para que você tenha tempo suficiente para migrar seus aplicativos para APIs do Microsoft Graph. Em uma data posterior que anunciaremos, bloquearemos a criação de novos aplicativos usando o Azure AD Graph.

Para saber mais, confira Importante: desativação do Azure AD Graph e substituição do módulo do Powershell.

APIs Disponíveis

Veja todas as APIs disponíveis em Pagamentos de parceiros.

Pré-requisitos

• Registre um aplicativo com o Microsoft Identity no portal do Azure e adicione proprietários e funções apropriados ao aplicativo.
• Instalar o Visual Studio.

Registrar um aplicativo na plataforma de identidade da Microsoft

A plataforma de identidade da Microsoft ajuda você a criar aplicativos em que os usuários e os clientes podem entrar usando as respectivas identidades da Microsoft ou contas de redes sociais, além de fornecer acesso autorizado às suas APIs ou às APIs da Microsoft, como o Microsoft Graph.

1. Entre no portal do Azure usando uma conta corporativa ou de estudante ou uma conta Microsoft pessoal.

   Se sua conta fornecer acesso a mais de um locatário, selecione sua conta no canto superior direito e defina sua sessão do portal como o locatário correto do Microsoft Entra.

2. No painel de navegação esquerdo, selecione o serviço Microsoft Entra, Registros de aplicativo e, em seguida , Novo registro. A página Registrar um aplicativo é exibida.

3. Insira as informações de registro do seu aplicativo:

   • Nome: insira um nome de aplicativo significativo que será exibido para os usuários do aplicativo.
   • Tipos de conta compatíveis: selecione quais contas seu aplicativo suportará.

   Tipos de conta compatíveis	Descrição
   Somente contas neste diretório organizacional	Selecione esta opção se você está criando um aplicativo de linha de negócios (LOB). Essa opção não estará disponível se você não estiver registrando o aplicativo em um diretório. Essa opção é mapeada para o locatário único somente do Microsoft Entra. Essa é a opção padrão, a menos que você esteja registrando o aplicativo fora de um diretório. Nos casos em que o aplicativo é registrado fora de um diretório, o padrão é o Microsoft Entra multilocatário e as contas pessoais da Microsoft.
   Contas em qualquer diretório organizacional	Selecione essa opção se você deseja direcionar para todos os clientes comerciais e educacionais. Essa opção é mapeada para somente um multilocatário do Microsoft Entra. Se você registrou o aplicativo como locatário único somente do Microsoft Entra, poderá atualizá-lo para ser multilocatário do Microsoft Entra e voltar para locatário único por meio da folha Autenticação.
   Contas em qualquer diretório organizacional e contas pessoais da Microsoft	Selecione esta opção para direcionar o conjunto mais amplo de clientes. Essa opção é mapeada para contas Microsoft Entra multilocatário e contas Microsoft pessoais. Se você registrou o aplicativo como contas multilocatários e pessoais da Microsoft do Microsoft Entra, não poderá alterar essa seleção na interface do usuário. Em vez disso, você deve usar o editor de manifesto de aplicativo para alterar os tipos de conta com suporte.

   • (opcional) URI de redirecionamento: selecione o tipo de aplicativo que você está criando, cliente Web ou público (dispositivos móveis e desktop) e insira o URI de redirecionamento (ou URL de resposta) para seu aplicativo. (A URL de redirecionamento é para onde a resposta de autenticação será enviada após a autenticação do usuário.)

     Para aplicativos Web, informe a URL base do aplicativo. Por exemplo, http://localhost:31544 pode ser uma URL para um aplicativo Web em execução no seu computador local. Os usuários usariam essa URL para entrar em um aplicativo cliente Web. Para aplicativos cliente públicos, informe o URI usado pelo Microsoft Entra ID para retornar respostas de token. Insira um valor específico para o aplicativo, por exemplo, myapp://auth.

4. Selecione Registrar. A ID do Microsoft Entra atribui uma ID de aplicativo (cliente) exclusiva ao seu aplicativo e a página de visão geral do aplicativo é carregada.

5. Se você quiser adicionar recursos ao seu aplicativo, poderá selecionar outras opções de configuração, incluindo marca, certificados e segredos, permissões de API e muito mais.

Criar uma entidade de serviço

Para acessar recursos em sua assinatura, deverá atribuir uma função ao aplicativo. Para obter ajuda para decidir qual função oferece as permissões corretas para o aplicativo, consulte Funções internas do Azure.

Observação

Você pode definir o escopo no nível da assinatura, do grupo de recursos ou do recurso. As permissão são herdadas para níveis inferiores do escopo. Por exemplo, adicionar um aplicativo à função Leitor de um grupo de recursos significa que ele pode ler o grupo de recursos e todos os recursos nele contidos.

1. No portal do Azure, selecione o nível de escopo ao qual atribuir o aplicativo. Por exemplo, para atribuir uma função no escopo da assinatura, pesquise e selecione Assinaturas ou selecione Assinaturas na home page.

   

2. Selecione a assinatura à qual atribuir o aplicativo.

   

   Observação

   Se você não vir a assinatura que está procurando, selecione o filtro de assinaturas globais e verifique se a assinatura desejada está selecionada para o portal.

3. Selecione Controle de Acesso (IAM) e, em seguida, selecione Adicionar atribuição de função.

4. Selecione a função que deseja atribuir ao aplicativo. Por exemplo, para permitir que o aplicativo execute ações como reinicializar, iniciar e interromper instâncias, selecione a função Colaborador. Leia mais sobre as funções disponíveis.

   Por padrão, os aplicativos do Microsoft Entra não são exibidos nas opções disponíveis. Para encontrar seu aplicativo, pesquise o nome e selecione-o nos resultados. Na captura de tela abaixo, example-app está o aplicativo Microsoft Entra que você registrou.

5. Selecione Salvar. Em seguida, você pode ver seu aplicativo na lista de usuários com uma função para esse escopo.

   Você pode começar a usar sua entidade de serviço para executar seus scripts ou aplicativos. Para gerenciar as permissões da entidade de serviço, consulte o status de consentimento do usuário, examine as permissões, consulte as informações de entrada e muito mais), exiba seus aplicativos empresariais no portal do Azure.

Configurar permissões de API

Esta seção fornece instruções sobre como configurar as permissões de API necessárias. Para obter mais informações sobre como configurar permissões de API do Partner Center, consulte Autenticação da API do parceiro.

Conceder permissão à API do Graph

1. Abra Registros de aplicativo no portal do Azure.

2. Selecione um aplicativo ou crie um aplicativo se ainda não tiver um.

3. Na página Visão geral do aplicativo, em Gerenciar, selecione Permissões de API e, em seguida, Adicionar uma permissão.

4. Selecione Microsoft Graph na lista de APIs disponíveis.

5. Selecione Permissões delegadas e adicione as permissões necessárias. Para obter mais informações, consulte Configurar o acesso ao aplicativo.

   

   Consentimento para acesso à API do Partner Center por meio do aplicativo Microsoft Entra

6. Para seu aplicativo, selecione Permissões de API e, na tela Solicitar permissões de API, selecione Adicionar uma permissão e, em seguida , APIs que minha organização usa.

7. Pesquise a API do Microsoft Partner (Centro de Desenvolvimento da Microsoft) (4990cffe-04e8-4e8b-808a-1175604b879f).

   

8. Defina as permissões delegadas para o Partner Center.

   

9. Conceda consentimento do administrador para as APIs.

   

   Verifique se o consentimento do administrador está habilitado na tela de status do consentimento do administrador.

   

10. Na seção Autenticação, verifique se a opção Permitir fluxos de cliente público está definida como Sim.

Executar o código de exemplo no Visual Studio

O código de exemplo que mostra como a API pode ser usada para o histórico de pagamentos e transações pode ser encontrado no repositório GitHub Partner-Center-Payout-APIs.

Notas de código de exemplo

• A configuração de segredos do cliente e certificados, conforme discutido na seção Autenticação: duas opções de Como criar uma entidade de serviço no portal do Azure não é necessária.
• No momento, não há suporte para contas com autenticação multifator (MFA) e causarão um erro.
• A API de pagamento oferece suporte apenas a credenciais baseadas em usuário/senha.

Conteúdo relacionado

• Use o portal para criar um aplicativo do Microsoft Entra e uma entidade de serviço que possa acessar recursos
• Registrar um aplicativo na plataforma de identidade da Microsoft
• Configurar um aplicativo cliente para acessar uma API Web