Bem-vindo ao Portal do Desenvolvedor

Pronto para integrar em nosso ambiente Sandbox?

Agora que está registrado, você pode começar a testar sua solução!

In the sidebar under APIs, you can find all our APIs, browse our API Catalog, check the categories or even manage your APIs. To start using them, click on the card you want and select “Request Approval.” The Portal Administrator will get notified and will have to approve your request before using the API, but you can still check the API Documentation.

Para começar a usar qualquer API, você deve:

• Ir para a seção de APIs no menu principal.
• Selecione o cartão da API e vire-o com um clique
  • Nas guias, você pode encontrar informações sobre ela, como descrição, certificações ou se está integrada com o BankBot.
• On the selected card click on
  • Request Approval to let the Portal Administrator know that you want to use the API, they’ll have to approve it before you can start to use it.
  • Veja a API to check all the APIs documentation, examples, and errors, or even download Postman Collections to start testing them. By default, you will be reviewing a testing environment documentation, Bankbot’s. In the upper right corner, you can choose which documentation you want to see.
• Depois que sua solicitação for aceita, você receberá um e-mail informando que foi aprovada. Aqui você encontrará instruções para obter a Consumer Key e o Consumer Secret da sua solução, necessários para obter a autorização do 4WRD.
• Você pode ver o conjunto de APIs aprovadas ou pendentes de aprovação na guia "Minhas APIs" e também encontrar a biblioteca de APIs às quais se inscreveu.

The application ID and Secret key are unique and private credentials that allow FinConecta to safely identify your app in the Portal and não compartilhe essas informações com pessoas não autorizadas.

To use any API, first, you will need to call the Autorizar API, so we can recognize that you have access to the platform and your solution has been approved. Next comes the Create Access Token API, which we use to make sure the credentials you are using as a customer are valid.

Para se inscrever em outras APIs dentro do catálogo, siga o mesmo processo. Vire o cartão da API com um clique e solicite a aprovação. O consentimento para acessar outras APIs será concedido usando o mesmo ID de aplicativo e Secret Key

¡Aceite o desafio!

Outra forma de testar e integrar sua solução é através de uma Necessidade. Algumas delas estão relacionadas a um Desafio, enquanto outras podem ser apenas necessidades específicas e pontos de dor que estão sendo resolvidos. Estas são publicadas pelo Administrador do Portal ou por uma Instituição Financeira específica. Você encontrará uma descrição com informações sobre o que estão procurando e as APIs recomendadas para você considerar. 

Na barra lateral do menu, procure a seção de Necessidades section. There, you can see all the needs posted within your portal. Go, explore, and find something that looks interesting to you and your company, or that you think your Solution would be a good fit for. 

Assim que o fizer, você só precisará se inscrever!

Depois de encontrar uma Necessidade que chame sua atenção,

• Clique no cartão para virá-lo 
• On “More Information,” you’ll find an Overview of this Necessidade, the requirements, the recommended APIs, and a section to check your Application
• Clique em "Aplicar para resolver a necessidade" no cartão ou no canto superior direito das informações da Necessidade’s information and complete the application form
  • Your Application will be reviewed by the Financial Institution that posted this need/challenge, if they find your application a good match for what they are looking for, you’ll get an email notification.
  • Uma segunda aprovação da equipe da instituição financeira é necessária antes que você possa começar a testar sua solução.

Assim que sua inscrição for Aprovada para Sandbox, você será automaticamente inscrito nas APIs recomendadas para a Necessidade. Você pode verificar as APIs às quais está inscrito na guia de “Minhas APIs”. Agora você pode começar a construir.

Você pode começar a testar ou desenvolver sua solução para essa Necessidade, específica, testando-a contra o Bankbot ou o núcleo da Instituição Financeira. Não se esqueça de que você terá que apresentar um protótipo para isso dentro de sua aplicação para testá-lo e decidir se é o que estão procurando.

Best of luck!

Aquecendo!

Once you have successfully subscribed to selected APIs or been Approved for a Necessidade, you are ready to start testing with a Postman Collection. We provide you with a couple of Postman Collections separated by API Groups, Use Cases, or Institutions, so you can choose what suits you best. Choose one, download it, check the documentation as a guideline, and start testing!

Para começar a fazer testes, você precisa:

• Ir para APIs no menu principal
• Selecionar o cartão da API e clicar nele para virar 
• No cartão selecionado, clique em Veja a API
• Ir para Overview e na parte superior direita você pode selecionar a coleção do Postman da instituição que está procurando 
• Clicar no botão de download para obter sua coleção do Postman
• Importá-la para o Postman assim que você a tiver baixado
• Clicar na coleção, ir para as variáveis e alterar a key & secret with the one given to your Solution
  • To get them, go to Services > Gateway Subscriptions, select your solution and get the Consumer Key and Consumer Secret
• The Institution should provide you with a username and a password, for the “customer” or account that you would be testing with
• Certifique-se de que a variável do provedor corresponda à instituição à qual você está tentando se integrar. 
  • If you are not sure if you have that variable right, you can always contact the Portal Administrator 
• Once you have all the variables set correctly, you can start testing. Run the Autorizar API to generate the application, your solution, and access token
• A seguir, execute a Create Access Token para gerar o token de acesso do cliente que foi fornecido pela sua instituição
• Now you can run any API that you select

Se você tiver algum problema ou dúvida em relação à coleção do Postman ou à documentação, não hesite em entrar em contato conosco em support@finconecta.com.

Comece a testar!

Agora vem a parte divertida! Comece a construir com o BankBot, nosso simulador de dados bancários.

No momento da integração, recomendamos que você siga a documentação das APIs e faça uma chamada através do HTTPS para uma API autorizada. A plataforma suporta autenticação do cliente OAuth2 para gerar um token de acceso que será válido por tempo limitado. Esse token de acesso permite que você faça uma chamada, como uma transferência ou consulta de conta. Assim que o token de acesso expirar, você terá que solicitá-lo novamente.

To start integrating, you must check what information you have available to test. To do this, you can use our Bankbot.

No menu principal, vá para o simulador Bankbot. Aqui você pode encontrar dados sintéticos de Clientes e Transações.Em "Clientes", você encontrará conjuntos de dados "fictícios" fornecidos pela instituição a que está inscrito, e em "Transações", você poderá encontrar as diferentes operações correspondentes aos "Clientes" criados. Os conjuntos de dados podem ser filtrados pelo tipo de transação, como pagamentos, depósitos ou transferências. Considere o Bankbot como um banco real onde você pode testar sua solução por meio de nossas APIs sem precisar passar por integrações reais e sem qualquer repercussão se algo acontecer.

Nossa documentação da API mostrará como formatar as chamadas HTTPS. Preencha as informações necessárias e você poderá iniciar o processo de construção de sua aplicação em um ambiente controlado.

If you cannot find the information about customers or transactions, you need to test your solution, or have any inquiries regarding our documentation, just let us know! You can open a ticket, go to Serviços > Tickets and ask away, or just contact us via email.

Track your API calls

Para garantir que você e a instituição financeira possam visualizar as chamadas de API, fornecemos Métricas para que possam revisar suas chamadas de API. 

On the sidebar Menu, just click on Métricas. Os Simuladores Bancários shows transactions with Bankbot, Sandbox will show you your API calls once integrated with the Institution’s core in a testing environment, and Produção will show you actual API calls with the Institution’s core.

Under Metrics, you will be able to filter by “API," "Target”, “Solução," ou"Date Range”  depending on what you want to see, you can filter further in a specific period, i.e. by Year ou by Month. Top solutions, the most active ones, will also be displayed. Last but not least, you can also compare all your Successful and Failed API calls in a graph.

Quando terminar a etapa de testes com o Bankbot e no Sandbox, nossa equipe fornecerá todo o suporte necessário para levar o aplicativo para produção. 

Do not forget that we are here to help you with whatever we can!

Agora você está pronto para se conectar ao Core de um Banco!

Depois de testar sua solução com o Bankbot e ter certeza de que as APIs funcionam corretamente, você pode solicitar a integração ao Core de um banco. Ou talvez uma instituição financeira tenha visto sua Solução, revisado seu perfil, verificado suas chamadas à API nas Métricas, e decidiu entrar em contato com você porque gostou do que viu! 

Whatever the case, you are ready now to integrate into an actual Core, no more Bankbot. To do so, there are two options, as mentioned before.

Se você deseja se integrar ao Core e solicitar por conta própria, siga estas etapas:

• Clique em APIs no menu principal da barra lateral
• Ir para Minhas APIs e selecione o cartão da API à qual deseja solicitar acesso
• Depois de virar o cartão, clique em Core Banking Selection
• Selecione a Instituição Financeira à qual deseja se integrar
  • Here you might have multiple options to select, and you’ll be able to see which core you are already approved to, pending approval, or available to request access
  • Once you select a core, the Financial Institution will get an email to approve or reject the request
• Você será notificado sobre como obter um código de provedo para o Core da Instituição Financeira.

• APIs > Minhas APIs > Click on the API card you requested access to and select the core that you want to integrate to, the code is on the back of the card

The other option is if your Portal Owner gives you access to it directly. As mentioned above, if they have already checked your Solution and want you to integrate it into their core, they can give you access. You will get a notification on how to get it, and you can get the código do Provedor/Entidade assim que for aprovado para usá-lo como variável para sua integração.

Do not forget that the APIs and the documentation might be different for Bankbot compared to the Financial Institution you are trying to integrate into! Always check the documentation, and if you have any doubts, remember that your Portal Administrator and FinConecta are here to help you!

Boa sorte na integração! Esperamos que este guia tenha sido útil para você. 

"Você precisa de mais informações? Por favor, solicite o nosso Solution Provider Manual to walk you through FinConecta‘s platform.

Ajuda