Quick-start: Iniciação de Transações de Pagamento (ITP)
Inscreva-se no Portal Open Keys®
O cadastro na plataforma Open Keys é composto por apenas três etapas super simplificadas. A primeira delas é o preenchimento das informações sobre a empresa.
Abaixo, as etapas para o cadastro
CNPJ da sua empresa
Razão social
Nome fantasia
O preenchimento da tela seguinte segue simples e rápido. É necessário informar:
A última etapa é composta pelo cadastro da sua senha de acesso à área privada do portal.
Crie sua aplicação
Você vai receber um link no e-mail para ativar sua conta. Clique e faça o login na plataforma para acessar a área privada do portal.
Primeiro contato
O botão “Quero ser open” dá acesso ao ambiente de gestão de aplicações. O Open Keys permite organizar o trabalho utilizando uma ou mais APIs juntas, monitorando o uso e gerenciando credenciais de autenticação.
Crie uma aplicação
Clique em Nova Aplicação e preencha os dados. Você vai precisar:
Certificação mTLS: um requisito do ecossistema Open Finance
Após a criação da aplicação, o Open Keys, realiza uma certificação obrigatória no ecossistema Open Finance: mTLS ou Client Certificate. Você poderá realizar o download deste certificado no Painel da Aplicação, na opção Configurações.
Depois de criada, sua aplicação estará listada no ambiente de Gestão de Aplicações. É possível criar quantas aplicações quiser, principalmente em cenários nos quais há mais de uma marca vinculada ao grupo.
Como pode perceber, a sua aplicação possui um botão de nome Painel, que, ao ser acionado, abre um completo painel de configurações da sua aplicação.
Configure sua aplicação
No painel da aplicação será possível configurar, testar e monitorar as APIs e jornadas white label contratados pelo Open Keys, tanto para o produto de Pagamentos como para o Compartilhamento de Dados.
O primeiro passo para o produto white label é você acessar o menu Configurar Jornadas, no seu painel da aplicação.
Neste primeiro cenário acima, você visualizar uma tela de seleção da Finalidade do compartilhamento de Dados. Este item é obrigatório para que o seu cliente tenha a informação de qual será a finalidade para o uso dos dados que serão consentidos para a sua empresa. Ao clicar em Salvar edições, esta informação estará visível na jornada e o seu menu Demo das jornadas estará com os fluxos de Compartilhamento de Dados disponíveis.
Já no cenário abaixo, que representa a configuração da sua jornada white label para Iniciação de Pagamentos, você deve informar os dados da sua empresa e cadastrar a conta bancária que receberá o pagamento realizado por seu cliente. No campo Dados de Recebimento, é possível otimizar o preenchimento informando apenas a Chave Pix e o sistema realiza uma consulta via DICT para completar o restante das informações.
Configure o seu usuário de teste
Agora que você já configurou e liberou o acesso ao menu Demo das jornadas, é preciso cadastrar o seu usuário de testes para aproveitar os fluxos, de ponta a ponta, em ambiente Sandbox. Primeiro, acesse o menu Configurações e na primeira tela já identificará as credenciais do seu produto e também o campo Gestão de usuários de teste. Nele, será necessário informar um nome, CPF (o CNPJ é opcional) e cadastrar uma senha. Ao clicar em Salvar, o sistema irá gerar o nome de usuário que você poderá utilizar na etapa de mock, junto com a senha que escolheu.
Agora que você já cadastrou o seu usuário, que tal cadastrar o endpoint no qual receberá os retornos de webhook sobre o ciclo de vida o Pagamento ou Compartilhamento de Dados dos seus clientes!?
Configure o seu Webhook
Para configurar o endpoint através do qual receberá as informações de webhook, ainda no menu Configurações, basta mudar a visualização de página para os escopos de Pagamento e Dados, para que consiga acessar o campo Gestão de endpoint. Neste campo, você ainda conta com um botão de teste para avaliar se a vinculação ocorreu com sucesso.
Nesta mesma tela, você poderá configurar o prazo de expiração do consentimento. Esta opção diz respeito ao tempo que o status do consentimento mudará de “pendente de aprovação” para “Cancelado”, no que tange o momento em que é gerado e a efetivação da jornada. É o tempo que o usuário possui para confirmar a operação e esta opção de personalização deste tempo é específica para o cenário de testes, dado que os prazos em ambiente produtivo são definidos pelo ecossistema Open Fianance, sendo 5 minutos para Pagamentos e até 60 minutos para compartilhamento de dados.
Painel do produto
Um dos grandes diferenciais do Open Keys é já permitir que você tenha acesso a informações detalhadas sobre os produtos contratados, com análise de requests, monitoramento de logs, configuração das jornadas e muito mais.
Configure e monitore os seus resultados
O painel da aplicação é o grande cenário no qual será possível configurar, testar e monitorar as APIs e jornadas white label contratados pelo Open Keys, para os escopos de Pagamento ou Consumo de Dados.
O primeiro menu do seu painel corresponde a uma visão de dashboard, na qual é possível ter acesso a informações como:
A aba seguinte, na ordem do menu lateral, corresponde a opção Monitoramento, que lhe permite uma visão detalhada de todos os logs de chamadas às APIs contratadas. Aqui também é possível fazer uma análise profunda sobre as transações realizadas, tanto no cenário de dado como no de pagamentos, através dos filtros disponíveis.
O menu Webhook é o seu raio-x das Jornadas. Com ele, você receberá atualizações sobre qualquer evento no ciclo de vida do consentimento. Neste ambiente será possível receber informações sobre abertura de um consentimento, status e consultar registros anteriores para realizar análise.
A opção Consentimentos é outra ferramenta disponível no painel e traz o cenário em que é possível obter uma visão detalhada de todos os consentimentos vinculados à sua empresa. No contexto de Dados, é possível identificar quais as permissions concedidas e no contexto de pagamentos, você confere informações precisas sobre a transação.
A opção Editar Aplicação lhe permite revisar e editar as informações que foram definidas na criação da sua aplicação, em um acesso facilitado, sem a necessidade de sair do seu painel para qualquer ajuste. Como se trata de um ambiente Sandbox, você pode realizar todos os ajustes que desejar e testar o quanto quiser.
Etapas de configuração da aplicação e jornadas
No cenário em que a contratação seja exclusivamente da infraestrutura do Open Keys, com acesso as APIs para que o seu time técnico elabore as jornadas de experiência dos usuários, a sua aplicação estará configurada desta forma, logo, as opções Configurar Jornadas e Demo das Jornadas não estarão habilitadas, conforme imagem abaixo.
Caso você tenha habilitado em sua aplicação a contratação da Jornada White Label para Consumo de Dados, a sua visualização da opção Configurar Jornadas será apresentada com a obrigatoriedade de você indicar, inicialmente, qual a Finalidade do seu consumo de dados, entre as alternativas disponíveis de Abertura de Conta ou Análise de Perfil.
Ainda nesta tela é possível visualizar quais os escopos de dados que os seus clientes poderão compartilhar com a sua empresa e qual a composição de cada grupamento, em uma versão resumida.
Caso você tenha habilitado em sua aplicação a contratação da Jornada White Label para Iniciação de Pagamentos, a sua visualização da opção Configurar Jornadas será apresentada com a obrigatoriedade de configuração dos campos empresariais correspondentes ao PIX, como dados da empresa e os dados para recebimento dos pagamentos.
Uma vez que você configurou corretamente a(s) jornada(s) contratada(s), conseguirá habilitar o acesso às demos de cada escopo, como forma de testar os fluxos e vivenciar a experiência de navegar pela versão disponível das jornadas white label do Open Keys.
As jornadas são abertas em aba secundária, para facilitar a sua identificação, monitoramento e configuração.
Como forma de garantir que toda a sua experiência seja pautada a ter as ferramentas que necessita, de forma acessível, trouxemos para o painel da aplicação também a opção Documentação do Produto. Ao ser acionada, a documentação será aberta em segunda aba, com informações detalhadas sobre como configurar, navegar e monitorar a sua versão Open Keys.
Por fim, o painel do produto disponibiliza para você uma opção de Configurações, onde será possível: