Começando com a API CredPro
Conta, saldo, autenticação, limites e erros — o que vale para todas as APIs.
🚀 Quickstart
POST /v1/simulacoes com os dados do cliente e as credenciais de pelo menos um banco. A resposta chega na hora com um consulta_id — a simulação em si roda em segundo plano.
GET /v1/simulacoes/{consulta_id} a cada poucos segundos até que status deixe de ser processando. Cada banco costuma responder entre 10 e 60 segundos.
https://cred-pro.com — todos os endpoints ficam sob /v1. Cada API tem sua própria página: Simulação bancária e Veículo por placa + FIPE. O catálogo completo, com preços, está em /desenvolvedores/apis.
🔑 Autenticação
Toda chamada aos endpoints /v1/* exige sua chave de API no cabeçalho Authorization, no formato Bearer:
Authorization: Bearer cpk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
A chave começa sempre com cpk_live_. Ela é exibida uma única vez no momento em que você clica em "Gerar chave de API" — se perdê-la, gere uma nova (isso invalida a anterior imediatamente).
🧪 Sandbox — teste sem gastar e sem credencial de banco
No painel, ao lado da chave real, gere uma chave de teste (cpk_test_…). Ela usa os mesmos endpoints e o mesmo formato de resposta, mas nada chega aos bancos nem à consulta de placa: as respostas são fictícias, realistas e determinísticas, e nada é cobrado — não precisa nem de saldo. Toda resposta do sandbox vem com "sandbox": true.
Serve para integrar de ponta a ponta: validações, o polling da simulação (os bancos "respondem" escalonados entre 1,5 e 8 segundos), cada status possível e a montagem da sua tela. Quando estiver pronto, basta trocar a chave pela cpk_live_….
Como controlar o resultado
| Você manda | O sandbox devolve |
|---|---|
CPF terminado em 9 (ex.: 11111111119) | Todos os bancos aprovado, com parcelas. |
| CPF terminado em 0 | Todos os bancos recusado, com mensagem_recusa. |
| Qualquer outro CPF | Mistura fixa por banco: aprovado, recusado, simulação, credencial inválida e um em manutenção (pra você ver um status não cobrável). |
usuario: "invalido" em um banco | Esse banco volta credencial_invalida. |
Placa começando com ZZZ (ex.: ZZZ1A23) | Veículo não encontrado: 404 em /v1/veiculos, placa_nao_encontrada: true na simulação. |
| Qualquer outra placa válida | Um dos veículos de exemplo (Onix, Argo, T-Cross, CG 160, Corolla, HB20), sempre o mesmo para a mesma placa, com FIPE. |
Bancos, CPF, celular e placa continuam sendo validados como na produção (422 nos mesmos casos). Os limites de chamadas por minuto valem também. Consultas do sandbox aparecem no histórico do painel com a etiqueta 🧪.
curl -X POST https://cred-pro.com/v1/simulacoes \
-H "Authorization: Bearer cpk_test_SUA_CHAVE_DE_TESTE" \
-H "Content-Type: application/json" \
-d '{"cpf": "11111111119", "celular": "11999990000", "placa": "ABC1D23",
"bancos": {"PAN": {"usuario": "x", "senha": "x"}, "Itaú": {"usuario": "invalido", "senha": "x"}}}'
# → PAN aprovado com parcelas, Itaú credencial_invalida, "sandbox": true, nada cobrado
💰 Preços e saldo
Você recarrega um saldo em reais no painel (PIX ou cartão, mínimo R$ 50, não expira) e cada chamada desconta o preço do serviço. Sem plano, sem mensalidade, sem pacote: o preço é fixo e o mesmo para qualquer volume.
| Serviço | Preço | Cobra quando |
|---|---|---|
POST /v1/simulacoes | R$ 0,20 por banco que responde | o banco chega a processar: aprovado, recusado, simulação ou credencial inválida/restrição. Erro nosso, manutenção e fora do horário não cobram. |
GET /v1/veiculos/{placa} | R$ 0,12 por consulta | a resposta traz valor FIPE. Placa não encontrada, fora do padrão ou serviço fora do ar não cobram. |
GET /v1/bancos | grátis | nunca. |
Antes de rodar, a simulação exige saldo para o pior caso (custo_maximo = preço × bancos solicitados); se faltar, a resposta é 402 saldo_insuficiente com saldo_reais, necessario e preco_por_banco, e nada é cobrado. Depois, só desconta o que respondeu. O preço vigente sempre vem em GET /api/parceiros/servicos (público) e no painel.
⏱️ Limites de uso (rate limit)
Os limites protegem a capacidade dos bancos que rodam em infraestrutura mais restrita. Toda conta começa com 3 consultas simultâneas e 20 por minuto (os valores atuais da sua conta aparecem no painel e em GET /api/parceiros/me). Ao estourar, a API responde 429 com o cabeçalho Retry-After.
Precisa de mais capacidade? Fale com o suporte — os limites são ajustados por conta, sem custo, conforme o seu volume real.
🚫 Códigos de erro
Erros vêm sempre no formato {"detail": {"erro": {"codigo": "...", "mensagem": "..."}}}.
| HTTP | Código | Quando acontece |
|---|---|---|
| 401 | chave_invalida | Chave de API incorreta, revogada ou conta suspensa. |
| 402 | saldo_insuficiente | Saldo menor que o custo da chamada (na simulação, o pior caso custo_maximo). Vem com saldo_reais e necessario. Nada é cobrado; recarregue no painel. |
| 404 | consulta_nao_encontrada | consulta_id inexistente ou pertence a outra conta. |
| 404 | veiculo_nao_encontrado | A placa não retornou nenhum veículo em GET /v1/veiculos/{placa}. Não cobra. |
| 503 | consulta_indisponivel | O serviço de consulta de placa está fora do ar. Tente de novo em instantes. Não cobra. |
| 422 | banco_nao_suportado | Nome de banco fora da lista suportada. |
| 422 | dados_invalidos | Campo fora do formato: CPF sem 11 dígitos, celular sem DDD, tipo_veiculo desconhecido, banco repetido, banco sem usuário/senha, nenhum banco informado. |
| 422 | placa_invalida | Placa fora do padrão brasileiro (ABC1234 ou ABC1D23). |
| 422 | veiculo_obrigatorio | Sem placa e sem veiculo_marca/veiculo_modelo/veiculo_ano. A resposta lista em faltando quais faltaram. |
| 429 | limite_concorrencia | Você atingiu o limite de consultas simultâneas em andamento. |
| 429 | limite_taxa | Você atingiu o limite de consultas por minuto. Respeite o cabeçalho Retry-After. |
❓ Perguntas frequentes
Preciso ter minhas próprias credenciais em cada banco?
Sim. A API simula usando as credenciais que você (ou seu cliente lojista) já possui para logar diretamente nos sistemas de cada banco. A CredPro não fornece credenciais bancárias.
Quanto tempo demora até o resultado sair?
Cada banco responde entre 10 e 60 segundos, dependendo do banco e do horário. Bancos diferentes rodam em paralelo, então pedir 5 bancos não demora 5x mais que pedir 1.
Existe webhook para eu não precisar ficar consultando (polling)?
Ainda não — hoje o único jeito de saber quando a simulação terminou é consultando GET /v1/simulacoes/{id} periodicamente. Webhooks estão no roadmap; se for importante para o seu caso, fale com o suporte.
O saldo pode ficar negativo?
Não. A simulação só é aceita se o saldo cobrir o pior caso (todos os bancos solicitados respondendo); depois disso só desconta o que respondeu. Novas chamadas passam a retornar 402 saldo_insuficiente quando o saldo não cobre o custo.
Posso testar sem gastar de verdade?
Sim: gere uma chave de teste no painel e use o sandbox. Mesmos endpoints, respostas fictícias e determinísticas, nada cobrado. Quando quiser resultados reais dos bancos, recarregue a partir de R$ 50 e use a chave real.
Eu tinha créditos do modelo antigo. O que aconteceu com eles?
Foram convertidos automaticamente em saldo, a R$ 0,55 por crédito (o preço médio pago nos pacotes), e aparecem no extrato do painel como "Conversão dos créditos". Nada foi perdido.
Como entro em contato com o suporte?
Use o botão de WhatsApp flutuante em qualquer página do CredPro, ou fale diretamente com quem te atendeu no cadastro.