Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.besimplo.com/llms.txt

Use this file to discover all available pages before exploring further.

A API Simplo usa chaves de API enviadas no header Authorization. Não há OAuth nem tokens de acesso curtos — uma chave por conta, válida até você revogar.

​
Formato

Authorization: ApiKey live_a1B2c3D4e5F6...
O prefixo no header é ApiKey (com espaço), não Bearer. Esse é o erro mais comum em integrações novas.

​
Tipos de chave

A própria chave começa com um prefixo que indica o ambiente:

Sandbox (teste)

Prefixo test_. Toda cobrança é simulada — nada é cobrado de verdade. Use no desenvolvimento e em CI.

Produção (live)

Prefixo live_. Cobrança real, com gateway real. Trate como senha.
A chave completa tem o formato {prefixo}_{token}, onde o token é uma sequência aleatória codificada em base62. Exemplo: live_3a7f9e2c1b5d8a4f....

​
Como gerar e revogar

1

Acesse o painel

Entre em besimplo.com e abra Configurações → Chaves de API.
2

Gere uma nova chave

Dê um nome descritivo (ex.: produção-backend, staging-app). A chave aparece uma única vez — copie e guarde.
3

Revogue chaves antigas

Quando trocar de servidor, vazar uma chave ou desligar uma integração, revogue. A revogação é imediata.

​
Onde guardar

Nunca comite chaves no Git. Use variáveis de ambiente ou um cofre de segredos.
# .env (não comite este arquivo)
SIMPLO_API_KEY=live_xxxxxxxxxxxxxxxx

# Ruby
api_key = ENV.fetch("SIMPLO_API_KEY")

// Node.js
const apiKey = process.env.SIMPLO_API_KEY;

​
Rate limits

A API limita requisições por chave de API para evitar abuso e manter estabilidade:
OperaçãoLimite
Criação (POST)10 por minuto
Leitura/atualização (GET, PATCH)100 por minuto
Quando você ultrapassa, recebe 429 Too Many Requests. Veja como tratar erros 429.

​
Vazei minha chave. E agora?

1

Revogue imediatamente

Painel → Configurações → Chaves de API → revogar.
2

Gere uma nova

Substitua a chave em todos os ambientes que dependem dela.
3

Audite o uso recente

Verifique no painel se houve atividade suspeita entre o vazamento e a revogação. Em caso de cobranças indevidas, fale com o suporte: team@besimplo.com.