404 nas chamadas até que o acesso em produção seja anunciado, e nada é cobrado no sandbox.
Este guia rápido leva você de uma aplicação de sandbox até as contas, saldos e transações do Didit Test Bank, com requisições prontas para copiar e colar.
Cada resposta abaixo foi encurtada para os campos que importam.
Mantenha a chave de API no seu servidor: ela nunca chega a um navegador ou a um aplicativo.
Passo 1: crie uma chave de API com a permissão Bank data
Bank data não faz parte do acesso total. Uma chave com acesso total, incluindo o segredo principal da aplicação, é recusada em todas as chamadas de Bank data com403 bank_data_access_denied.
- No Business Console, abra sua aplicação de sandbox e acesse API keys.
- Crie uma chave com acesso personalizado e adicione Bank data: Read para as leituras e Write para as chamadas que criam, alteram ou excluem algo.
- Copie a chave e exporte-a:
Etapa 2: criar um link
Um link é uma execução das telas em que uma pessoa conecta um banco. Crie um link contínuo para o Test Bank:country é o código de três letras do país do banco da pessoa e é opcional.
Envie-o quando souber, para que a pessoa veja apenas os bancos desse país; sem ele, ela escolhe entre todos os países que você pode atender.
Para acesso único, envie "access": "one_time" (o padrão).
id do link junto com o seu usuário.
A url e o client_token são retornados uma única vez, quando o link é criado.
Etapa 3: abra o link e conecte o Didit Test Bank
Abra aurl em um navegador ou envie-a para a pessoa por e-mail ou chat.
A pessoa vê a tela de consentimento, escolhe Didit Test Bank, faz login com um dos clientes de teste e escolhe as contas que quer compartilhar.
A página do sandbox lista os clientes de teste e o que cada um oferece.
Para devolver a pessoa ao seu site depois, veja Retornar ao seu site.
Sem redirect_url, a pessoa termina na página de resultado da Didit, e você fica sabendo do resultado por meio do webhook ou de uma consulta.
Etapa 4: receber os webhooks e confirmar
Inscreva um destino do webhook nos eventosbank.* no console, como faria para qualquer webhook.
Quando a pessoa concluir o fluxo, bank.link.completed chega com o link_id e o connection_id. Depois, bank.connection.created chega quando a primeira sincronização já tiver armazenado as contas.
Nunca confie em um ID de link que o navegador enviar para você.
Consulte o link por conta própria:
status é completed ou um status final (cancelled, expired, failed). Um link failed traz um error.code; um link cancelled retorna error: null.
Passo 5: ler contas, saldos e transações
next_page_token enquanto houver mais itens para ler.
Veja Contas, saldos e transações.
Etapa 6: acompanhe o feed de alterações
O feed de alterações retorna apenas o que mudou desde a sua última leitura. Sua primeira leitura, sem cursor, é o snapshot completo: todas as transações da conexão, cada uma comoadded, com reset: true.
Uma primeira página pode trazer has_more: true com um next_page_token e nenhum next_cursor ainda.
Continue lendo com page_token enquanto has_more for true, e armazene o next_cursor da última página (a que tem has_more: false) para a próxima vez:
reset: true significa que a resposta é um snapshot completo: substitua sua cópia por ela, em vez de acrescentar dados a ela.
bank.data.updated avisa quando uma sincronização armazenou algo novo.
Etapa 7: sincronizar agora
Uma conexão contínua sincroniza automaticamente. Para ler o banco agora, solicite uma sincronização:sync.live_syncs_left_today e sync.budgets da conexão informam quantas restam e quando são redefinidas, e uma chamada que ultrapassa o limite responde com 429 refresh_limit_reached e o horário de redefinição.
Consulte Atualizar os dados bancários sob demanda.
Etapa 8: interromper o acesso e excluir
Interromper o acesso e excluir são duas chamadas diferentes.id, status, status_reason, created_at e erasure.
Consulte Dados, consentimento e exclusão.
Próximos passos
- Conexões: acesso único e contínuo, consentimento e renovação.
- Webhooks bancários
- Preços
- Referência da API