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

Este endpoint devuelve una lista de los endpoints disponibles en la API.

Autorizaciones

token

AuthorizationstringRequerido

Autenticación mediante token JWT. El token debe ser incluido en el encabezado de autorización de la solicitud.

Respuestas

200

OK

Sin contenido

401

Unauthorized

application/json

get

/api

HTTPcURLJavaScriptPython

GET /api HTTP/1.1
Host: <domain>:<port>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Sin contenido

Campos

Visualización de campos devueltos en las vistas

Muestra los campos disponibles en una vista

get

Este endpoint devuelve los campos disponibles en una vista específica.

Autorizaciones

token

AuthorizationstringRequerido

Autenticación mediante token JWT. El token debe ser incluido en el encabezado de autorización de la solicitud.

Parámetros de ruta

vistastringRequerido

Nombre de la vista para la que se desean obtener los campos.

Respuestas

200

OK

application/json

get

/api/campos/{vista}

HTTPcURLJavaScriptPython

GET /api/campos/{vista} HTTP/1.1
Host: <domain>:<port>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "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.

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.

Numero de registros de un endpoint

get

Este endpoint devuelve el número de registros de un endpoint específico. No se debe utilizar en la ruta con ordenación, ya que no es compatible con la paginación.

Autorizaciones

token

AuthorizationstringRequerido

Autenticación mediante token JWT. El token debe ser incluido en el encabezado de autorización de la solicitud.

Parámetros de ruta

endpointstringRequerido

Nombre del endpoint para el que se desea obtener el número de registros.

Parámetros de encabezado

contarstringRequerido

Indica si se debe contar el número de registros del endpoint.

Example: T

Respuestas

200

OK

application/json

401

Unauthorized

application/json

404

Not Found

application/json

get

/api/{endpoint}

HTTPcURLJavaScriptPython

GET /api/{endpoint} HTTP/1.1
Host: <domain>:<port>
Authorization: Bearer YOUR_SECRET_TOKEN
contar: T
Accept: */*

[
  {
    "registros": 1
  }
]

Paginacion de un endpoint

get

Este endpoint devuelve los registros de un endpoint específico con paginación y ordenación. No se debe utilizar en la ruta con el número de registros, ya que no es compatible con la paginación.

Autorizaciones

token

AuthorizationstringRequerido

Autenticación mediante token JWT. El token debe ser incluido en el encabezado de autorización de la solicitud.

Parámetros de ruta

endpointstringRequerido

Nombre del endpoint para el que se desea obtener los registros.

columnastringRequerido

Nombre de la columna por la que se desea ordenar.

ordenstring · enumRequerido

Ordenación de los registros (ascendente o descendente).

Valores posibles:

Parámetros de encabezado

PageintegerRequerido

Número de pagina a partir de la cual devuelve resultados.

PageSizeintegerRequerido

Número máximo de registros a devolver.

Respuestas

200

OK

application/json

401

Unauthorized

application/json

404

Not Found

application/json

get

/api/{endpoint}/order/{columna} {orden}

HTTPcURLJavaScriptPython

GET /api/{endpoint}/order/{columna} {orden} HTTP/1.1
Host: <domain>:<port>
Authorization: Bearer YOUR_SECRET_TOKEN
Page: 1
PageSize: 1
Accept: */*

[
  {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
]

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 de un endpoint

get

Este endpoint devuelve los registros de un endpoint específico con ordenación. No se debe utilizar en la ruta con el número de registros, ya que no es compatible.

Autorizaciones

token

AuthorizationstringRequerido

Autenticación mediante token JWT. El token debe ser incluido en el encabezado de autorización de la solicitud.

Parámetros de ruta

endpointstringRequerido

Nombre del endpoint para el que se desea obtener los registros.

orderstring · enumRequerido

Ordenación de los registros (ascendente o descendente).

Valores posibles:

Parámetros de encabezado

PageintegerRequerido

Número de pagina a partir de la cual devuelve resultados.

PageSizeintegerRequerido

Número máximo de registros a devolver.

Respuestas

200

OK

application/json

401

Unauthorized

application/json

404

Not Found

application/json

get

/api/{endpoint}/order/{order}

HTTPcURLJavaScriptPython

GET /api/{endpoint}/order/{order} HTTP/1.1
Host: <domain>:<port>
Authorization: Bearer YOUR_SECRET_TOKEN
Page: 1
PageSize: 1
Accept: */*

[
  {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
]

Filtrado

get

Añadiendo un filtro SQL permite filtrar los registros de un endpoint específico.

Autorizaciones

token

AuthorizationstringRequerido

Autenticación mediante token JWT. El token debe ser incluido en el encabezado de autorización de la solicitud.

Parámetros de ruta

endpointstringRequerido

Nombre del endpoint para el que se desea obtener los registros.

filtrostringRequerido

Filtro SQL para aplicar a los registros.

Respuestas

200

OK

application/json

401

Unauthorized

application/json

404

Not Found

application/json

get

/api/{endpoint}/filtro/{filtro}

HTTPcURLJavaScriptPython

GET /api/{endpoint}/filtro/{filtro} HTTP/1.1
Host: <domain>:<port>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
]

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

Abrir