Filtro

Endpoint para exportación de datos a través de filtros generados.

📥 Collection Postman

Descargar Collection - Filter Export

URLs

Método	URL	Acción	Descripción
GET	/api/filter	Listar	Lista todos los filtros disponibles
GET	/api/filter/{id}/export	Visualizar	Exporta registros a partir de un filtro
POST	/api/filter/{id}/update	Actualizar	Actualiza datos de un filtro

Producción:

{connect-producao}/api/filter

Homologación:

{connect-homologacao}/api/filter

Autenticación

Todas las solicitudes requieren un token de acceso obtenido en el endpoint de Security. El token debe ser enviado en el header AccessToken.

Listar Filtros

Solicitud

Endpoint: GET {connect-producao}/api/filter

Headers:

AccessToken: {access_token}

Respuesta de Éxito

Estado: 200 OK

{
  "header": {
    "codigo": 1,
    "msg": "ok."
  },
  "data": [
    {
      "filterId": "123",
      "filterNome": "Filtro de Ejemplo"
    }
  ]
}

Exportar Registros

Solicitud

Endpoint: GET {connect-producao}/api/filter/{id}/export

Headers:

AccessToken: {access_token}

Parámetros:

• id (path): ID del filtro
• updatedFrom (query, opcional): Fecha de última actualización (formato ISO 8601)
• exportAttributes (query, opcional): Lista de atributos a exportar (separados por coma)

Ejemplo de Solicitud

GET {connect-producao}/api/filter/123/export?updatedFrom=2025-12-26T12:00:00&exportAttributes=TipoDeTorcedor,TipoDeRegistro

Respuesta de Éxito

Estado: 200 OK

{
  "header": {
    "codigo": 1,
    "msg": "ok."
  },
  "data": {
    "total": 1000,
    "items": [
      {
        "userId": 123456,
        "cpf": "12345678900",
        "email": "usuario@ejemplo.com",
        "nome": "Juan Silva",
        "atributos": {
          "TipoDeTorcedor": "Socio",
          "TipoDeRegistro": "Premium"
        }
      }
    ]
  }
}

Actualizar Filtro

Solicitud

Endpoint: POST {connect-producao}/api/filter/{id}/update

Headers:

AccessToken: {access_token}
Content-Type: application/json

Parámetros:

• id (path): ID del filtro

Body:

{
  "configuracao": "nueva_configuracion"
}

Respuesta de Éxito

Estado: 200 OK

{
  "header": {
    "codigo": 1,
    "msg": "Filtro actualizado con éxito"
  }
}

Ejemplo de Implementación

async function listarFiltros(accessToken) {
  const response = await fetch('{connect-producao}/api/filter', {
    method: 'GET',
    headers: {
      'AccessToken': accessToken
    }
  });

  if (!response.ok) {
    throw new Error(`Error ${response.status}: ${response.statusText}`);
  }

  return await response.json();
}

async function exportarFiltro(filterId, updatedFrom, exportAttributes, accessToken) {
  const params = new URLSearchParams();
  if (updatedFrom) params.append('updatedFrom', updatedFrom);
  if (exportAttributes) params.append('exportAttributes', exportAttributes);

  const response = await fetch(`{connect-producao}/api/filter/${filterId}/export?${params}`, {
    method: 'GET',
    headers: {
      'AccessToken': accessToken
    }
  });

  if (!response.ok) {
    throw new Error(`Error ${response.status}: ${response.statusText}`);
  }

  return await response.json();
}