Aqui na Belvo, sabemos que pode ser trabalhoso adicionar um novo serviço ou funcionalidade a qualquer produto. Mas não se preocupe! Depois deste post, você terá uma visão completa do que é essencial e as ferramentas necessárias para que os desenvolvedores possam integrar com a Belvo, sem ter que quebrar a cabeça.
Conhecimento básico sobre APIs 🤓
Se você nunca trabalhou com uma API antes, vamos começar falando sobre duas coisas: REST APIs e formato JSON.
REST APIs
REST é um acrônimo para REpresentational State Transfer, ou seja, Transferência de Representação de Estado, um estilo de arquitetura para sistemas de hipermídia distribuídos.
O ponto de partida são os recursos, sendo eles a principal abstração de uma informação em REST. Qualquer informação identificável pode ser um recurso. Um documento, uma coletânea de outros recursos, um produto ou até mesmo uma pessoa – tudo isso pode ser um recurso aos olhos da arquitetura REST.
Há então os métodos de requisição, também conhecidos como verbos, que descrevem ações a serem tomadas a partir dos dados provenientes do recurso:
- GET: ler ou recuperar uma informação
- POST: criar um novo recurso
- PATCH: modificar parcialmente um recurso
- PUT: substituir ou atualizar um recurso existente
- DELETE: deleta um recurso.
Isto é basicamente tudo que você precisa saber sobre REST.
JSON
Agora, vamos falar sobre JSON. Quando as requisições são feitas, é preciso que as informações sejam enviadas em um formato padrão que possa ser facilmente compreendido por qualquer um na Web – e é isso que é o JSON. É um formato leve de troca de dados entre sistemas que é muito simples de usar (é só ver na imagem abaixo).
Agora, vamos ver como isso tudo funciona:
- O usuário faz alguma interação que requer dados da Belvo
- Você faz um método de requisição de recurso para a nossa API
- A Belvo pede para a instituição a informação que você precisa
- A Belvo te envia, em JSON, toda a informação solicitada
E é basicamente isso.
Entendendo a nossa API 📚
Através da nossa API, você consegue acessar informações de bancos como transações, saldo, entradas e identificação do titular da conta. Você pode ver a cobertura de instituições por país aqui.
Leia mais sobre todos os dados que você pode acessar neste link.
Documentação
E, é claro, todos nós sabemos o quanto os desenvolvedores valorizam uma boa documentação, então colocamos bastante amor e dedicação na nossa.
- Tenha uma visão geral da nossa API e suas especificações.
- Saiba mais sobre links, instituições, e autenticação multifator (MFA).
Check-list
Quando você consegue responder “Sim” para as perguntas abaixo, aí sim é possível dizer que você possui um bom entendimento da nossa API:
- Você entende que tipo de dados você precisa para o seu projeto?
- Você sabe a diferença entre links únicos (single links) e links recorrentes (recurring links)?
- Você entende como usar requisições PATCH para contas que exigem MFA?
Brincando com o sandbox 🏏
Com a documentação da Belvo assimilada, é hora de começar a brincar com os dados disponíveis no nosso ambiente sandbox.
Ele foi pensado especialmente para que você possa interagir com dados fictícios de fontes bancárias. Assim, é possível prototipar e iterar a integração no ambiente testes para que a transição para dados reais não exija mais do que a alteração de alguns parâmetros.
Para acessar nosso ambiente sandbox, assim como configurar o Postman, confira nosso Guia Rápido. Não leva mais do que cinco minutos para concluir!
Uma vez que você testou nossa API e entende bem seu funcionamento, o próximo passo é começar a integrar nossos serviços na sua plataforma.
Integrando de verdade ⚒️
Na Belvo, nós queremos que você consiga integrar o mais rápido possível. E para facilitar, nós criamos algumas ferramentas que garantem uma integração mais fluida.
Connect Widget
Você pode usar o nosso Connect Widget para conectar de maneira segura os usuários às instituições.
Ele está disponível tanto para aplicações mobile quanto para a web. Essa experiência de login otimizada para os usuários pode ser embedada diretamente no seu produto. E como nós pensamos em todos os possíveis cenários que o usuário possa vivenciar ao conectar suas contas, sobra tempo para você dedicar seus valiosos recursos fazendo as chamadas de API certas para conseguir os dados que você precisa.
É possível ainda customizar e adicionar a sua marca ao widget para ir de encontro às suas necessidades.
SDKs
A Belvo oferece bibliotecas oficiais de APIs para diferentes linguagens, incluindo:
Não usa nenhuma dessas linguagens? Sem problema: você pode usar a Biblioteca de Requisição HTTP para selecionar a linguagem que desejar – e então é só olhar nosso guia de referências API e começar a fazer chamadas.
Primeiros passos no mundo real 🌎
Uma vez implementado o nosso widget e com todas as integrações criadas no ambiente Sandbox, finalmente chegou o momento de testar com dados reais. Felizmente, a Belvo tem um ambiente especial para isso: o ambiente de Desenvolvimento.
Aqui, é possível estabelecer até 25 conexões com instituições ativas e começar a testar os dados de usuários reais. Para acessar, é só solicitar suas chaves de API para esse ambiente e substituir as chaves sandbox por essas novas, trocar a URL base para aquela em que você faz as suas requisições e… não, é só isso mesmo!
| Dica! É recomendado ter ao menos um usuário por instituição desejada. Por exemplo, se você quiser acessar dados de bancos, tenha ao menos um usuário de Bradesco e Itaú, por exemplo. Assim, você saberá exatamente que tipo de data esperar. |
Processo de Certificação ✔️
Tendo testado a integração no ambiente de Desenvolvimento e com tudo rodando conforme o que você precisa, você provavelmente vai querer colocar a sua integração no mundo (em outras palavras, em Produção).
Mas, antes de fazer isso, aqui na Belvo temos um processo de certificação. De maneira geral, queremos garantir que tudo esteja configurado do jeito certo, que a sua integração está manejando os dados corretamente e que os dados dos seus usuários não estão em risco (afinal, dados financeiros são informações sensíveis que exigem muita atenção).
Antes de começar o processo, assegure-se de que:
- As chaves API estejam sendo armazenadas de forma segura;
- Os usuários se registrem na sua plataforma antes de usar o widget para conectar suas contas. Caso contrário, você receberá erros sobre links duplicados;
- As requisições de erro possam ser gerenciadas (e que a “request_id” esteja sendo armazenada -> isso ajudará com o debug mais tarde);
- Todos os webhooks estejam configurados;
- Os links possam ser deletados e que a resposta enviada pela Belvo confirmando a exclusão possa ser assimilada.
Se você cumpre todos esses requisitos, é só agendar uma reunião para certificação, impressionar nossos engenheiros com a sua integração perfeita e então…
Tudo pronto! ✨
Você está pronto para receber usuários e começar a usar a Belvo.
E lembre-se: nosso time de suporte técnico estará sempre disponível para você, e ajudará seu time de desenvolvimento durante todo o processo para responder qualquer dúvida que aparecer.
Caso algum destes tópicos não tenha ficado claro para você, ou caso tenha alguma pergunta durante o processo de integração, fale com a gente pelo email hello@belvo.com.
