Criar Conta e Obter API Key

Acesso

Atenção

Enquanto sua aplicação estiver em desenvolvimento, você deve utilizar somente o endpoint Sandbox em https://sandbox.boletocloud.com, isso evitará maiores problemas como bloqueio de chamadas, inconsistência de dados e até o bloqueio total da conta na plataforma.

Para acessar a API você precisa ter uma conta cadastrada na Plataforma Boleto Cloud, não se preocupe, o plano free já fornece o acesso a API.

Para evitar maiores problemas e evitar de ter a conta Boleto Cloud Bloqueada por uso incorreto da API, recomendamos fortemente que primeiro crie seu acesso no ambiente Sandbox em https://sandbox.boletocloud.com, para executar os testes com a API ou outros testes que deseje realizar.

Criando o Token de Acesso - Sandbox

Crie sua conta no ambiente Sandbox em https://sandbox.boletocloud.com ou caso já tenha criado, efetue o login, você deve visualizar algo como a imagem abaixo:

Dentro da área de dados do usuário, você terá disponível o botão para gerar o token da API, como na imagem abaixo:

Com o seu token criado, ele deverá ser algo similar ao que disponibilizamos nos exemplos aqui na documentação: api-key_vJxqRj_8ZIu7850rCC3R-lDRcedJ40l4KuMlLH-Kjxs. Com o token em mãos agora você poderá utilizá-lo para realizar a autenticação na API.

Nota

Para executar os exemplos já fornecemos um token de teste para você, com ele você poderá executar os exemplos diretamente na linha de comando ou interface gráfica.

Criando o Token de Acesso - PRODUÇÃO

Para criar o token de acesso a API no ambiente de produção os passos são os mesmos que mostramos aqui para o ambiente sandbox. Porém, é fortemente recomendável que você utilize o ambiente de produção após experimentar, testar e homologar sua aplicação utilizando o ambiente sandbox, caso contrário, inconsistências e erros gerados em produção podem levar ao bloqueio total da sua conta Boleto Cloud.

---

Independência dos Ambientes

Importante

Os ambientes Sandbox e Produção são completamente independentes e não compartilham dados.

Isso significa que:

Aspecto	Comportamento
Cadastros	Beneficiários, contas bancárias e pagadores de um ambiente não existem no outro
Tokens	O token gerado no Sandbox não funciona em Produção (e vice-versa)
API Keys	Cada ambiente possui sua própria API Key
Boletos	Boletos criados no Sandbox não aparecem em Produção

Migração Sandbox → Produção

Após validar sua integração no Sandbox, você precisará replicar manualmente as configurações no ambiente de Produção:

1. Criar beneficiários
2. Cadastrar contas bancárias
3. Gerar novos tokens
4. Atualizar sua aplicação com as credenciais de produção

Evite retrabalho

O ideal é fazer todos os testes e ajustes no Sandbox primeiro. Só depois de homologar sua integração, replique as configurações em Produção.

---

Limitações do Sandbox

O ambiente Sandbox é destinado exclusivamente para desenvolvimento e testes. Algumas funcionalidades não estão disponíveis:

Funcionalidade	Sandbox	Produção
Geração de boletos	Sim	Sim
Exportação de arquivo CNAB	Sim	Sim
Registro online (API/Webservice bancário)	Não	Sim*
Integração via VAN	Não	Sim*
Envio automático de remessa	Não	Sim*

*Disponível no plano personalizado

Validação de CNAB

Se precisar validar o arquivo CNAB no sistema do banco, você pode exportar manualmente a remessa no Sandbox e importar no banco. Alternativamente, pode deixar essa validação para a Produção, já que os ambientes são independentes.