Última atualização

Comece em 10 (mais ou menos) minutos

Então, quer começar a usar o Belvo? Nós temos tudo o que você precisa. Nas próximas seções, vamos configurar suas chaves de API, uma coleção do Postman, e guiá-lo por um fluxo simples com nossa API para que você possa ver como é fácil acessar um mundo inteiro de informações!

Pré-requisitos

Neste guia de introdução, utilizamos dois softwares para os quais você deve criar contas gratuitas:

Depois de criar essas contas, você pode prosseguir com este guia!

Crie uma conta Belvo

Para começar a usar o Belvo, você precisa criar uma conta Belvo e gerar suas chaves de API.

  1. Acesse a página de cadastro do Belvo e preencha os campos obrigatórios.
  1. Verifique sua caixa de entrada para um e-mail nosso e confirme seu endereço de e-mail.
    A linha de assunto será: [Belvo] Please Confirm Your Email Address

✳️ Incrível! Assim que você clicar no link no e-mail, será redirecionado para o dashboard do Belvo! No dashboard, você pode configurar sua conta, verificar seus registros de atividade e gerar suas chaves de API do Belvo.

Gere suas chaves de API e faça fork da coleção do Postman

Agora que você tem uma conta - vamos gerar algumas chaves de API para começar a trabalhar com a Belvo.

📘 Ambientes da Belvo

A Belvo oferece dois ambientes:

  • Sandbox: um ambiente de teste com dados fictícios que você pode usar para desenvolvimento e testes ilimitados.
  • Production: um ambiente ao vivo usado com conexões reais a instituições. Se você deseja acesso ao nosso ambiente de Produção, precisará entrar em contato com nossa equipe de suporte para que possamos configurá-lo.

Para cada ambiente, você precisa de chaves de API separadas.

Para gerar suas chaves de API:

  1. No ambiente Sandbox, vá para a aba Developers - API Keys do dashboard. Recomendamos que você use o ambiente sandbox para explorar nossa API.

  2. Clique em Generate API Keys, o que gerará automaticamente suas chaves de API.

  3. No pop-up, clique no botão Run in Postman. Isso fará automaticamente o fork da nossa Coleção do Postman para o seu workspace privado e preencherá o secretId e secretPassword.

    🚧 Por razões de segurança, mostramos o secretPassword apenas uma vez no dashboard após a geração. Certifique-se de armazená-lo com segurança para poder recuperá-lo mais tarde. Se você perder seu secretPassword, precisará redefinir suas chaves de API.

  4. Você será redirecionado para o Postman e precisará:

    1. Dar um nome ao fork, como My_First_Belvo_Fork.

    2. Selecionar em qual workspace a coleção deve ser salva (por padrão, você deve selecionar My Workspace).

    3. Clicar em Fork collection.

✳️ Pronto! A coleção do Postman da Belvo será copiada para o seu workspace e você poderá facilmente fazer chamadas de API para recuperar informações!

👍 Ambientes do Postman

Quando você faz o fork da coleção, a Belvo cria automaticamente o ambiente do Postman para você com o baseUrl, secretId e secretPassword. Então, quando você quiser usar nossa API, basta procurar um ambiente que comece com Belvo - sandbox (xxx).

📘 Já tem chaves de API e só quer a coleção?

Se você já tem suas chaves de API e só quer fazer o fork da nossa coleção, basta clicar no botão Run in Postman abaixo! (Observe que o link abaixo não abre em uma aba separada. Recomendamos que você use Ctrl / Cmd e clique no link para abrir em uma nova aba.)

Run In Postman

Teste se funciona!

Só para garantir que você configurou tudo corretamente, vamos verificar se você consegue listar todas as instituições em nosso ambiente Sandbox.

  1. Certifique-se de que você selecionou seu ambiente Belvo - sandbox (xxx).
  2. Vá para Belvo API Docs → Core Aggregation Resources → Institutions → Get List all institutions.
  3. Clique em Send.
  4. Se tudo estiver configurado corretamente, você deverá ver uma série de instituições aparecer!

✳️ E você terminou! Agora, vamos configurar o Pipedream!

Adicione suas chaves de API da Belvo ao Pipedream

Para adicionar suas chaves de API da Belvo ao Pipedream:

  1. Faça login na sua conta do Pipedream.

  2. Vá para Configurações - Variáveis de Ambiente.

  3. Clique em New Variable e na janela pop-up

    1. Para a Key, insira secretIdSandbox.

    2. Para o Value, insira o secretId da Belvo que você gerou no seu dashboard.

    3. Para a Description, insira My Sandbox Belvo secretId.

    4. Marque a caixa Configure as secret.

    5. Clique em Create.

  4. Clique em New Variable novamente e na janela pop-up

    1. Para a Key, insira secretPasswordSandbox.

    2. Para o Value, insira o secretPassword da Belvo que você gerou no seu dashboard.

    3. Para a Description, insira My Sandbox Belvo secretPassword.

    4. Marque a caixa Configure as secret.

    5. Clique em Create.

✅ Feito! Agora, quando fizermos fork do Webhook Workflow da Belvo, suas chaves de API serão automaticamente adicionadas a qualquer fluxo.

Fazendo Fork do Workflow de Webhook da Belvo

Para fazer fork do Workflow de Webhook da Belvo:

  1. Clique neste link para fazer fork do workflow: Fork Belvo Webhook Worklow.
  2. Forneça um Nome do Projeto, como Belvo_Integration_Sandbox, e clique em Create project and continue.
  3. Forneça um Nome do Workflow, como Belvo_Webhook_Workflow_Sandbox, e clique em Create Workflow.

❇️ Pronto! Agora você tem o Workflow de Webhook da Belvo na sua conta do Pipedream. Agora só precisamos gerar a URL do Webhook para que você possa adicioná-la à sua conta da Belvo!

Gerar a URL do Webhook

Para gerar a URL do Webhook para o Workflow do Webhook Belvo:

  1. No workflow:

    1. Clique no trigger (primeiro item no workflow).
    2. No pop-up à direita, clique em Save and continue.

  2. Copie a URL do webhook gerada e salve-a.

  3. Clique em Deploy.

❇️ Pronto! Agora você tem uma URL de webhook que pode adicionar à sua conta Belvo!

Adicionando a URL do webhook ao Belvo

Agora que você criou uma URL de Webhook, vamos adicioná-la à sua conta Belvo:

  1. Faça login no seu Dashboard Belvo.

  2. Escolha o ambiente Sandbox. Para testes iniciais, e ao longo deste guia, usamos o ambiente Sandbox.

  3. Vá para Developers -> Webhooks.

  4. Clique em +New webhook.

  5. Preencha o formulário New webhook com as informações necessárias.

    1. URL: a URL para receber as notificações do webhook.
    2. Authorization: um token bearer opcional para usar se sua URL estiver protegida.

  6. Clique em Create webhook.

✅ Feito! Você agora criou um webhook e pode começar a criar links e receber eventos!

Testando o fluxo

Agora que temos tudo configurado, podemos testar o fluxo para garantir que tudo está funcionando perfeitamente!

  1. No Postman, certifique-se de selecionar seu ambiente Belvo Sandbox.

  2. Vá para Belvo API Docs -> Core Aggregation Resources -> Links -> Register a new link.

  3. Na aba Body, copie e cole o seguinte código:

    {
    "institution": "planet_mx_employment",
    "username": "BLPM951331IONVGR54",
    "external_id": "getting_started_link",
    "access_mode": "single",
    "fetch_resources": ["EMPLOYMENT_RECORDS"]
}

  4. Clique em Send.


Agora no Pipedream, vá para o Belvo_Webhook_Workflow_Sandbox e veja a mágica acontecer! (Note que, na primeira vez que você executar este fluxo, o webhook pode demorar um ou dois minutos para chegar, pois a Belvo realiza a validação na URL).

Assim que você vir os eventos do webhook chegando, você pode clicar neles e, no painel à direita, rolar para baixo para ver seus dados!

✅ E é isso! Você acabou de criar um fluxo de webhook e pode recuperar dados da Belvo de forma assíncrona. Isso é fantástico! Você pode usar este fluxo com qualquer um dos nossos produtos de agregação:

  • Banking
  • Employment
  • Fiscal
Página anterior
Próxima página
Copyright © 2020-2025 Belvo. All rights reserved