Parámetros de Consulta
Introducción
Los parámetros de consulta (query parameters) permiten filtrar, ordenar y paginar las respuestas de la API, asegurando una recuperación eficiente de los datos. Esta guía explica cómo utilizarlos en las solicitudes a la API de Passport y cómo se integran con la paginación.
Estructura de los Parámetros de Consulta
Los parámetros de consulta se agregan al final de la URL del endpoint como pares clave-valor, separados por el signo &.
3
curl --location 'https://bre-b-sandbox.api.visionamos.passportfintech.com/v1/paas/entities/customers/accounts?page_size=10' \--header 'Accept: application/json' \--header 'Authorization: Bearer 0a3b39a14842e49c79249e1df649ebf9aaecb053386d2ad3dc8da201bd54373f'Parámetros de Consulta Soportados
Los parámetros de consulta a continuación pueden ser utilizados para ordenamiento, filtros y la paginación:
Parámetros de Paginación
| Parámetro | Descripción |
|---|---|
| page_size | Número de resultados por página. El valor por defecto varía según el endpoint. |
| page_number | Número de página actual. El valor por defecto es 1. |
Ordenamiento
| Parámetro | Descripción |
|---|---|
| order_key | Campo por el cual se desea ordenar (ej. created_at, updated_at). |
| order_direction | Dirección del ordenamiento: asc (ascendente) o desc (descendente). Por defecto: asc. |
Filtrado por Fecha
| Parámetro | Descripción |
|---|---|
| created_at | Filtra por una fecha de creación exacta. |
| created_from | Filtra resultados creados después de esta fecha. |
| created_to | Filtra resultados creados antes de esta fecha. |
| updated_at | Filtra por una fecha de actualización exacta. |
| updated_from | Filtra resultados actualizados después de esta fecha. |
| updated_to | Filtra resultados actualizados antes de esta fecha. |
Todas las fechas deben estar en formato ISO 8601 (YYYY-MM-DDTHH:MM:SSZ).
Filtrado Específico
| Parámetro | Descripción |
|---|---|
| customer_id | Filtra resultados por un ID de cliente específico. |
| customer_status | Filtra clientes por su estado (active, inactive). |
| Filtra resultados por dirección de correo exacta. | |
| mobile | Filtra por número de teléfono móvil. |
Ejemplos de Solicitud
Paginación
GET /v1/paas/entities/customers/accounts?page_size=10&page_number=2 HTTP/1.1Ordenamiento por Fecha de Creación en Orden Descendente
GET /v1/paas/entities/customers/accounts?order_key=created_at&order_direction=desc HTTP/1.1Filtro por Rango de Fechas de Creación
GET /v1/paas/entities/customers/accounts?created_from=2023-01-01T00:00:00Z&created_to=2023-12-31T23:59:59Z HTTP/1.1Buenas Prácticas al Usar Parámetros de Consulta
- Utiliza paginación (
page_sizeypage_number) para evitar sobrecargar la API. - Filtra por fecha (
created_fromycreated_to) para búsquedas eficientes. - Ordena los resultados (
order_key,order_direction) para mantener respuestas estructuradas. - Combina múltiples filtros para obtener resultados más precisos.
- Valida los parámetros antes de enviar la solicitud para evitar errores de formato.
Tabla de Contenido
Parámetros de ConsultaIntroducciónEstructura de los Parámetros de ConsultaParámetros de Consulta SoportadosParámetros de PaginaciónOrdenamientoFiltrado por FechaFiltrado EspecíficoEjemplos de SolicitudPaginaciónOrdenamiento por Fecha de Creación en Orden DescendenteFiltro por Rango de Fechas de CreaciónBuenas Prácticas al Usar Parámetros de Consulta