Para que o PlusCom possa se comunicar com a API bancária, o banco poderá fornecer credenciais de acesso vinculadas à conta, ao convênio ou à aplicação autorizada.
O PlusCom possui três campos para armazenar essas informações:
ID do cliente
Chave secreta do cliente
Chave de aplicativo
O nome e a finalidade de cada credencial podem variar entre os bancos.
Uma mesma informação pode ser chamada, por exemplo, de usuário, login, código de acesso, Client ID, Client Secret, chave da aplicação ou x-api-key.
Nem todos os bancos utilizam os três campos.
Preencha somente as credenciais exigidas nas instruções da integração homologada para o seu banco.
Não repita uma credencial em outro campo e não preencha campos por tentativa.
É a identificação principal fornecida pelo banco para reconhecer o cliente, a conta, o convênio ou o usuário autorizado a acessar a API.
Dependendo do banco, esse campo poderá corresponder a um usuário, login, Client ID ou outra identificação equivalente.
Mesmo quando o banco não classificar essa informação como uma senha, ela deve ser tratada como dado de acesso reservado.
É a credencial utilizada para comprovar a autorização do cliente identificado no campo anterior.
Dependendo do banco, poderá ser chamada de senha, código de acesso, Client Secret ou nome equivalente.
Essa informação é confidencial e não deve ser compartilhada, enviada em mensagens desprotegidas ou incluída em documentos e capturas de tela.
É uma credencial adicional que alguns bancos utilizam para identificar ou autorizar a aplicação que está realizando a comunicação.
Ela poderá aparecer na documentação do banco com nomes como chave da aplicação, chave de aplicativo, application key ou x-api-key.
A chave de aplicativo é diferente da chave secreta do cliente e não deve ser usada como substituta dela.
Quando o banco não exigir essa credencial, o campo deverá permanecer sem preenchimento.
No módulo Conta Corrente, abra o cadastro da conta que será utilizada pela integração bancária.
A conta deve estar salva antes da configuração das credenciais.
Em seguida:
1. Acesse a aba Configuração de API.
2. Selecione o ambiente correto: homologação ou produção.
3. Clique em Editar ID do Cliente e informe a credencial correspondente.
4. Clique em Editar Chave Secreta do Cliente e informe a credencial correspondente.
5. Se exigido pelo banco, clique em Editar Chave de Aplicativo e informe a credencial correspondente.
6. Quando o recurso estiver disponível para o banco configurado, utilize Testar conexão com a API para validar a autenticação.
Digite ou cole cada valor exatamente como foi fornecido pelo banco, respeitando letras maiúsculas, minúsculas, números e caracteres especiais.
O PlusCom armazena essas informações de forma protegida, e o acesso à configuração depende das permissões do usuário.
Para preservar a segurança:
não compartilhe credenciais com pessoas não autorizadas
não envie credenciais por e-mail ou aplicativos de mensagens sem proteção adequada
não publique capturas de tela contendo esses dados
não utilize credenciais de outra conta, empresa, banco ou ambiente
se houver suspeita de exposição, solicite ao banco a substituição da credencial e atualize o cadastro no PlusCom.
Para saber exatamente quais campos preencher, consulte as instruções específicas da integração homologada para o seu banco.
Clique aqui para ver quais APIs estão homologadas no PlusCom