Skip to main content
La A3ERP API ofrece mecanismos para controlar la cantidad y el orden de los datos que recibes en cada consulta. Puedes contar registros, paginar resultados, ordenarlos por cualquier columna y filtrarlos mediante condiciones SQL. Todos estos mecanismos se aplican usando cabeceras HTTP o parámetros en la URL.

1. Contar registros

Antes de paginar, es habitual querer saber cuántos registros tiene un endpoint. Para ello, añade la cabecera contar: T a cualquier petición GET:
Ejemplo con curl:
Respuesta:
El parámetro contar no es compatible con la paginación (Page / PageSize). Úsalos por separado: primero cuenta los registros para saber cuántas páginas necesitas, luego pagina para obtenerlos.

2. Paginación

Para paginar los resultados de un endpoint, usa las cabeceras Page y PageSize junto con la ruta de ordenación /order/{columna} {asc|desc}. La paginación requiere obligatoriamente un criterio de ordenación para garantizar resultados consistentes. URL con ordenación:
Cabeceras necesarias: Ejemplo — segunda página de clientes, 50 por página, ordenados por nombre:
En formato HTTP:
Respuesta:

3. Ordenación

Si solo quieres ordenar sin paginar, puedes usar la ruta /order/{campo} sin las cabeceras Page y PageSize:
Los valores posibles para el orden son:

4. Filtrado SQL

Puedes filtrar los resultados de cualquier endpoint añadiendo /filtro/{filtro} a la URL. El parámetro filtro es una condición SQL tipo WHERE que se aplica sobre los resultados. Formato:
Ejemplo — órdenes de producción del cliente SPORTIF, S.A.:
Ejemplo — facturas con importe superior a 1000:
El filtro es una condición SQL que se ejecuta directamente en la base de datos. Nunca uses como filtro datos introducidos directamente por el usuario final sin validarlos o escaparlos previamente, ya que podrías exponerte a inyección SQL. Construye siempre los filtros en el lado del servidor con parámetros controlados.

5. Combinar filtro y ordenación

Puedes combinar el filtrado y la ordenación en la misma llamada:

Resumen de parámetros