> For the complete documentation index, see [llms.txt](https://docs.supria.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.supria.com/devs/api-de-consulta/visao-geral.md).

# Visão geral

A API de Consulta é a API de leitura de dados do Supria Workspaces. Hoje ela é a única API disponível: não existem endpoints de escrita (criar, editar ou excluir dados são feitos hoje pela própria plataforma, não pela API).

* **GET** — consultar dados.
* **POST** — não disponível (criar recursos).
* **PUT** — não disponível (atualizar recursos).
* **DELETE** — não disponível (excluir recursos).

Ela segue o padrão OData v4, e não o formato de API REST "sob medida" que costuma existir por aí. Na prática, isso muda como você pede os dados: ao invés de existir um endpoint específico para cada combinação de filtro ou campo, cada entidade (Projeto, Tarefa de cronograma, Recurso etc.) expõe uma coleção única, e é você quem escolhe o que quer receber usando parâmetros padronizados de consulta — filtrar, escolher campos, ordenar, paginar e expandir relacionamentos. O detalhe de como usar cada parâmetro está em Como consultar dados.

Na prática, o cliente autentica com uma API Key por tenant (veja Primeiros passos) e faz chamadas GET para os endpoints que precisar, combinando os parâmetros de consulta na URL. É esse formato que torna a API adequada para alimentar ferramentas de BI e análise, como Power BI ou Qlik Sense: você extrai só o recorte de dados que precisa, no formato que já espera consumir.

### Como a API está organizada

As três seções a seguir organizam as entidades da API de Consulta por área:

* API de Projetos — cadastro dos projetos, sua classificação e o histórico de aprovações.
* API de Cronograma — as tarefas, fases e versões do cronograma de cada projeto.
* API de Recursos — pessoas, equipamentos e materiais que podem ser alocados aos projetos.