Gerencie pagamentos usando a API do Serviço de Pagamento

Este artigo explica como pode aceder aos dados de pagamento através das APIs do Serviço de Pagamento em vez da IU do Partner Center. Essas APIs fornecem uma maneira programática de fornecer o recurso Exportar dados no Partner Center.

Importante

O Azure Ative 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 Azure AD Graph não têm SLA ou compromisso de manutenção além das correções relacionadas à segurança. Os investimentos em 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, consulte Importante: Aposentadoria do Azure AD Graph e Descontinuação do módulo 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.

Registar uma aplicação na plataforma de identidade da Microsoft

A plataforma de identidade da Microsoft ajuda você a criar aplicativos nos quais seus usuários e clientes podem entrar usando suas identidades da Microsoft ou contas sociais e fornecer acesso autorizado às suas próprias APIs ou APIs da Microsoft, como o Microsoft Graph.

1. Inicie sessão no portal do Azure com uma conta profissional ou escolar ou uma conta pessoal da Microsoft.

   Se a sua conta lhe der acesso a mais do que um inquilino, selecione a sua conta no canto superior direito e defina a sessão do portal para o inquilino correto do Microsoft Entra.

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

3. Introduza as informações de registo da sua candidatura:

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

   Tipos de conta suportados	Descrição
   Somente contas neste diretório organizacional	Selecione esta opção se estiver a criar uma aplicação de linha de negócio (LOB). Essa opção não estará disponível se você não estiver registrando o aplicativo em um diretório. Esta opção é mapeada para um único inquilino apenas do Microsoft Entra. Essa opção é o padrão, a menos que você esteja registrando o aplicativo fora de um diretório. Nos casos em que o aplicativo está registrado fora de um diretório, o padrão é contas multilocatárias e pessoais da Microsoft do Microsoft Entra.
   Contas em qualquer diretório organizacional	Selecione esta opção se quiser visar todos os clientes comerciais ou pedagógicos. Esta opção é mapeada para um multilocatário somente 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 um único locatário por meio da folha Autenticação.
   Contas em qualquer diretório organizacional e contas Microsoft pessoais	Selecione esta opção para visar o maior conjunto de clientes. Esta opção é mapeada para contas multilocatárias e pessoais da Microsoft Entra. Se você registrou o aplicativo como multilocatário do Microsoft Entra e contas pessoais da Microsoft, não poderá alterar essa seleção na interface do usuário. Em vez disso, tem de utilizar o editor de manifesto de aplicação para alterar os tipos de conta suportados.

   • (facultativo) URI de redirecionamento: selecione o tipo de aplicativo que você está criando, cliente Web ou público (móvel ou 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 depois que o usuário se autenticar.)

     Para aplicações Web, indique o URL base da sua aplicação. Por exemplo, http://localhost:31544 pode ser o URL de uma aplicação Web em execução no seu computador local. Os utilizadores utilizariam este URL para iniciar sessão numa aplicação de cliente Web. Para aplicativos cliente públicos, forneça o URI usado pelo ID do Microsoft Entra para retornar respostas de token. Introduza um valor específico para a aplicação, por exemplo myapp://auth.

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

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

Criar um principal de serviço

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

Nota

Você pode definir o escopo no nível da assinatura, grupo de recursos ou recurso. As permissões são herdadas para níveis mais baixos de escopo. Por exemplo, adicionar um aplicativo à função Leitor para um grupo de recursos significa que ele pode ler o grupo de recursos e quaisquer recursos que ele contém.

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 página inicial.

   

2. Selecione a assinatura à qual atribuir o aplicativo.

   

   Nota

   Se não vir a subscrição que procura, selecione o filtro de subscrições globais e certifique-se de que a subscrição pretendida 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 parar instâncias, selecione a função de Colaborador. Leia mais sobre as funções disponíveis.

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

5. Selecione Guardar. 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 gerir as permissões da entidade de serviço, consulte o estado de consentimento do utilizador, rever permissões, ver informações de início de sessão e muito mais), exiba as suas aplicações 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 de API de parceiro.

Conceder permissão à Graph API

1. Abra os registros do 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 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, em seguida, na tela Solicitar permissões de API, selecione Adicionar uma permissão e, em seguida , APIs que minha organização usa.

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

   

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

   

9. Conceda consentimento de administrador para as APIs.

   

   Verifique se o consentimento do administrador está ativado na tela Status do consentimento do administrador.

   

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

Execute 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 do Partner-Center-Payout-APIs .

Notas de código de exemplo

• A configuração de segredos de 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.
• Contas com autenticação multifator (MFA) não são suportadas no momento e causarão um erro.
• A API de pagamento suporta apenas credenciais baseadas em utilizador/palavra-passe.

Conteúdos relacionados

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