Para ajudá-lo durante o seu processo de integração, criamos uma lista de verificação para você seguir 😉. Certifique-se de abordar todos os itens antes de solicitar acesso ao ambiente de Produção.
Enquanto você integra o widget, certifique-se de que:
- Seus usuários primeiro registrem uma conta com seu aplicativo antes de solicitar que eles conectem suas contas com a Belvo.
- Você está usando o parâmetro
external_idpara fornecer seu próprio ID único para um link (ou grupo de links) em seu sistema. Nota: Este parâmetro também é pesquisável dentro do sistema da Belvo. - Se estiver usando links únicos, você utiliza o parâmetro
fetch_resourcespara receber de forma assíncrona dados históricos sobre seu usuário. - Você pode gerar um token de
access. - Você implementou corretamente suas URLs de callback.
- Você pode lidar com eventos de Sucesso, Saída, Erro e Aviso do Hosted Widget.
Certifique-se de que sua integração pode lidar e registrar o request_id de:
- Erros 400 e 401
- Erros 500
- Erros de timeout
Pedimos que você registre o request_id caso precise entrar em contato com nossa equipe de suporte. Com este ID, podemos acelerar o processo de resolução de problemas e encontrar uma solução para você.
Para mais informações sobre a lógica de repetição que você deve implementar, veja nossas Notas gerais sobre tratamento de erros.
Sua integração pode lidar com:
- Respostas de Sucesso 200, 201 e 202
- Respostas de Sucesso 204 (quando você exclui alguns dados)
- Paginação
Além disso, certifique-se de que, com respostas bem-sucedidas, você armazene:
- O identificador único para o objeto (por exemplo, o
transaction.id). Isso permitirá que você evite ter objetos duplicados (como transações) no seu banco de dados.
Seja você um usuário de links únicos ou recorrentes, certifique-se de:
- Definir uma URL de webhook no dashboard para que você possa receber eventos de webhook. Lembre-se de que você precisará definir URLs de webhook diferentes dependendo do ambiente em que está trabalhando.
- Se estiver usando links recorrentes, que você configurou sua taxa de atualização de acordo com suas necessidades (diária, semanal ou mensal) (entre em contato com nossa equipe de vendas).
- Enviar apenas requisições GET após receber um evento de webhook.
- Responder dentro de cinco segundos após receber um webhook com um 200 OK.
- Colocar na lista de permissões os seguintes endereços IP:
Você pode receber eventos de webhook dos seguintes endereços IP:
3.130.254.4618.220.61.18618.223.45.212
Recomendamos fortemente que você coloque esses endereços IP na lista de permissões para que possa receber eventos de webhook.
Sua integração:
- Possui um mecanismo para evitar que links duplicados sejam criados?
- Monitora os status de link
invalidetoken_requirede, se necessário, solicita que seus usuários atualizem suas credenciais?
Se fizermos as seguintes alterações que não causam interrupção em nossa API, você tem certeza de que isso não afetará sua integração?
- Novos campos ou uma ordem diferente no corpo da resposta.
- Alterar o número de caracteres de uma string.
- Retornar timestamps
yyyy-MM-ddTHH:mm:ss.SSSZ, ondeSsão microssegundos (de 3 a 6 dígitos) eZé ou+00:00ouZ. - Adicionar novos endpoints.
Quando você estiver mudando para Produção, certifique-se de que:
- Você está chamando a versão de produção da API da Belvo (https://api.belvo.com).
- Você está usando suas Chaves de API de Produção da Belvo.
- Você está armazenando suas chaves de API de forma segura.
Certifique-se de que você se inscreveu nos seguintes serviços para estar atualizado sobre o status da nossa API e das instituições:
- Status da API Belvo
- Status da instituição (consulte nosso guia dedicado)