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

# Visão Geral da API

> Introdução à API RESTful do Sistema Promete

## API do Promete

A API do Promete é uma **API RESTful** que serve como camada de comunicação entre os clientes (frontend web e mobile) e o backend. Toda a lógica de negócio é acessada por meio desta API, garantindo consistência e desacoplamento entre as camadas.

## Base URL

```
https://api.promete.com.br/v1
```

<Warning>
  A URL base da API será definida conforme a configuração de infraestrutura e hospedagem. O endereço acima é ilustrativo.
</Warning>

## Formato

| Aspecto              | Padrão                   |
| -------------------- | ------------------------ |
| **Protocolo**        | HTTPS                    |
| **Formato de dados** | JSON                     |
| **Codificação**      | UTF-8                    |
| **Versionamento**    | Via URL (`/v1/`, `/v2/`) |
| **Documentação**     | OpenAPI 3.0 (Swagger)    |

## Organização

A API é organizada por módulos do sistema, refletindo a estrutura do modelo de domínio:

| Módulo             | Base Path            | Descrição                                    |
| ------------------ | -------------------- | -------------------------------------------- |
| **Relacionamento** | `/v1/relationships`  | Pessoas, organizações, territórios, vínculos |
| **Comunicação**    | `/v1/communications` | Mensagens, templates, disparos, notificações |
| **Gabinete**       | `/v1/cabinet`        | Demandas, tarefas, ações, deliberações       |
| **Prometrômetro**  | `/v1/promises`       | Promessas, metas, etapas, progresso          |
| **Monitoramento**  | `/v1/monitoring`     | Dashboards, indicadores, status              |
| **Webhooks**       | `/v1/webhooks`       | Eventos e integrações externas               |

<Info>
  A documentação detalhada dos endpoints será gerada automaticamente a partir da especificação OpenAPI (Swagger) do FastAPI conforme o desenvolvimento avançar.
</Info>