Skip to main content
Para começar a integrar com a Delfinance, você precisa configurar seus ambientes de desenvolvimento e obter suas credenciais de acesso. Oferecemos dois ambientes distintos para garantir a segurança e estabilidade da sua integração.

​
1. Ambientes: Sandbox vs Produção

RecursoSandbox (Testes)Produção (Real)
ObjetivoSimular cenários de teste sem dinheiro realProcessar transações financeiras reais
URL Basehttps://apisandbox.delbank.com.brhttps://api.delbank.com.br
LimitesRate limit reduzido, dados fictíciosRate limit comercial, dados reais
DinheiroMoeda fictíciaDinheiro real (BRL)

​
2. Configurando seu Ambiente de Sandbox

O ambiente de Sandbox é o ponto de entrada para testar a integração sem impacto financeiro. O fluxo atual no portal do desenvolvedor é o seguinte:
1

Acesse o portal do desenvolvedor

Entre no Portal do Desenvolvedor Delfinance Sandbox. Na tela de login, você pode entrar com Google, GitHub ou realizar um cadastro tradicional.Tela de login do portal do desenvolvedor
2

Acesse a área logada

Após entrar, você será direcionado para a home do portal. Ali você encontra o ponto de início para solicitar o acesso ao ambiente de Sandbox.Home do portal do desenvolvedor
3

Informe seu CNPJ para o Sandbox

Na solicitação de credenciais de Sandbox, informe o CNPJ que deseja usar para o ambiente de testes. Preferencialmente, esse CNPJ deve ser o da sua empresa.Solicitação de credencial de sandbox no portalSe ainda não tiver um CNPJ corporativo disponível, você pode usar um CNPJ temporário para obter as credenciais de Sandbox. Essa necessidade é temporária e, na migração para Produção, você poderá informar o CNPJ real da empresa.
4

Receba sua chave de API exclusiva

Após a solicitação, a plataforma gera uma chave de API exclusiva para a sua integração e disponibiliza essa credencial na home do portal.Credencial de sandbox disponível na homeVocê pode copiar a chave quando necessário.Credencial de sandbox copiada
5

Use a chave na integração

Com a chave em mãos, você já pode autenticar suas requisições no Sandbox. Para Produção, o processo é semelhante, mas com as regras de segurança adicionais aplicadas.
Nunca compartilhe sua API Key, Account ID ou chave privada do certificado em repositórios públicos.

​
3. URLs base e headers padrão

Antes de fazer a primeira chamada, vale conhecer os endpoints e os headers que a API espera.

​
URLs base

AmbienteURL base
Sandboxhttps://apisandbox.delbank.com.br
Produçãohttps://api.delbank.com.br

​
Headers padrão

Os headers abaixo são parte do modelo atual de integração:
CabeçalhoObrigatórioDescrição
x-delbank-api-keySimChave de API da integração
x-delfinance-account-idSimIdentificador da conta
Content-TypeSimapplication/json
IdempotencyKeyEm operações de cashoutChave única de idempotência

​
Próximo passo

Após validar sua integração no Sandbox, o próximo passo é preparar a operação em Produção. Para entender melhor esse processo e o que muda na transição, consulte a página Ida para Produção.

​
4. Fazendo a primeira requisição

Com a sua API Key e o Account ID em mãos, você já consegue chamar a API no ambiente de Sandbox.

​
Passo A: Envie as credenciais da API

Use os headers abaixo para autenticar a requisição: 
curl https://apisandbox.delbank.com.br/v1/accounts \
  -H "x-delbank-api-key: SUA_API_KEY" \
  -H "x-delfinance-account-id: SUA_ACCOUNT_ID"

​
Passo B: Revise as regras de segurança antes de avançar

Antes de migrar para Produção, revise as boas práticas e os componentes de segurança da integração na página Autenticação e segurança.