Api

Información general de la API

General

Acceso datos instancia SQL Server A3ERP

Muestra los endpoints de consulta de datos disponibles en la API

get

Permite saber si la API esta en funcionamiento

Respuestas

get

HTTPcURLJavaScriptPython

GET /api HTTP/1.1
Host: servidor:<puerto>
Accept: */*

200

a3ERP API REST ready!

Hola, A3ApiRestestátrabajando

Campos

Visualización de campos devueltos en las vistas

Visualiza los campos devueltos en las vistas

get

Devuelve los campos que muestra la vista en la consulta.

Ejemplo:

https://servidor:5555/api/campos/Api_Vinculos

Parámetros de ruta

vistastringRequerido

Vista con los campos a devolver

Parámetros de encabezado

AuthorizationstringRequerido

Bearer + JWT_token

Respuestas

get

HTTPcURLJavaScriptPython

GET /api/campos/{vista} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Accept: */*

200

Devuelve los campos de la vista seleccionada

{
  "campos": [
    {
      "nombrecampo": "text",
      "tipo": "text",
      "longitud": "text",
      "descripcion": "text",
      "permitenulos": "text",
      "cuadrado": "text",
      "libreria": "text"
    }
  ]
}

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.

Conteo de registros

get

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:

https://servidor:5555/api/maestro/almacenes

Parámetros de ruta

endpointstringRequerido

Un endpoint de la api

Parámetros de encabezado

AuthorizationstringRequerido

Bearer + JWT_token

contarstringRequerido

T

Respuestas

get

HTTPcURLJavaScriptPython

GET /api/{endpoint} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
contar: text
Accept: */*

200

Devuelve un Array Objetos con parametro registros

[
  {
    "registros": 1
  }
]

Paginación

get

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:

https://servidor:5555/api/maestro/almacenes/order/desc

Parámetros de ruta

endpointsstringRequerido

Un endpoint de la api

Parámetros de encabezado

PageSizeintegerRequerido

Cantidad de registros por pagina

PageintegerRequerido

Numero de la pagina a mostrar

AuthorizationstringRequerido

Bearer + JWT_token

Respuestas

get

HTTPcURLJavaScriptPython

GET /api/{endpoints} HTTP/1.1
Host: servidor:<puerto>
PageSize: 1
Page: 1
Authorization: text
Accept: */*

200

Devuelve la llamada paginada

Sin contenido

La paginación y el conteo de registros pueden ser utilizadas en todas las consultas a la API pero solo el conteo es el que no se puede utilizar en order, la paginación necesita del order para que funcione.

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.

Ordenación

get

La ordenación se puede cambiar mediante la sintaxis de SQL.

Ejemplo:

https://servidor:5555/api/maestro/almacenes/order/desc

Parámetros de ruta

orderstringRequerido

Parámetro a ordenar

Parámetros de encabezado

AuthorizationstringRequerido

Bearer + JWT_token

Respuestas

get

HTTPcURLJavaScriptPython

GET /api/order/{order} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Accept: */*

200

Devuelve el endpoint ordenado por ese parametro

Sin contenido

Filtrado

get

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"

Parámetros de ruta

filtrostringRequerido

Filtro con sintaxis SQL

Parámetros de encabezado

AuthorizationstringRequerido

Bearer + JWT_token

Respuestas

get

HTTPcURLJavaScriptPython

GET /api/filtro/{filtro} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Accept: */*

200

Devuelve el endpoint filtrado por ese parametro

Sin contenido

Filtrado y Ordenación

get

Se puede utilizar de manera conjunta poniendo el filtro primero.

Ejemplo:

https://servidor:5555/api/maestro/almacenes/filtro/encargado="7260 GYD"/order/desc

Parámetros de ruta

filtrostringRequerido

Filtro con sintaxis SQL

orderstringRequerido

Parámetro a ordenar SQL

Parámetros de encabezado

AuthorizationstringRequerido

Bearer + JWT_token

Respuestas

get

HTTPcURLJavaScriptPython

GET /filtro/{filtro}/order/{order} HTTP/1.1
Host: servidor:<puerto>
Authorization: text
Accept: */*

200

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.

462KB

Campos_a3ERP.xlsx