API REST v1
Integração para construtoras e incorporadoras
Última atualização: 29 de junho de 2026
A API REST v1 da Conecta Lar é a vantagem exclusiva de integração da nossa PropTech: conecte seu ERP, CRM ou portal de vendas ao Fundo Mutualista Imobiliário em poucas chamadas HTTP — com OAuth 2.0, webhooks assinados e ambiente de sandbox.
Visão geral
- Base URL:
https://api.conectalar.tech/v1 - Sandbox:
https://sandbox.api.conectalar.tech/v1 - Formato: JSON (UTF-8), datas em ISO 8601, valores em BRL (centavos quando sufixados por
_centavos). - Versionamento: via prefixo de path (
/v1,/v2). Mudanças incompatíveis não entram em v1.
Autenticação — OAuth 2.0 (client credentials)
Cada construtora recebe um par client_id / client_secret no painel do plano SaaS. Troque por um access_token de curta duração (1h) e use no header Authorization: Bearer.
curl -X POST https://api.conectalar.tech/oauth/token \
-H "Content-Type: application/json" \
-d '{
"grant_type": "client_credentials",
"client_id": "cli_01H...",
"client_secret": "sk_live_...",
"scope": "grupos:write cotas:write pagamentos:read"
}'Escopos disponíveis
grupos:read/grupos:writecotas:read/cotas:writepagamentos:read/pagamentos:writeentregas:read/entregas:writewebhooks:manage
Limites e idempotência
- Rate limit: 600 req/min por plano Growth, 2.000 req/min no Scale, sob acordo no Enterprise.
- Idempotência: envie
Idempotency-Keyem todoPOST— chaves duplicadas retornam a mesma resposta por 24h. - Paginação:
?cursor=...&limit=50(máx. 200).
Grupos & Empreendimentos
Base: /v1/grupos
/v1/gruposgrupos:readLista os grupos mutualistas da sua construtora (paginado).
/v1/gruposgrupos:writeCria um novo grupo vinculado a um empreendimento.
curl -X POST https://api.conectalar.tech/v1/grupos \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"empreendimento_id": "emp_01H...",
"nome": "Residencial Aurora",
"cotas_totais": 120,
"valor_unidade_brl": 320000,
"prazo_meses": 96
}'/v1/grupos/{id}grupos:readDetalha um grupo, com cotas vendidas e status de obra.
/v1/grupos/{id}grupos:writeAtualiza dados editáveis do grupo (nome, status, cronograma).
Cotas & Associados
Base: /v1/cotas
/v1/cotascotas:writeCria uma cota e dispara o convite digital ao associado.
curl -X POST https://api.conectalar.tech/v1/cotas \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"grupo_id": "grp_01H...",
"associado": {
"nome": "Maria Silva",
"cpf": "000.000.000-00",
"email": "maria@exemplo.com.br"
},
"valor_mensal_brl": 1490
}'/v1/cotas/{id}cotas:readRetorna a cota, o associado e o status de adesão.
/v1/associados/{cpf}/cotascotas:readLista todas as cotas de um associado por CPF.
Pagamentos (Asaas)
Base: /v1/pagamentos
/v1/cotas/{id}/pagamentospagamentos:readHistórico de mensalidades, com status, meio (Pix/boleto/cartão) e comprovante.
/v1/cotas/{id}/pagamentos/cobrancapagamentos:writeGera uma cobrança avulsa (ex.: taxa de adesão).
Entregas
Base: /v1/entregas
/v1/grupos/{id}/entregasentregas:writeRegistra a entrega da unidade e dispara a taxa de administração (1,5%–2,5%).
/v1/entregas/{id}entregas:readDetalha a entrega, taxa cobrada e status de alienação fiduciária.
Webhooks
Configure uma URL HTTPS no painel para receber eventos. Cada requisição traz o header X-ConectaLar-Signature com HMAC-SHA256 do corpo cru, assinado pelo seu webhook_secret. Verifique sempre com comparação timing-safe antes de processar.
| Evento | Quando dispara |
|---|---|
| cota.aderida | Associado completou a assinatura eletrônica. |
| pagamento.pago | Mensalidade compensada na Asaas. |
| pagamento.atrasado | Boleto/Pix vencidos sem pagamento. |
| entrega.realizada | Unidade entregue e taxa lançada. |
| cota.inadimplencia.consolidada | Consolidação fiduciária iniciada (Lei 9.514/97, art. 26). |
Códigos de erro
400— payload inválido (detalhes emerror.fields).401— token ausente, expirado ou escopo insuficiente.404— recurso não existe ou não pertence à sua construtora.409— conflito de idempotência ou regra de negócio.422— violação de regra mutualista (ex.: grupo com cotas esgotadas).429— rate limit atingido.5xx— incidente do nosso lado; consultestatus.conectalar.tech.
Conformidade
Toda chamada à API é registrada em trilha de auditoria imutável, atendendo LGPD (Lei 13.709/18), MP 2.200-2/2001 (assinaturas eletrônicas) e às regras de PLD/FT aplicáveis à Asaas como instituição de pagamento autorizada pelo Banco Central.
Alfatech Prestadora de Serviços Administrativos e Digitais Ltda. — CNPJ 47.549.559/0001-39 — Sinop/MT. Parceira BaaS da Asaas — instituição de pagamento autorizada pelo Banco Central do Brasil.
