General FAQ
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.
Como a API foi projetada?▼
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.
Quais formatos de dados são suportados?▼
A API CredAluga trabalha exclusivamente com JSON para requisições e respostas. Todas as chamadas devem incluir o header Content-Type: application/json.
Existe um ambiente de testes?▼
Sim, disponibilizamos um ambiente sandbox para testes. Use a URL base https://middleware.homolog.credaluga.com.br com suas credenciais de teste para validar sua integração antes de ir para produção.