---
updatedAt: 2026-05-05T21:15:20.000Z
agentTools:
  projectIndex: https://developers.creditas.com.br/llms.txt
---

# Guia de Integração API Creditas

Este documento explica o processo completo de integração com a API da Creditas — do primeiro contato até a ativação em produção. Foi feito para o time técnico do parceiro acompanhar cada etapa com clareza.

## 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.

![](https://files.readme.io/d3ea1c31ce4d9d58a016e6e082b02659da780c56197a90ef4e69dd335210952b-image.png)

<br />

***

## 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](https://developers.creditas.com.br/docs/new-visão-geral-da-api)

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](https://developers.creditas.com.br/docs/new-ambientes-credenciais-e-autentica%C3%A7%C3%A3o)
* 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.

<Callout icon="🚧">
  Atenção: será necessário atualizar as chaves em todos os sistemas onde a integração estiver ativa.
</Callout>

**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](https://developers.creditas.com.br/docs/new-visão-geral-da-api). 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

<Table>
  <thead>
    <tr>
      <th>
        Etapa
      </th>

      <th>
        Responsável
      </th>

      <th>
        O que acontece
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        1. Manifestar interesse
      </td>

      <td>
        Parceiro
      </td>

      <td>
        Sinaliza interesse ao executivo de contas
      </td>
    </tr>

    <tr>
      <td>
        2. Receber documentação
      </td>

      <td>
        Executivo → Parceiro
      </td>

      <td>
        Link da doc técnica encaminhado ao time técnico
      </td>
    </tr>

    <tr>
      <td>
        3. Confirmar desenvolvimento
      </td>

      <td>
        Parceiro
      </td>

      <td>
        Time técnico confirma que irá integrar
      </td>
    </tr>

    <tr>
      <td>
        4. Credencial de Staging
      </td>

      <td>
        Executivo
      </td>

      <td>
        Chave enviada por e-mail ao responsável técnico
      </td>
    </tr>

    <tr>
      <td>
        5. Desenvolvimento e testes
      </td>

      <td>
        Parceiro
      </td>

      <td>
        Implementação e validação em staging
      </td>
    </tr>

    <tr>
      <td>
        6. Homologação aprovada
      </td>

      <td>
        Executivo
      </td>

      <td>
        Verifica 3 linhas validadas na tabela
      </td>
    </tr>

    <tr>
      <td>
        7. Credencial de Produção
      </td>

      <td>
        Executivo
      </td>

      <td>
        Chave enviada por e-mail ao responsável técnico
      </td>
    </tr>

    <tr>
      <td>
        8. Ativação em Produção
      </td>

      <td>
        Parceiro
      </td>

      <td>
        Integração ativa com leads entrando no fluxo
      </td>
    </tr>
  </tbody>
</Table>

***

*Documentação da API: [developers.creditas.com.br](https://developers.creditas.com.br/docs/new-visão-geral-da-api)*