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

# Introdução

> Boas vindas à documentação do Webservice de Parceiros. Este espaço foi elaborado para fornecer informações sobre os endpoints disponíveis, como utilizá-los e exemplos de requisições e respostas.

<Note>
  Para fazer uso desta API você precisa estar habilitado como parceiro. Caso ainda não seja um parceiro, entre em contato com o suporte para obter mais informações.
</Note>

## Boas vindas

Bem vido(a) à documentação do **Webservice de Parceiros** da **Clubfix.** Os recursos aqui dispostos são suplementados com exemplos de respostas esperadas, para nortear a implementação. Caso haja algum empecilho ou erro não esperado, fique à vontade para chamar o suporte em TI pelos canais que você já conhece.

Observação: Utilize sempre os cabeçalhos `Content-Type` e `Accept` como `application/json`

#### **URL Base**

| **Ambiente** | **URL**                                                                                |
| ------------ | -------------------------------------------------------------------------------------- |
| Homologação  | [https://homolog.clubfix.com.br/webservice](https://homolog.clubfix.com.br/webservice) |
| Produção     | [https://clubfix.com.br/webservice](https://clubfix.com.br/webservice)                 |

> NOTA: Para conseguir utilizar ambos ambientes, faz-se necessário solicitar pelo nosso time de suporte a geração das credenciais mencionadas na página de **[Autenticação](/api-reference/auth)**.

#### Paginação

Para navegar nos recursos de listagem através de suas páginas, utilize as `parâmeros` dispostas na tabela abaixo

| **Parâmetro** | **Descrição**                                              |
| ------------- | ---------------------------------------------------------- |
| page          | Corresponde à pagina que você deseja exibir os dados.      |
| per\_page     | Altera a quantidade de itens devolvidos em uma requisição. |
| current\_page | Identifica a pagina correspondente àquela requisição.      |

### **Conhecendo os erros comuns**

| **Status Code** | **Descrição**                                                                                                                                                                   |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 422             | Erro em algum parâmetro fornecido. O resultado deste erro será um objeto, onde a sua chave indicará o campo que não está em conformidade.                                       |
| 401             | Não autorizado. Significa que há ausência de um token válido na requisição, seja por expiração, não fornecimento, ou, no caso do login, as suas credenciais não estão corretas. |
| 5\*\*           | Erro de servidor no endpoint requisitado. Quando isso ocorrer, contate o nosso suporte.                                                                                         |