Skip to main content
La A3ERP API proporciona acceso programático a los datos de tu instancia SQL Server de A3ERP. Antes de comenzar a consumir los endpoints de negocio, es fundamental que conozcas las capacidades transversales de la API: cómo descubrir los endpoints disponibles, qué campos expone cada vista, cómo autenticar tus peticiones, cómo paginar y ordenar resultados, y cómo aplicar filtros SQL personalizados.

​
Endpoint de estado

Utiliza el endpoint raíz de la API para obtener un listado completo de todos los endpoints de consulta disponibles en tu instancia. GET /api
Este endpoint requiere un token JWT válido en la cabecera Authorization. Devuelve la lista de rutas activas que puedes consultar.

​
Descubrimiento de campos

Antes de construir tus consultas, puedes inspeccionar qué campos devuelve cualquier vista de la API. GET /api/campos/{vista}
Sustituye {vista} por el nombre de la vista que deseas inspeccionar (por ejemplo, clientes o facturas).

​
Respuesta 200 — estructura del objeto campos

​
array
Lista de objetos que describen cada campo disponible en la vista.
Ejemplo de respuesta:

​
Seguridad

La A3ERP API utiliza autenticación mediante JWT (JSON Web Token). El token se obtiene realizando una llamada POST /api/login con tus credenciales en Base64 (consulta la sección Validación para más detalles). Una vez obtenido el token, inclúyelo en todas las peticiones dentro de la cabecera Authorization:
Sin un token JWT válido, todos los endpoints devolverán un error 401 Authorization Required. Asegúrate de renovar el token cuando expire.

​
Logs

La API registra de forma automática todas las incidencias y resultados de las llamadas en un fichero de log. La ubicación de este fichero se configura en el archivo Config.ini de tu instalación. Consulta ese fichero para localizar la ruta exacta donde se almacenan los registros de actividad.

​
Contar registros

En cualquier consulta puedes obtener únicamente el número total de registros que devolvería ese endpoint, sin recuperar el contenido completo. Para ello, añade la cabecera contar con el valor T.
​
string
required
Indica a la API que devuelva el recuento de registros en lugar de los datos. Usa el valor T.Ejemplo: contar: T
Ejemplo de petición:
Ejemplo de respuesta:
El conteo de registros no es compatible con la ruta de ordenación (/order/…). Úsalo únicamente sobre el endpoint base.

​
Paginación

Para recorrer conjuntos grandes de datos puedes paginar los resultados combinando la ruta de ordenación con las cabeceras Page y PageSize. URL: GET /api/{endpoint}/order/{columna} {asc|desc}
​
integer
required
Número de página a partir del cual se devuelven resultados. La primera página es 1.
​
integer
required
Número máximo de registros a devolver por página.
Ejemplo de petición (página 2, 25 registros por página, ordenado por CodCliente ascendente):
Ejemplo de respuesta:
La paginación requiere que uses la ruta con /order/. Sin la cláusula de ordenación, las cabeceras Page y PageSize no tienen efecto.

​
Filtrado

Puedes restringir los resultados de cualquier endpoint aplicando un filtro SQL directamente en la URL. GET /api/{endpoint}/filtro/{filtro}
​
string
required
Expresión de filtro SQL que se aplicará sobre los registros devueltos por el endpoint. Por ejemplo: CodCliente='000001' o Provincia='Madrid'.
Ejemplo de petición (clientes de Madrid):
Ejemplo de respuesta:
Puedes combinar filtrado y ordenación en la misma petición: GET /api/{endpoint}/filtro/{filtro}/order/{columna} {asc|desc}. Consulta la documentación de cada endpoint para conocer los campos filtrables disponibles.

​
Campos de la base de datos

Si necesitas consultar el listado completo de campos de A3ERP junto con sus tipos y definiciones, descarga el siguiente archivo Excel. Los campos están agrupados por tabla (no por vista), por lo que el nombre puede diferir del que expone la API. En caso de duda, consulta con tu proveedor de A3ERP.
Algunos campos no son modificables una vez creados. Si intentas actualizar uno de estos campos, la API devolverá un error controlado indicando que el campo no es modificable.
Descargar Campos_a3ERP.xlsx — 462 KB