# API: Defaults

---

- [Introducao](#introducao)
- [Headers Default](#headers_default)
- [Index e Show Queries](#resource_queries)

<a name="introducao"></a>
## Introdução

Esta página documenta padrões da API

<a name="headers_default"></a>
## Headers Default

```json
Accept: application/json
Accept-Language: <lang>
Bearer: <token> (Rotas autenticadas e não SPA)
X-Timezone: <timezone>
```

<a name="resource_queries"></a>
## Index e Show Queries

As rotas index e show seguem um padrão flexível de query parameters que permitem filtros dinâmicos, ordenação, paginação e carregamento de relacionamentos. Abaixo, os parâmetros aceitos:


| Parâmetro|Descrição|Exemplo|
|:|:-|:|
| `relationships[]`| Especifica os relacionamentos a serem carregados, permitindo acesso a dados relacionados.| `relationships[]=addresses&relationships[]=phones&relationships[]=produtos.ativos` |
| `cursor`| Indica a posição no cursor para navegação entre resultados (paginação baseada em cursor).||
| `page`| Define a página a ser retornada (paginação baseada em páginas).||
| `per_page`| Determina o número de itens por página.||
| `sort[<column>]`| Ordena os resultados com base em um ou mais campos.| `sort[nome]=desc` |
| `filter[<column>]`| Aplica filtros diretos aos campos da entidade.| `filter[empresa_id]=1&filter[nome]=Tod` |
| `filter_between_from[<column>]`| Define o valor inicial de um intervalo para filtros entre datas ou valores numéricos.| `filter_between_from[created_at]=2024-02-11` |
| `filter_between_to[<column>]`| Define o valor final de um intervalo para filtros entre datas ou valores numéricos.| `filter_between_to[created_at]=2024-11-12` |

\* Por padrão os endpoints mapeados de controllers que extendem ```App\Http\Controllers\ResourceApiController```, já implementam as query parameters apresentadas.