Em uma frase
A API da Credicarro é REST, autenticada por Bearer token, com campos JSON em português e o mesmo formato de resposta em toda a superfície — um cliente HTTP e um token já bastam para integrar.Não é a página de referência de endpoints
Esta página explica os conceitos que atravessam toda a API. Para o contrato de cada endpoint, use as abas Autenticação, Proposta e Webhooks, as convenções da API ou o arquivo OpenAPI.
Ambientes
O ambiente é determinado pela URL base que você chama — as credenciais (
ClientId/ClientSecret) são específicas de cada ambiente.
Autenticação
Toda requisição autenticada usa um Bearer token, obtido viaClientId/ClientSecret solicitados ao nosso suporte.
Fluxo completo de autenticação
Veja a resposta completa e as boas práticas de segurança.
Formato das respostas
Os campos JSON são em português. Listas paginadas seguem sempre o mesmo formato:Erros
As respostas de erro trazem os campostipo (código estável do erro), titulo, status e detalhe. Quando o erro é de um campo, vem também campo. As exceções são o 401, que vem sem corpo, e falhas inesperadas, que podem vir no formato padrão Problem Details.
Formato completo de erro e Idempotency-Key
Veja o formato de erro, os status HTTP e o reenvio seguro de operações.
Idempotência
As rotas de cliente, simulação, proposta e documento aceitam o cabeçalhoIdempotency-Key: reenviar a mesma chave com o mesmo corpo retorna o resultado original em vez de repetir a operação. No envio de documentos o cabeçalho é obrigatório.
Troubleshooting
404 em uma proposta que existe
404 em uma proposta que existe
A proposta pode pertencer a outro parceiro, ou o token pode ser de outro ambiente (staging x produção).
409 Conflict em POST
409 Conflict em POST
Uma
Idempotency-Key já usada com um corpo diferente. Gere uma nova chave para uma nova operação — veja Erros e idempotência.404 ou 422 na simulação
404 ou 422 na simulação
404 (Store.Integration.NotFound): o cnpjLoja não existe ou não está vinculado ao seu cadastro de parceiro. 422 (Store.Integration.Intermediation): a loja tem contrato de intermediação e não pode ser usada na integração.Boas práticas de segurança
- Armazene
ClientId/ClientSecretem variáveis de ambiente ou um gerenciador de segredos — nunca no código-fonte - Nunca exponha o
ClientSecretem código client-side (app mobile, SPA) - A Credicarro nunca solicita suas credenciais por e-mail ou telefone
Por onde continuar
Fluxo da proposta
A ordem de chamadas do início ao fim.
Guia de financiamento
Todas as chamadas de um financiamento, com exemplos.
Guia de refinanciamento
Inclui a conta de recebimento.
Envio de documentos
Base64, idempotência e correção.
Etapas e status
O significado de cada código da proposta.
Webhooks
Notificações em tempo real sobre a proposta.