Visão geral

A API Datanomik permite que seus sistemas leiam as informações financeiras das contas das suas empresas (saldos, transações, investimentos, pagamentos e mais) de diversas instituições, por meio de uma interface única e padronizada.

A Datanomik se conecta a cada instituição, coleta as informações e as normaliza. Sua integração as lê da Datanomik sempre que precisar.

Fluxo de integração

1. Crie um link

Um link é a conexão com um acesso em uma instituição. Crie-o com POST /v1/links, enviando a instituição e as credenciais que ela exige. A resposta (201 Created) inclui o id do link, que o identifica em todas as demais chamadas.

📘

Credenciais por instituição

Cada instituição exige campos diferentes (usuário, senha, certificado, CNPJ…). Use GET /v1/institutions/{id} para ver os campos de cada uma. Os links também podem ser criados pelo dashboard da Datanomik.

2. Aguarde a primeira sincronização

Depois que o link é criado, a Datanomik se conecta à instituição e carrega o histórico. Consulte o link com GET /v1/links até que seu status seja ACTIVE. Se for UNAUTHORIZED, a instituição rejeitou as credenciais.

3. Leia as informações

Use o id do link (ou o id da conta) para ler os recursos de que você precisa:

• Contas e saldos
• Transações e suas categorias
• Investimentos
• Pagamentos, transações PIX e seus comprovantes
• Titulares e usuários

Essas chamadas leem os dados que a Datanomik já coletou: são rápidas e não se conectam à instituição.

4. Mantenha as informações atualizadas

A Datanomik sincroniza cada link automaticamente, de acordo com os agendamentos configurados para o seu espaço de trabalho. Para ler os dados mais recentes, consulte a API novamente: compare accessed_at (link) ou refreshed_at (conta) para saber quando as informações foram atualizadas pela última vez.

Se você precisar de dados mais recentes imediatamente, solicite uma atualização sob demanda:

1. Chame POST /v1/links/{id}. A resposta (202 Accepted) inclui um request_id.
2. Acompanhe o progresso com GET /v1/links/{id}?requestId={request_id} até que termine.
3. Leia os recursos novamente.

Um link pode ser atualizado sob demanda no máximo uma vez a cada 5 minutos; caso contrário, você recebe 412 LINK_RECENTLY_REFRESHED.

📘

Sem webhooks

A API Datanomik não envia notificações aos seus sistemas. Para detectar novas informações, consulte a API periodicamente ou use a atualização sob demanda.

5. Faça a manutenção dos seus links

• As credenciais mudaram? Se a senha na instituição mudar, o link passa a UNAUTHORIZED. Envie as novas credenciais com PUT /v1/links/{id}.
• Pause ou retome a sincronização com PATCH /v1/links/{id}/status/{status} (INACTIVE ou ACTIVE).
• Exclua um link de que você não precisa mais com DELETE /v1/links/{id}. Suas credenciais e dados são excluídos permanentemente (veja Sobre a segurança).

Próximos passos

• Início rápido: obtenha suas chaves de API e faça sua primeira requisição.
• Glossário: conceitos, convenções de dados e erros.
• Referência da API: todos os endpoints, com exemplos.