Guia de Integração API Creditas

1. Visão Geral do Processo

A integração acontece em duas fases: Staging (ambiente de teste/homologação) e Produção. A credencial de produção só é liberada após a validação bem-sucedida em staging.

O fluxo completo está ilustrado no diagrama abaixo.

2. O que você vai precisar

Antes de iniciar, garanta que as seguintes informações sejam disponibilizadas ao time Creditas:

Informação	Por que é necessária
E-mail do responsável técnico	É para este endereço que a credencial será enviada — confirme com atenção antes de repassar ao executivo de contas
CNPJ ou razão social da empresa como está no contrato de intermediação assinado com a Creditas	Para localizar o cadastro correto no sistema da Creditas

Atenção: a credencial é enviada uma única vez por e-mail. Em caso de perda, será necessário gerar uma nova chave — o que invalida a anterior. Confirme o e-mail do responsável técnico com antecedência.

3. Passo a Passo

3.1. Etapa 1 — Manifestar interesse

O parceiro sinaliza ao executivo de contas da Creditas o interesse em integrar via API. Essa comunicação pode acontecer em qualquer canal: reunião, e-mail ou mensagem.

3.2. Etapa 2 — Receber a documentação técnica

O executivo de contas encaminha o link da documentação oficial da API Creditas para o time técnico do parceiro.

É importante que esse link chegue diretamente ao responsável técnico — não ao contato comercial.

Documentação oficial da API: developers.creditas.com.br

A documentação cobre todos os endpoints disponíveis, autenticação, exemplos de requisição e as regras de envio de leads.

3.3. Etapa 3 — Confirmar que irá desenvolver

Após analisar a documentação, o parceiro confirma ao executivo de contas que deseja prosseguir com a integração. A partir dessa confirmação, o executivo inicia a geração das credenciais.

3.4. Etapa 4 — Receber a credencial de Staging

O executivo de contas gera a credencial de staging no sistema da Creditas. Assim que gerada, ela é enviada automaticamente por e-mail diretamente ao responsável técnico do parceiro.

Nenhum intermediário tem acesso à chave — nem o executivo de contas nem a Creditas retêm cópia.

O que fazer ao receber a credencial:

Verifique a caixa de entrada (e o spam, caso não encontre)
Utilize as chaves conforme descrito na documentação técnica
Não repasse as credenciais por e-mail ou mensagem — elas são de uso exclusivo do sistema integrador

3.5. Etapa 5 — Desenvolver e testar em Staging

Com a credencial em mãos, o time técnico implementa a integração no ambiente de staging e realiza os testes necessários.

O objetivo central desta etapa é validar o envio de leads para a Creditas. A integração considera concluída quando a for enviado 3 propostas sequenciais com sucesso em staging.

Caso haja erros, o parceiro deverá ajustar a implementação e retomar os testes até atingir a validação completa. Em caso de dúvidas técnicas durante esta fase, entre em contato com o executivo de contas.

3.6. Etapa 6 — Aprovação da Homologação

Quando o parceiro sinalizar a conclusão dos testes em staging, o executivo de contas verifica a homologação no sistema.

3 propostas validadas: integração aprovada, parceiro apto a subir para produção
Erros identificados: executivo compartilha o diagnóstico com o parceiro para ajustes

3.7. Etapa 7 — Receber a credencial de Produção

Após a aprovação da homologação, o executivo de contas gera a credencial de produção. Assim como em staging, ela é enviada automaticamente por e-mail ao responsável técnico do parceiro.

A credencial de produção é independente da de staging. Os dois ambientes coexistem e requerem chaves distintas.

3.8. Etapa 8 — Ativar em Produção

Com a credencial de produção recebida, o parceiro substitui as chaves no sistema integrador e ativa a integração em produção.

A partir desse momento, os leads enviados via API entram diretamente no fluxo da Creditas.

4. Perguntas Frequentes

O que fazer se o e-mail com a credencial não chegar? Verifique a caixa de spam. Se não encontrar, avise o executivo de contas para que uma nova credencial seja gerada com o e-mail correto confirmado.

É possível gerar a credencial novamente? Sim. O processo pode ser repetido a qualquer momento. A credencial anterior é invalidada automaticamente.

🚧
Atenção: será necessário atualizar as chaves em todos os sistemas onde a integração estiver ativa.

Posso ter credenciais de staging e produção ao mesmo tempo? Sim. São ambientes separados com credenciais distintas. A de produção só é liberada após a validação da homologação.

A credencial expira? As credenciais não têm prazo de validade definido, mas podem ser revogadas e regeneradas a qualquer momento por razões de segurança.

Onde encontro a documentação técnica completa da API? Em developers.creditas.com.br. A documentação é pública e cobre todos os casos de uso da integração.

Com quem falo em caso de dúvidas operacionais? Com o executivo de contas responsável pela sua conta na Creditas. Para problemas técnicos que persistam após a análise da documentação, o executivo pode acionar o time de produto internamente.

5. Resumo das Etapas

Etapa	Responsável	O que acontece
Manifestar interesse	Parceiro	Sinaliza interesse ao executivo de contas
Receber documentação	Executivo → Parceiro	Link da doc técnica encaminhado ao time técnico
Confirmar desenvolvimento	Parceiro	Time técnico confirma que irá integrar
Credencial de Staging	Executivo	Chave enviada por e-mail ao responsável técnico
Desenvolvimento e testes	Parceiro	Implementação e validação em staging
Homologação aprovada	Executivo	Verifica 3 linhas validadas na tabela
Credencial de Produção	Executivo	Chave enviada por e-mail ao responsável técnico
Ativação em Produção	Parceiro	Integração ativa com leads entrando no fluxo

Documentação da API: developers.creditas.com.br