Api
Información general de la API
General
Acceso datos instancia SQL Server A3ERP
Campos
Visualización de campos devueltos en las vistas
Devuelve los campos que muestra la vista en la consulta.
Ejemplo:
Vista con los campos a devolver
Bearer + JWT_token
GET /api/campos/{vista} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Accept: */*
Devuelve los campos de la vista seleccionada
{
"campos": [
{
"nombrecampo": "idfacv",
"tipo": "Currency",
"longitud": 7,
"descripcion": "Identificador factura venta",
"permitenulos": "[F,T]",
"cuadrado": "[F,T]",
"libreria": "A3ERP"
}
]
}Seguridad
API KEY fija obtenida por validación sobre maestros cliente, proveedor, transportista, representante, persona o API_login.
Logs
La API cuenta con un fichero log en la carpeta indicada en la configuración en la que se registran las incidencias y resultados de las llamadas a la API.
Paginación
En todas las consultas se da la opción de consulta para obtener solamente el número de registros de la consulta y de poder paginar los resultados. Para esto debemos usar los parámetros de la cabecera de la consulta.
Para obtener el número de registros de una consulta debemos crear el parámetro Contar en la cabecera y asignarle el valor T. (El conteo de registros no se puede usar con el parámetro order de las consultas)
Ejemplo:
Un endpoint de la api
Bearer + JWT_token
T
GET /api/{endpoint} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
contar: text
Accept: */*
Devuelve un Array Objetos con parametro registros
[
{
"registros": 44273
}
]Para paginar una consulta debemos indicar en los parámetros de la cabecera(Se necesita utilizar la ordenación para que la paginación funcione)
Ejemplo:
Un endpoint de la api
Cantidad de registros por pagina
Numero de la pagina a mostrar
Bearer + JWT_token
GET /api/{endpoints} HTTP/1.1
Host: servidor:<puerto>
PageSize: 1
Page: 1
Authorization: text
Accept: */*
Devuelve la llamada paginada
Sin contenido
Ordenación y Filtrado
En muchas consultas puedes ordenar por un parámetro el resultado devuelto o filtrar por unos parámetros, ambos pueden ser utilizados al mismo tiempo.
La ordenación se puede cambiar mediante la sintaxis de SQL.
Ejemplo:
Parámetro a ordenar
Bearer + JWT_token
GET /api/order/{order} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Accept: */*
Devuelve el endpoint ordenado por ese parametro
Sin contenido
El filtro tiene la misma sintaxis de where SQL por lo que puedes añadirle varios filtros diferentes en una misma petición.
Ejemplo:
https://servidor:5555/api/maestro/almacenes/filtro/encargado="7260 GYD"
Filtro con sintaxis SQL
Bearer + JWT_token
GET /api/filtro/{filtro} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Accept: */*
Devuelve el endpoint filtrado por ese parametro
Sin contenido
Se puede utilizar de manera conjunta poniendo el filtro primero.
Ejemplo:
https://servidor:5555/api/maestro/almacenes/filtro/encargado="7260 GYD"/order/desc
Filtro con sintaxis SQL
Parámetro a ordenar SQL
Bearer + JWT_token
GET /filtro/{filtro}/order/{order} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Accept: */*
Devuelve el endpoint filtrado y ordenado
Sin contenido
Campos de la Base de Datos
Aquí tienes una lista con todos los campos de A3 y sus tipos y definiciones, estos campos están agrupados por tabla y no por vista por lo que su nombre puede no coincidir, en ese caso pregunte a su proveedor de A3 para mas información, adicionalmente algunos campos no son modificables una vez creados, en ese caso la api devolverá un erro controlado con el campo no modificable.
Última actualización
¿Te fue útil?