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


2. Configurando seu Ambiente de Sandbox

O ambiente de Sandbox é o ponto de entrada para testar a integração sem impacto financeiro. Para testar, use uma das chaves de teste do Sandbox: escolha uma conta e envie os valores nos headers x-delbank-api-key e x-delfinance-account-id. Para Produção, contrate a API no internet banking. A contratação gera a chave de API, o account-id e o certificado mTLS. Veja o passo a passo em Contratar a API.
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

Headers padrão

Os headers abaixo são parte do modelo atual de integração:

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:

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.