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.
| Note |
|---|
Muita atenção a este passo a passo, porque alguns cenários do painel possuem condicionantes e será necessário passar por uma etapa para liberar a funcionalidade seguinte. |
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 Consumo de Dados e/ou Iniciação de Pagamento via Open Finance.
Logo de cara, você se depara com uma visão de dashboard, no qual é possível ter acesso a quantidade total e estratificada de requestes realizadas. Em todo o Painel você consegue moldar a sua visualização, por escopo contratado, tempo de referência e outras variáveis, conforme a ferramenta selecionada.
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.
| Note |
|---|
É indispensável que você cadastre um endpoint para recebimento dos alertas. Para cadastrar, basta acessar o menu Configurações, no campo Gestão de endpoint. |
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.
| Note |
|---|
É indispensável que você indique, primeiramente, a finalidade da sua jornada para que consiga desbloquear a função Demo da Jornada. |
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.
| Note |
|---|
É indispensável que você configure as informações do PIX, primeiramente, para que consiga desbloquear a função Demo da Jornada de Iniciação de 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:
| Tip |
|---|
Consultar as chaves de geração de Token, no cenário em que estão habilitados de Client ID e Client Secret |
| Tip |
|---|
Realizar a criação de usuários de teste, como forma de você testar mais de um CPF/CNPJ nos fluxos contratados |
| Tip |
|---|
Cadastrar um endpoint para recebimento das respostas webhook sobre os consentimentos realizados para o escopo de Pagamentos e também para o escopo de Dados |
| Tip |
|---|
Realizar o Download do seu Client Secret (certificado mTLS) |
One of the great differences of Open Keys is that it allows you to have access to detailed information about the contracted products, with request analysis, log monitoring, journey configuration and much more.
| Note |
|---|
Pay close attention to this step by step, because some panel scenarios have conditions and it will be necessary to go through a step to release the next functionality. |
Configure and monitor your results
The application panel is the main scenario in which it will be possible to configure, test and monitor the APIs and white label journeys contracted by Open Keys, for the Payment or Data Consumption scopes.
The first menu on your panel corresponds to a dashboard view, in which you can access information such as:
| Tip |
|---|
Total number of operations performed (encompasses all existing statuses) |
| Tip |
|---|
Stratified view of operations, by product (encompasses all existing statuses) |
| Tip |
|---|
Total value with payment operations (includes all operation statuses) |
| Tip |
|---|
Total unique customers (CPF and CNPJ, encompassing all operational statuses) |
| Tip |
|---|
Ranking with institutions most used in their operations |
...
The next tab, in the order of the side menu, corresponds to the Monitoring option , which allows you a detailed view of all call logs to contracted APIs. Here it is also possible to carry out an in-depth analysis of the transactions carried out, both in the data and payments scenarios, through the available filters.
...
The Webhook menu is your x-ray of the Journeys. With it, you will receive updates on any event in the consent lifecycle. In this environment it will be possible to receive information about the opening of a consent, status and consult previous records to carry out analysis.
| Note |
|---|
It is essential that you register an endpoint to receive alerts. To register, simply access the Settings menu, in the Endpoint management field . |
...
The Consents option is another tool available on the panel and provides a scenario in which it is possible to obtain a detailed view of all consents linked to your company. In the Data context, it is possible to identify which permissions have been granted and in the payments context, you can provide accurate information about the transaction.
...
The Edit Application option allows you to review and edit the information that was defined when creating your application, in easy access, without the need to leave your panel for any adjustments. As it is a Sandbox environment, you can make all the adjustments you want and test as much as you want.
...
| Note |
|---|
If you have applications created before 10/19/2023, access them and, in the Edit applications menu , fill in your Redirect URL field and click save, so that your whitelabel journeys present the expected behavior in case of cancellation user or interruption of the flow. |
Application configuration steps and journeys
In the scenario where the contracting is exclusively for the Open Keys infrastructure, with access to APIs for your technical team to create user experience journeys, your application will be configured in this way, therefore, the options Configure Journeys and Journey Demo will not be enabled, as shown in the image below.
...
If you have enabled the contracting of the White Label Journey for Data Consumption in your application , your view of the Configure Journeys option will be presented with the obligation for you to initially indicate the Purpose of your data consumption, among the available alternatives of Account Opening or Profile Analysis .
Also on this screen, you can view the scope of data that your customers will be able to share with your company and the composition of each group, in a summarized version.
| Note |
|---|
It is essential that you first indicate the purpose of your journey so that you can unlock the Journey Demo function. |
...
If you have enabled contracting of the White Label Journey for Payment Initiation in your application , your view of the Configure Journeys option will be presented with the obligation to configure the business fields corresponding to the PIX, such as company data and data for receiving payments .
| Note |
|---|
It is essential that you configure your PIX information first so that you can unlock the Demo function of the Payment Initiation Journey. |
...
Once you have correctly configured the contracted journey(s), you will be able to enable access to the demos of each scope, as a way of testing the flows and experiencing the experience of browsing the available version of Open's white label journeys Keys.
The journeys are opened in a secondary tab, to facilitate their identification, monitoring and configuration.
...
As a way of ensuring that your entire experience is guided by having the tools you need, in an accessible way, we also brought the Product Documentation option to the application panel. When activated, the documentation will open in a second tab, with detailed information on how to configure, navigate and monitor your Open Keys version.
...
Finally, the product panel provides you with a Settings option, where you can:
| Tip |
|---|
Consult the Token generation keys, in the scenario where Client ID and Client Secret are enabled |
| Tip |
|---|
Create test users, as a way for you to test more than one CPF/CNPJ in the contracted flows |
| Tip |
|---|
Register an endpoint to receive webhook responses regarding consents made for the Payments scope and also for the Data scope |
...
...
...