Skip to main content
Esta funcionalidade está disponível apenas em Staging para testes e ainda não está disponível em Produção.
Este guia mostra como gerenciar parceiros pelo Console. Você cria o parceiro, emite as credenciais dele e depois altera ou encerra o acesso dele.

​
Antes de começar

Você precisa da permissão partners com a ação get para abrir a página. Para criar as credenciais de um parceiro, você também precisa da permissão applications com a ação post. Reúna estas informações antes de começar:
  • Os produtos de que o parceiro precisa e o que ele pode fazer em cada um.
  • Os IDs dos itens que o parceiro pode alcançar: no Midaz, pelo menos o ID da organização. Copie os IDs da própria API ou do Console do produto. O Console não confere se eles existem.
  • Os endereços de rede de onde o parceiro chama, se você quiser restringi-los.
  • As datas de início e de fim do acesso dele, se ele tiver limite de tempo.

​
Abrir a página Parceiros

1

Abra Configurações

Clique no ícone de engrenagem () na barra de navegação superior.
2

Selecione Parceiros

Selecione Parceiros na barra lateral de Configurações. O subtítulo diz “Dê a cada cliente credenciais próprias e limite o que ele pode acessar.”
A página lista os seus parceiros. Um parceiro que não está funcionando mostra um selo de status: Suspenso, Expirado ou Ainda não vigente. Sem parceiros, a página diz “Você ainda não cadastrou nenhum parceiro”.

​
Criar um parceiro

Clique em Novo parceiro. Um assistente abre com cinco etapas: Detalhes, Produtos, Escopo, Permissões e Revisão. Próximo só abre quando a etapa atual está completa. Voltar mantém o que você informou.
1

Detalhes

Digite o Nome do parceiro. Só a sua equipe vê este nome, e ele precisa ser único no seu tenant.Em Janela de validade, preencha Válido a partir de e Válido até se o acesso tiver limite de tempo. Deixe Válido a partir de vazio para valer desde já. Deixe Válido até vazio para nunca expirar.Em De onde ele chama, escolha uma opção:
  • Usar a lista de IPs da sua organização: o parceiro usa a lista de IPs permitidos do seu tenant.
  • Dar a ele uma lista própria: digite os endereços ou as faixas CIDR do parceiro. A lista própria substitui a lista do seu tenant. Um endereço que está só na lista do seu tenant não serve para este parceiro.
2

Produtos

Escolha os produtos que o parceiro pode usar. A lista mostra só o que o seu tenant tem.Um produto que ainda não aceita parceiros aparece em cinza com a mensagem “Este produto ainda não está preparado para parceiros.” Você não pode selecioná-lo.
3

Escopo

Diga onde o parceiro pode atuar em cada produto. Uma restrição que o produto exige já aparece aberta. No Midaz, é a organização.Para restringir o acesso, clique em Adicionar restrição e escolha o item em Restringir por, por exemplo um ledger ou uma conta. Digite um ID, ou vários IDs separados por vírgula.Depois de restringir um tipo por ID, o parceiro não consegue listar nem criar itens desse tipo.
4

Permissões

Marque os recursos e as ações que o parceiro pode chamar em cada produto. Para dar outro conjunto de ações em outros recursos, adicione uma linha com o botão do produto, por exemplo Adicionar outra linha em Midaz.O Console oferece só o que o seu tenant pode conceder. Uma linha que não pode ser salva mostra o motivo:
  • Não permitido: o seu tenant não tem esta permissão.
  • Fora do escopo: a escrita atua acima do escopo do parceiro. Por exemplo, criar ledgers atua sobre a organização inteira, então um parceiro restrito a um ledger não pode recebê-la.
  • Concedido duas vezes: outra linha já concede a mesma ação no mesmo recurso.
5

Revisão

Em “Confira o que este parceiro pode e não pode fazer”, leia o resumo. Ele pode lista as ações, os itens e a lista de IPs. Ele não pode lista o que fica de fora.Clique em Salvar. O Console cria o parceiro sem credenciais. Você as emite na aba Aplicações dele.
Se o Access Manager recusar o parceiro, o Console mostra “O Access Manager recusou esta alteração” e abre a etapa que tem o campo a corrigir.

​
Emitir as credenciais do parceiro

Um parceiro sem aplicação não consegue chamar nada. Crie uma aplicação por produto.
1

Abra a aba Aplicações

Na lista de parceiros, clique no parceiro. Selecione a aba Aplicações.
2

Crie a aplicação

Clique em Nova Application. No painel lateral Nova aplicação, escolha o Produto. Só aparecem os produtos em que o parceiro tem permissões. Preencha Descrição e clique em Criar aplicação.
3

Copie as credenciais

A caixa de diálogo “Guarde as credenciais” mostra o client ID e o client secret. Copie os dois agora. O client secret aparece uma única vez. Clique em Já guardei para fechar a caixa de diálogo.
4

Envie as credenciais ao parceiro

Envie o client ID e o client secret ao parceiro por um canal seguro. O sistema do parceiro usa os dois para pedir tokens de acesso.
As aplicações de parceiro não aparecem em Configurações → Aplicações. Elas seguem as permissões, o escopo, a janela de validade e a lista de IPs do parceiro. Se um client secret se perder, exclua essa aplicação e crie outra. Uma nova aplicação vem com um novo segredo. Quando você exclui uma aplicação, o programa do parceiro que a usa para de funcionar na hora.

​
Alterar um parceiro

Abra o parceiro na lista. A página de detalhes tem cinco abas: Salvar em Permissões ou em Escopo substitui as permissões e o escopo juntos. Uma alteração vale a partir da próxima requisição do parceiro.

​
Suspender ou reativar um parceiro

Na aba Visão Geral, clique em Suspender e confirme. Todas as credenciais do parceiro são recusadas a partir da próxima requisição dele, inclusive os tokens que ele já tem. Nada é excluído. Para devolver o acesso, clique em Reativar e confirme. As credenciais do parceiro voltam a funcionar a partir da próxima requisição dele. São as mesmas credenciais de antes.

​
Excluir um parceiro

Você só pode excluir um parceiro sem aplicações.
1

Exclua as aplicações dele

Na aba Aplicações, exclua cada aplicação do parceiro.
2

Exclua o parceiro

Na aba Visão Geral, clique em Excluir parceiro e confirme. O parceiro perde o acesso na hora. As permissões, o escopo e a lista de IPs dele também são excluídos. Isso não pode ser desfeito.
Se o parceiro ainda tiver aplicações, o Console as lista e oferece Ir para Aplicações.

​
Parceiros que usam a lista de IPs do seu tenant

Em Configurações → Segurança, a aba Lista de IPs permitidos mostra quantos parceiros usam a lista do seu tenant. Uma mudança nessa lista também vale para esses parceiros, a partir da próxima requisição deles. Para tornar um parceiro independente dessa lista, dê a ele uma lista própria na aba IPs dele.