Integração: Adyen

Tipo de usuário Usuário necessário para fazer esse tutorial:  Administrador

Tempo para realizar liberação: 5 minutos



Bem vindo!

Neste tutorial você aprenderá a conectar a sua conta do Adyen com a Niuco.


É bem simples, basta seguir atentamente os passos abaixo:



1) Obtendo os dados de acesso


Para conectar sua conta da Adyen à plataforma da Niuco, você precisará de três dados obrigatórios:

  • Company ID

  • API Key

  • Nome exclusivo para a conexão



1.1 ) Company ID


Acesse a Adyen a partir de uma conta de Administrador. Assim que estiver na página inicial, clique no canto superior direito e copie o Company ID. Salve o valor em um arquivo provisório, um .txt qualquer. 

Se houver mais de uma conta disponível, certifique-se de copiar o Company ID correto antes de continuar.

 




1.2 ) API Key


No menu lateral do painel da Adyen, clique em Developers e logo em seguida em API Credentials. 


Depois, no canto direito, clique no botão Create new credential e crie uma nova API Credential do tipo Web Service. Após isso, copie a API Key e clique em Save changes.
Lembre-se apenas de colar a API Key no arquivo provisório em que já salvou o Company ID anteriormente.


⚠️ Permissão obrigatória (muito importante)

Para que a integração funcione corretamente, a API Key precisa ter permissões específicas.

A Niuco utiliza a Management API da Adyen para consultar usuários da empresa.
Para isso, o API Credential precisa obrigatoriamente do papel:

  • Management API — Users read and write


Problema comum:

Esse papel ou permissão, não aparece para seleção no painel da Adyen em muitos casos. Isso é um comportamento normal da plataforma.


Solução:

É necessário abrir um ticket com o suporte da Adyen solicitando a ativação manual dessa permissão. Para isso, clique no ícone "?" para acessar as opções de suporte, presente no canto superior direito. Depois clique em Submit a ticket. 

Na sequência, selecione a opção Account and user management e prossiga com o preenchimento das informações.


Modelo de mensagem para o suporte da Adyen

Ao abrir o ticket, você pode usar um texto semelhante a este:

According to Adyen’s documentation, when a required role is not available in the UI, it must be enabled by Support.

We request the enablement of the role “Management API — Users read and write” for the API Credential:
ws_xxxxx@Company.SuaEmpresa

This permission is required to access the Management API endpoint that retrieves company users.


O suporte normalmente resolve isso rapidamente.




2) Inserindo os dados de conexão na Niuco


Na plataforma da Niuco, na tela das regras de conexão com o fornecedor Adyen, avance até o passo Escopo de acesso, ali selecione apenas Leitura ou Leitura/Escrita para garantir que terá acesso a recursos avançados como suspensão, criação e atualização de usuários. Depois, clique em Próximo para avançar à etapa final.


Por fim, insira o Company ID e a API Key nos respectivos campos, dê um nome simples e exclusivo para a conexão, que não contenha barra nem caracteres especiais, clique em Conectar e pronto! Sua conexão com o Adyen já será estabelecida em nossa plataforma.