Bem-vindo à API de Middleware da CredAluga

Esta documentação fornece todos os recursos que você precisa para integrar seu sistema (ERP, CRM ou plataforma própria) com o ecossistema da CredAluga.

Nossa API foi projetada para ser RESTful, previsível e fácil de usar. Ela retorna respostas em formato JSON e utiliza os códigos de status HTTP padrão para sinalizar os resultados das operações.

O que é o Middleware CredAluga?

O Middleware é a ponte que conecta as plataformas dos nossos parceiros (imobiliárias, ERPs, CRMs) aos serviços de fiança locatícia da CredAluga. Através desta API, você pode:

• Gerenciar Parceiros e Imobiliárias: Cadastrar e consultar parceiros e imobiliárias no nosso sistema.
• Realizar Simulações: Criar simulações de fiança locatícia, tanto de forma simplificada quanto completa.
• Gerenciar Propostas: Enviar e consultar o status de propostas de aluguel.
• Acompanhar Ativações: Seguir o processo de ativação da fiança.
• Configurar Webhooks: Receber notificações em tempo real sobre o andamento dos processos.

Primeiros Passos

Autenticação

Todas as requisições à API devem ser autenticadas. A autenticação é feita através de uma chave de API (ApiKey) que deve ser enviada no cabeçalho (header) de cada requisição.

Authentication

API Key: ApiKey

Api Key Authentication

Tipo de Esquema de Segurança:	apiKey
Nome do parâmetro no Header:	ApiKey

Você deve incluir o cabeçalho ApiKey em todas as suas chamadas.

ApiKey: SUA_CHAVE_DE_API

Não tenho uma ApiKey

Para obter sua chave de API, entre em contato com nossa equipe de suporte através do email suporte@credaluga.com.br.

Ambientes

Oferecemos um ambiente para integração:

• Homologação: https://middleware.homolog.credaluga.com.br

O ambiente de Homologação deve ser usado para validar a integração completa antes de ir para produção.

Próximos Passos

Recomendamos que você explore os seguintes tópicos para entender melhor o fluxo de integração:

• Fluxo de Simulação: Entenda como criar uma simulação e obter os planos disponíveis.
• Criação de Proposta: Aprenda a converter uma simulação em uma proposta formal.
• Webhooks: Configure seus endpoints para receber atualizações de status.

Navegue pela barra lateral para ver todos os endpoints disponíveis, agrupados por recurso.

Contato

CredAluga Support Team: suporte@credaluga.com.br

URL: https://credaluga.com.br/