### Authentication Header Example

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index_2b99f895-d9ae-473d-a03e-11d845e4e3df

Example of the Authorization header required for API authentication. It uses the 'Basic' scheme followed by the encoded username and password.

```http
Authorization: Basic ABCDefgh1j2LM4NoPqRSTuVwXYZ=
```

--------------------------------

### Paginated Response Example

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index_2b99f895-d9ae-473d-a03e-11d845e4e3df

An example of a paginated response from the API, including 'paginacao' details and a 'dados' array containing the records for the current page.

```json
{
  "paginacao": {
    "pagina_atual": 0,
    "total_pagina_atual": 2,
    "total_por_pagina": 20,
    "total": 2,
    "total_de_paginas": 1
  },
  "dados": [
    {
      "id": 1,
      "nome": "Exemplo A"
    },
    {
      "id": 2,
      "nome": "Exemplo B"
    }
  ]
}
```

--------------------------------

### Accept Header for Response Format

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index_2b99f895-d9ae-473d-a03e-11d845e4e3df

Examples of the 'Accept' header to specify the desired response format. Requests can specify either JSON or XML.

```bash
codeAccept: application/json
```

```bash
codeAccept: application/xml
```

--------------------------------

### Request Parameters for Pagination

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index_2b99f895-d9ae-473d-a03e-11d845e4e3df

Example of query parameters used for pagination in API requests. 'pagina' specifies the page number (starting from 0), and 'limite' sets the number of records per page (max 500).

```text
GET /endpoint?pagina=0&limite=20
```

--------------------------------

### GET /api/public/v1/configuracoes

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index_2b99f895-d9ae-473d-a03e-11d845e4e3df

Retrieves module configurations for a given module ID. This endpoint is used to fetch settings related to specific modules within the system.

```APIDOC
## GET /api/public/v1/configuracoes

### Description
Retrieves module configurations for a given module ID. This endpoint is used to fetch settings related to specific modules within the system.

### Method
GET

### Endpoint
/api/public/v1/configuracoes

### Parameters
#### Query Parameters
- **idmodulo** (string) - Required - The ID of the module to retrieve configurations for.

### Request Example
```json
{
  "example": "GET /api/public/v1/configuracoes?idmodulo=15"
}
```

### Response
#### Success Response (200)
This endpoint does not return a response body.

#### Response Example
```json
{
  "example": "No response body"
}
```
```

--------------------------------

### Authentication Error Response Example

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index_2b99f895-d9ae-473d-a03e-11d845e4e3df

An example of an error response when authentication fails due to an absent, malformed, or invalid API key. This results in a 401 Unauthorized HTTP status code.

```json
{
    "erro": {
        "codigo": 14,
        "mensagem": "Usuário não possui acesso ou não cadastrado.",
        "detalhes": "Usuário não possui acesso ou não cadastrado."
    }
}
```

--------------------------------

### GET Busca Dados - Cadastro

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index_2b99f895-d9ae-473d-a03e-11d845e4e3df

Busca dados associados a um módulo específico. Requer o parâmetro 'idmodulo'. Utiliza autenticação Basic Auth. Certifique-se de que o 'idmodulo' esteja correto e que o sistema esteja ativo para evitar erros 404.

```curl
curl --location 'https://seusistema.iilex.com.br/api/public/v1/dados?idmodulo=15'
```

--------------------------------

### GET /api/public/v1/dados

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index_2b99f895-d9ae-473d-a03e-11d845e4e3df

Retrieves data for a given module ID. This endpoint is used to fetch records associated with a specific module.

```APIDOC
## GET /api/public/v1/dados

### Description
Retrieves data for a given module ID. This endpoint is used to fetch records associated with a specific module.

### Method
GET

### Endpoint
/api/public/v1/dados

### Parameters
#### Query Parameters
- **idmodulo** (string) - Required - The ID of the module to retrieve data for.

### Request Example
```json
{
  "example": "GET /api/public/v1/dados?idmodulo=15"
}
```

### Response
#### Success Response (200)
This endpoint does not return a response body.

#### Response Example
```json
{
  "example": "No response body"
}
```
```

--------------------------------

### GET Busca Módulos - Cadastro

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index_2b99f895-d9ae-473d-a03e-11d845e4e3df

Busca módulos relacionados ao cadastro. Requer o parâmetro 'idmodulo'. Utiliza autenticação Basic Auth. A requisição pode falhar se o módulo não for encontrado ou se houver erros de banco de dados.

```curl
curl --location 'https://seusistema.iilex.com.br/api/public/v1/configuracoes?idmodulo=15'
```

--------------------------------

### Autenticação do V1

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index_2b99f895-d9ae-473d-a03e-11d845e4e3df

Para realizar buscas através da API, é necessário se autenticar. A autenticação é feita através do header 'Authorization' utilizando o esquema 'Basic', seguido pelo nome de usuário e senha.

```APIDOC
## Autenticação do V1

### Description
Para fazer buscas, é necessário autenticar-se enviando o header `Authorization` com o esquema `Basic` e fornecendo o nome de usuário e senha.

### Method
N/A (Header)

### Endpoint
N/A (Header)

### Parameters
#### Headers
- **Authorization** (string) - Required - O esquema `Basic` seguido do nome de usuário e senha codificados em base64.

### Request Example
```
Authorization: Basic ABCDefgh1j2LM4NoPqRSTuVwXYZ=
```

### Response
#### Error Response (401)
- **erro.codigo** (integer) - Código do erro de autenticação.
- **erro.mensagem** (string) - Mensagem descrevendo o erro de autenticação.
- **erro.detalhes** (string) - Detalhes adicionais sobre o erro de autenticação.

#### Response Example
```json
{
    "erro": {
        "codigo": 14,
        "mensagem": "Usuário não possui acesso ou não cadastrado.",
        "detalhes": "Usuário não possui acesso ou não cadastrado."
    }
}
```
```

--------------------------------

### Rate e Limites de Uso e Paginação

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index_2b99f895-d9ae-473d-a03e-11d845e4e3df

A API possui limites de requisição (60 por minuto) e utiliza paginação para retornar os resultados. Os parâmetros 'pagina' e 'limite' controlam a paginação.

```APIDOC
## Rate e Limites de Uso e Paginação

### Description
A API possui um limite de 60 requisições por minuto por usuário/chave de API. Para gerenciar grandes volumes de dados, todos os resultados são paginados. Use os parâmetros `pagina` e `limite` para controlar a quantidade de registros retornados.

### Method
GET

### Endpoint
`/endpoint` (exemplo)

### Parameters
#### Query Parameters
- **pagina** (integer) - Optional - O número da página desejada (começa em 0).
- **limite** (integer) - Optional - A quantidade de registros por página. O limite máximo é 500.

### Request Example
```
GET /endpoint?pagina=0&limite=20
```

### Response
#### Success Response (200)
- **paginacao** (object) - Informações sobre a paginação.
  - **pagina_atual** (integer) - O número da página retornada (inicia em 0).
  - **total_pagina_atual** (integer) - A quantidade de registros retornados na página atual.
  - **total_por_pagina** (integer) - O limite definido na requisição (`limite`).
  - **total** (integer) - A quantidade total de registros encontrados na consulta.
  - **total_de_paginas** (integer) - O número total de páginas disponíveis.
- **dados** (array) - Um array contendo os registros retornados na página atual.

#### Response Example
```json
{
  "paginacao": {
    "pagina_atual": 0,
    "total_pagina_atual": 2,
    "total_por_pagina": 20,
    "total": 2,
    "total_de_paginas": 1
  },
  "dados": [
    {
      "id": 1,
      "nome": "Exemplo A"
    },
    {
      "id": 2,
      "nome": "Exemplo B"
    }
  ]
}
```

#### Error Response (429)
- Código de status HTTP 429 Too Many Requests se os limites de taxa forem excedidos.
```

--------------------------------

### Formato de Resposta

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index_2b99f895-d9ae-473d-a03e-11d845e4e3df

A API pode retornar dados em formato JSON ou XML. O formato desejado deve ser especificado no header 'Accept' da requisição.

```APIDOC
## Formato de Resposta

### Description
Todos os retornos são feitos em JSON ou XML, dependendo do valor do header `Accept` enviado na requisição. Utilize o header como desejar para especificar o formato de resposta.

### Method
N/A (Header)

### Endpoint
N/A (Header)

### Parameters
#### Headers
- **Accept** (string) - Optional - Especifica o formato de resposta desejado. Pode ser `application/json` ou `application/xml`.

### Request Example
```bash
Accept: application/json
```

```bash
Accept: application/xml
```

### Response
O formato da resposta dependerá do valor enviado no header `Accept`. Se não especificado, o padrão é JSON.
```

--------------------------------

### Authentication (V1)

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index

To perform searches, you must authenticate by sending the 'Authorization' header with the 'Basic' scheme, providing your username and password.

```APIDOC
## Authentication (V1)

### Description
Authenticates users for API access using Basic Authentication.

### Method
N/A (Header based)

### Endpoint
N/A (Header based)

### Parameters
#### Request Headers
- **Authorization** (string) - Required - The authentication token in the format 'Basic <base64_encoded_credentials>'.

### Request Example
```
Authorization: Basic ABCDefgh1j2LM4NoPqRSTuVwXYZ=
```

### Response
#### Error Response (401)
- **error.codigo** (integer) - Error code indicating authentication failure.
- **error.mensagem** (string) - Description of the authentication error.
- **error.detalhes** (string) - Additional details about the error.

#### Response Example
```json
{
    "erro": {
        "codigo": 14,
        "mensagem": "Usuário não possui acesso ou não cadastrado.",
        "detalhes": "Usuário não possui acesso ou não cadastrado."
    }
}
```
```

--------------------------------

### Rate Limits and Usage

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index

Understand the API rate limits and usage guidelines to avoid exceeding the allowed requests per minute and to manage data retrieval effectively.

```APIDOC
## Rate Limits and Usage

### Description
Details the rate limits and usage policies for the API, including request limits and pagination.

### Method
N/A

### Endpoint
N/A

### Parameters
#### Query Parameters
- **pagina** (integer) - Optional - The desired page number for results (starts at 0).
- **limite** (integer) - Optional - The number of records per page. Maximum limit is 500.

### Request Example
```
GET /endpoint?pagina=0&limite=20
```

### Response
#### Success Response (200 or 429)
- **paginacao.pagina_atual** (integer) - The current page number returned.
- **paginacao.total_pagina_atual** (integer) - The number of records returned on the current page.
- **paginacao.total_por_pagina** (integer) - The limit set for records per page.
- **paginacao.total** (integer) - The total number of records found.
- **paginacao.total_de_paginas** (integer) - The total number of available pages.
- **dados** (array) - An array containing the data records for the current page.

#### Response Example (Success)
```json
{
  "paginacao": {
    "pagina_atual": 0,
    "total_pagina_atual": 2,
    "total_por_pagina": 20,
    "total": 2,
    "total_de_paginas": 1
  },
  "dados": [
    {
      "id": 1,
      "nome": "Exemplo A"
    },
    {
      "id": 2,
      "nome": "Exemplo B"
    }
  ]
}
```

#### Error Response (429)
Returned when the rate limit is exceeded. Details will typically indicate the limit reached.
```

--------------------------------

### POST INSERT - Cadastro

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index_2b99f895-d9ae-473d-a03e-11d845e4e3df

Insere novos dados no módulo de Cadastro. Requer parâmetros como 'texto1', 'idtabaux3' e 'texto2'. Utiliza autenticação Basic Auth. Verifique se todos os parâmetros obrigatórios estão preenchidos corretamente para evitar erros.

```curl
curl --location --request POST 'https://seusistema.iilex.com.br/api/public/v1/insert/modulo/Cadastro?texto1=iiLEX%20Suporte%20T%C3%A9cnico&idtabaux3=5&texto2=iiLEX%20Software%20J%C3%BAridico'
```

--------------------------------

### Response Format

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index

All API responses can be returned in JSON or XML format, controlled by the 'Accept' header in your request.

```APIDOC
## Response Format

### Description
Specifies how to control the response format (JSON or XML) using the 'Accept' header.

### Method
N/A (Header based)

### Endpoint
N/A (Header based)

### Parameters
#### Request Headers
- **Accept** (string) - Optional - Specifies the desired response format. Use 'application/json' for JSON or 'application/xml' for XML.

### Request Example
```bash
Accept: application/json
```

```bash
Accept: application/xml
```

### Response
#### Success Response
Responses will be in the format specified by the 'Accept' header (JSON or XML).
```

--------------------------------

### POST /api/public/v1/insert/modulo/Cadastro

Source: https://documenter.getpostman.com/view/14108340/2sA3Bq4Avy/index_2b99f895-d9ae-473d-a03e-11d845e4e3df

Inserts new data into the Cadastro module. This endpoint allows you to add new records with specified text and auxiliary ID parameters.

```APIDOC
## POST /api/public/v1/insert/modulo/Cadastro

### Description
Inserts new data into the Cadastro module. This endpoint allows you to add new records with specified text and auxiliary ID parameters.

### Method
POST

### Endpoint
/api/public/v1/insert/modulo/Cadastro

### Parameters
#### Query Parameters
- **texto1** (string) - Required - The primary text content for the new record.
- **idtabaux3** (string) - Required - An auxiliary ID for the record.
- **texto2** (string) - Optional - Secondary text content for the new record.

### Request Example
```json
{
  "example": "POST /api/public/v1/insert/modulo/Cadastro?texto1=iiLEX%20Suporte%20T%C3%A9cnico&idtabaux3=5&texto2=iiLEX%20Software%20J%C3%BAridico"
}
```

### Response
#### Success Response (200)
This endpoint does not return a response body.

#### Response Example
```json
{
  "example": "No response body"
}
```
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.