> ## Documentation Index
> Fetch the complete documentation index at: https://docs.patrimonion.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Visão Geral

> API REST para gestão completa de imóveis, contratos e locatários.

## O que é o Patrimonion?

O Patrimonion é uma plataforma SaaS multi-tenant para gestão imobiliária. Esta documentação cobre a API REST do backend — os endpoints disponíveis, os formatos de request/response e as regras de negócio que regem cada operação.

A API segue convenções REST padrão: recursos são identificados por URLs, ações por verbos HTTP e erros por status codes semânticos.

## Base URL

```
https://api.patrimonion.com.br
```

Todas as requisições devem ser feitas via HTTPS. Requisições em HTTP são redirecionadas automaticamente pelo Nginx.

## Autenticação

A API usa **Session Cookie** via Firebase Admin SDK. O login é feito via `POST /auth/login` — o backend seta o cookie `imob_session` automaticamente. Todas as requisições seguintes enviam o cookie via `credentials: "include"`, sem precisar de nenhum header manual.

<Info>
  Veja a seção [Autenticação](/autenticacao) para o fluxo completo, incluindo registro, recuperação de senha e verificação de e-mail.
</Info>

## Stack

| Camada       | Tecnologia            |
| ------------ | --------------------- |
| Runtime      | Node.js + Express     |
| Banco        | Firestore (NoSQL)     |
| Autenticação | Firebase Auth         |
| Storage      | MinIO (S3-compatible) |
| Logs         | Pino (via logger)     |

## Módulos disponíveis

<CardGroup cols={2}>
  <Card title="Imóveis" icon="building" href="/api-reference/imoveis">
    Cadastro, listagem e gestão de imóveis com suporte a fotos e vídeos.
  </Card>

  <Card title="Locatários" icon="users" href="/api-reference/locatarios">
    Cadastro completo de locatários com histórico de contratos.
  </Card>

  <Card title="Contratos" icon="file-contract" href="/api-reference/contratos">
    Ciclo de vida completo de contratos, incluindo rescisão.
  </Card>

  <Card title="Financeiro" icon="dollar-sign" href="/api-reference/financeiro">
    Parcelas, pagamentos parciais, controle de inadimplência.
  </Card>

  <Card title="Recibos" icon="receipt" href="/api-reference/recibos">
    Geração automática de recibos digitais por pagamento.
  </Card>

  <Card title="Inspeções" icon="clipboard-check" href="/api-reference/inspecoes">
    Vistorias de entrada, saída e rotina com snapshot de inventário.
  </Card>

  <Card title="Inventário" icon="boxes-stacked" href="/api-reference/inventario">
    Controle de itens do imóvel com soft delete e histórico.
  </Card>

  <Card title="Upload" icon="cloud-arrow-up" href="/api-reference/upload">
    Upload de mídias para MinIO com URLs pressinadas e seguras.
  </Card>
</CardGroup>