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

# Visão Geral da API

> Informações gerais sobre a API PIED

## Base URLs

A API PIED está disponível em duas versões:

**API v2 (Recomendada):**

```
https://backend-pied-prod.piedadmin.com.br/api/v2
```

**API v1:**

```
https://backend-pied-prod.piedadmin.com.br/api/v1
```

## Autenticação

Todas as requisições requerem autenticação via Bearer Token:

```
Authorization: Bearer SEU_TOKEN_AQUI
```

## Formato de Dados

* **Request**: JSON com `Content-Type: application/json`
* **Response**: JSON com dados estruturados
* **Encoding**: UTF-8

## Códigos de Status HTTP

| Código | Significado                    |
| ------ | ------------------------------ |
| `200`  | Sucesso - dados retornados     |
| `204`  | Sucesso - nenhum conteúdo      |
| `400`  | Erro na requisição             |
| `401`  | Não autorizado                 |
| `404`  | Recurso não encontrado         |
| `429`  | Limite de requisições excedido |
| `500`  | Erro interno do servidor       |

## Paginação

Endpoints que retornam listas usam paginação baseada em página:

```
GET /requests/budget/{pageNumber}/{pageLimit}
```

### Parâmetros

* `pageNumber`: Número da página (inicia em 1)
* `pageLimit`: Itens por página (máximo 50)

### Resposta

```json theme={null}
{
  "data": [...],
  "totalItems": 340  
}
```

## Rate Limiting

A API implementa limites de uso:

* **600 requisições por hora geral**
* **1 minuto de processamento por hora**

Quando excedido, retorna erro `429` e a API será desativada. Para reativar, entre em contato com suporte

## Filtros de Data

Muitos endpoints aceitam filtros de data no formato `YYYY-MM-DD`:

* `createdAfter`: Registros criados após esta data
* `createdBefore`: Registros criados antes desta data
* `lastUpdateAfter`: Registros atualizados após esta data
* `lastUpdateBefore`: Registros atualizados antes desta data

## Recursos Disponíveis

<CardGroup cols={2}>
  <Card title="Requests" icon="file-invoice">
    Consulta e atualização de orçamentos e pedidos (v2 e v1)
  </Card>

  <Card title="Empresas" icon="building">
    Criação (v2) e consulta (v1) de empresas parceiras
  </Card>

  <Card title="Equipamentos" icon="solar-panel">
    Consulta de catálogo (v2), atualização de preços (v2) e estoque (v1)
  </Card>

  <Card title="Colaboradores" icon="users">
    Consulta de dados de colaboradores (v1)
  </Card>

  <Card title="Campos Customizados" icon="sliders">
    Consulta e atualização de campos customizados (v2)
  </Card>
</CardGroup>

## Versionamento

Esta documentação unificada apresenta endpoints de ambas as versões da API:

* **🚀 v2 (Recomendada)**: Versão principal com melhor performance e novos recursos
* **v1**: Mantém endpoints específicos para casos de uso que não necessitam das melhorias da v2

<Info>
  **Identificação de versão:** Cada endpoint indica claramente qual versão da API ele pertence. Use endpoints v2 sempre que possível para novos projetos.
</Info>

## Suporte

Para dúvidas técnicas ou problemas:

* **Email**: [suporte@pieta.tech](mailto:suporte@pieta.tech)
* **Documentação**: Esta documentação interativa
* **Status**: Monitore o status da API em tempo real