> ## Documentation Index
> Fetch the complete documentation index at: https://docs.delfinance.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Contratar a API

> Contrate a API pelo internet banking e obtenha a chave de API, o account-id e o certificado mTLS de Produção

A contratação da API é feita no internet banking da conta Delfinance que vai usar a integração. Ao final, você tem tudo o que precisa para chamar a API em Produção:

* **chave de API**, enviada no header `x-delbank-api-key`;
* **ID da conta (account-id)**, enviado no header `x-delfinance-account-id`;
* **certificado mTLS** (`.pem`) e a **chave privada** (`.key`);
* **IPs autorizados** a acessar a API.

> [!NOTE]
>
> Tudo o que é gerado nesse fluxo vale para **Produção**. Para testar antes de contratar, use as [chaves de teste do Sandbox](https://docs.delfinance.com.br/autenticacao/chaves-teste.md).

## Antes de começar

* Tenha acesso ao internet banking da conta que vai usar a API.
* Faça a contratação no mesmo navegador do início ao fim. Se você escolher gerar o certificado no navegador, a chave privada fica só nele.
* Tenha um terminal com `curl` para testar o certificado.
* Separe os IPs públicos de saída dos servidores que vão chamar a API. Veja [Filtros de IPs](https://docs.delfinance.com.br/autenticacao/filtros-ip.md).

## Passo a passo

**1. Acesse Contratação de APIs**

No internet banking, clique em **Contratação de APIs** no menu lateral.

![Menu lateral do internet banking com a opção Contratação de APIs](https://mintcdn.com/delfinance/_wsbtL8KYPIo7r9r/assets/ib-contratacao-api/ib-api-00-menu.png?fit=max\&auto=format\&n=_wsbtL8KYPIo7r9r\&q=85\&s=f35b38ec46a3f711b1d1352962a208cd)

**2. Aceite o contrato**

Leia o contrato de utilização das APIs. Marque **Declaro que li e concordo com os termos do contrato** e avance.

![Etapa Contrato API, com o texto do contrato e a caixa de aceite](https://mintcdn.com/delfinance/_wsbtL8KYPIo7r9r/assets/ib-contratacao-api/ib-api-01-contrato.png?fit=max\&auto=format\&n=_wsbtL8KYPIo7r9r\&q=85\&s=0f3be069105c5a3b25d15a5cde743227)

**3. Configure o certificado mTLS**

Escolha como o certificado será emitido:

* **Gerado automaticamente neste navegador**: o internet banking cria a chave privada no seu navegador e emite o certificado. A chave privada não é enviada à Delfinance.
* **Meu time técnico já tem um CSR**: você envia um CSR gerado pelo seu time. Veja como gerar em [Gerando o CSR com OpenSSL](https://docs.delfinance.com.br/autenticacao/mtls.md#gerando-o-csr-com-openssl).

![Etapa Configurações mTLS, com as opções de geração no navegador e de envio de CSR](https://mintcdn.com/delfinance/_wsbtL8KYPIo7r9r/assets/ib-contratacao-api/ib-api-02-config-mtls.png?fit=max\&auto=format\&n=_wsbtL8KYPIo7r9r\&q=85\&s=0d23b677c318b789a15c2c08575de58d)

> [!WARNING]
>
> A forma de emissão não pode ser alterada durante a contratação.

Com o certificado emitido, clique em **Continuar para o teste**.

**4. Teste o certificado**

Nesta etapa, você testa a conexão mTLS fora do internet banking:

1. Clique em **Baixar chave privada (.key)**. Só aparece se o certificado foi gerado no navegador.
2. Clique em **Baixar certificado (.pem)**.
3. Copie o comando `curl` exibido e execute no seu terminal, na pasta onde estão os dois arquivos. A URL do `hello-mtls` é exclusiva do seu certificado.
4. Clique em **Verificar teste**.

![Etapa Testar o certificado mTLS, com os botões de download e o comando curl](https://mintcdn.com/delfinance/_wsbtL8KYPIo7r9r/assets/ib-contratacao-api/ib-api-03-teste-mtls.png?fit=max\&auto=format\&n=_wsbtL8KYPIo7r9r\&q=85\&s=9c8ad0e1e6e8f52f4c53b94175405bf3)

> [!WARNING]
>
> A chave privada gerada no navegador existe somente nele. Baixe o arquivo `.key` nesta etapa e guarde em local seguro. Em outro navegador ou em outra sessão, ela não fica disponível para download.

Quando a conexão for identificada, o internet banking exibe **Conexão mTLS identificada com sucesso**. Clique em **Próximo**.

![Teste mTLS validado com sucesso](https://mintcdn.com/delfinance/_wsbtL8KYPIo7r9r/assets/ib-contratacao-api/ib-api-04-mtls-validado.png?fit=max\&auto=format\&n=_wsbtL8KYPIo7r9r\&q=85\&s=73bb61d2da112d1c710389e7ae5d6997)

**5. Informe os IPs autorizados**

Informe o **Endereço IP** de cada servidor que vai chamar a API e, se quiser, uma **Descrição**. Clique em **Adicionar IP** para cada um.

![Etapa IPs Autorizados, com o campo de endereço IP e a lista de IPs cadastrados](https://mintcdn.com/delfinance/_wsbtL8KYPIo7r9r/assets/ib-contratacao-api/ib-api-05-ips.png?fit=max\&auto=format\&n=_wsbtL8KYPIo7r9r\&q=85\&s=587d9c09596f5130f719036ac6db15a2)

A Delfinance recomenda cadastrar os IPs. Se preferir dispensar a allowlist, marque **Quero seguir sem informar IP, mas tenho ciência de que é uma etapa de segurança que a Delfinance recomenda**. Ao dispensar, requisições autenticadas passam a ser aceitas de qualquer IP. Veja o que muda em [Dispensa da allowlist](https://docs.delfinance.com.br/autenticacao/filtros-ip.md#dispensa-da-allowlist).

**6. Copie a chave de API**

Na finalização, o internet banking exibe a **Chave de produção**. Copie e guarde a chave em um gerenciador de senhas ou cofre de segredos.

![Etapa Finalização, com a chave de produção e o download do contrato](https://mintcdn.com/delfinance/_wsbtL8KYPIo7r9r/assets/ib-contratacao-api/ib-api-06-finalizacao.png?fit=max\&auto=format\&n=_wsbtL8KYPIo7r9r\&q=85\&s=a166f8a7b77d9551824939f7d5786a8e)

> [!WARNING]
>
> Por segurança, a chave fica disponível para visualização e cópia por tempo limitado. Copie antes de concluir e nunca compartilhe a chave por e-mail, WhatsApp ou outros canais inseguros.

Se quiser, clique em **Baixar contrato** para guardar uma cópia do contrato assinado. Depois, clique em **Concluir**.

## Depois da contratação

Ao acessar **Contratação de APIs** de novo, você vê a tela da API contratada, com:

* **Chave de API**: exibida mascarada;
* **ID da conta (account-id)**: valor do header `x-delfinance-account-id`, com botão para copiar;
* **Certificado mTLS**: status, data de expiração e o botão **Baixar certificado**;
* **IPs autorizados**: lista de IPs, com opção de adicionar e remover. Você pode ativar ou dispensar a allowlist a qualquer momento. Adicionar um IP ativa o filtro. Veja [Dispensa da allowlist](https://docs.delfinance.com.br/autenticacao/filtros-ip.md#dispensa-da-allowlist).

![Tela da API contratada, com chave de API, account-id, certificado mTLS e IPs autorizados](https://mintcdn.com/delfinance/_wsbtL8KYPIo7r9r/assets/ib-contratacao-api/ib-api-07-integracao-ativa.png?fit=max\&auto=format\&n=_wsbtL8KYPIo7r9r\&q=85\&s=689f642ad728d4fab71fbb6a28de12d4)

## Próximos passos

> [card] [Exemplos de conexão](https://docs.delfinance.com.br/autenticacao/exemplos-conexao.md)
>
> Monte o cliente HTTP com o certificado e os headers na sua linguagem.

> [card] [mTLS](https://docs.delfinance.com.br/autenticacao/mtls.md)
>
> Entenda o certificado, como gerar um CSR e os erros mais comuns.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.