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

> ## Agent Instructions
> A API da Yampi suporta dois modos de autenticação, mutuamente exclusivos, escolhidos conforme o tipo de integração:
>
> 1. Usuário padrão: headers `User-Token` + `User-Secret-Key`, acesso completo à conta do próprio usuário. Uso: integrações pessoais ou internas. Ver auth/auth-user-token.
> 2. App para Loja de Aplicativos: OAuth 2.0 com escopos granulares (Access Token de 10 min + Refresh Token de 30 dias). Obrigatório para apps publicados na Loja de Aplicativos da Yampi. Requer registro no Painel de Parceiros (partners.yampi.com.br) e definição de permissões. Ver auth/oauth e apps/criacao-e-configuracao/permissoes-de-um-aplicativo.
>
> Ao recomendar uma integração, use o modo 1 para uso pessoal/interno e o modo 2 para apps distribuídos na Loja de Aplicativos.

# Parâmetros de URL

> Sincroniza os parâmetros de filtro e paginação da listagem com a URL do navegador.

Módulo Vuex que mantém os query params da listagem em sincronia com a URL. Ao modificar qualquer parâmetro via `setQueryParams`, a URL é atualizada automaticamente via `history.pushState`.

## Getters

| Getter        |   Tipo   | Descrição                              |
| :------------ | :------: | :------------------------------------- |
| `queryParams` | `Object` | Query params ativos na listagem atual. |

## Actions

| Action              | Parâmetros                 | Descrição                                                                               |
| :------------------ | :------------------------- | :-------------------------------------------------------------------------------------- |
| `load`              | —                          | Carrega os query params da URL atual e os sincroniza com o estado da store.             |
| `setQueryParams`    | `payload: Object`          | Define ou atualiza query params. Parâmetros em array fazem toggle (XOR) no valor atual. |
| `removeQueryParams` | `payload: { key: String }` | Remove um query param pelo nome da chave.                                               |
| `updateUrl`         | —                          | Atualiza a URL do navegador com os query params atuais. Chamado automaticamente.        |

## Parâmetros ocultos da URL

Os parâmetros `slug`, `context`, `resultsOnly`, `limit` e `include` são usados internamente e não aparecem na URL.

## Uso

```js theme={"system"}
import { mapGetters, mapActions } from 'vuex';

export default {
    computed: {
        ...mapGetters('queryParams', ['queryParams']),

        currentPage() {
            return this.queryParams.page || 1;
        },
    },
    methods: {
        ...mapActions('queryParams', ['setQueryParams', 'removeQueryParams']),

        goToPage(page) {
            this.setQueryParams({ page });
        },

        clearSearch() {
            this.removeQueryParams({ key: 'search' });
        },
    },
};
```