Pregunta más frecuente
Introducción
En el siguiente documento se detalla el uso y configuración de la API para poder alimentar los indicadores de las TOPs.
Uso del API
1. Configuración inicial
La api_key se tiene que configurar en LES-Admin de la siguiente manera, en la opción API keys del menú de “Configuración”.
Nombre: API_LES_LOGIN (Obligatorio con este nombre)
API key: … (lo que se considere oportuno)
Si no se configura la API key o se configura con otro nombre, en las llamadas que nos hacen contestaremos con una respuesta tipo, status 401:
{
"mensaje": "Acceso denegado."
}
La api_key se deberá utilizar en la cabecera de todas las llamadas a la API, parámetro “api_key” (tipo de autenticación API Key).
Ejemplo Postman:
NOTA: Apache debe estar instalado, configurado y mapeado para que tenga acceso a la caja LESTareas.
Las URLs de los Endpoints serán la IP del servidor LES y los nombres de los procesos. Puede que sea necesario poner también el nombre de la caja antes del proceso, dependiendo de cómo se configure el vModApache.
2. Endpoint indicadores externos TOP 5 (para alta y modificación)
Envío petición POST
URL: XXX.XXX.X.XXX/LES_API_INDICADOR_EXTERNO_TOP_5
El Endpoint espera como datos en el cuerpo (body) de la petición un JSON. Ejemplo:
{
"FECHA_TOP": "27/03/2024",
"TURNO": 1,
"GAP": "TR",
"MAQUINA": "MQ",
"INDICADOR": 2,
"OBJETIVO": 155.60,
"VALOR": 200.45
}
Donde:
En caso de que se ha dado de alta o se ha modificado un indicador con éxito, devolveremos un JSON informando, con status 200.
La modificación de los datos de indicadores se realiza cuando se genera de nuevo la TOP, la API no puede modificar los datos de una TOP cerrada.
3. Endpoint indicadores externos TOP (para alta y modificación)
Envío petición POST
URL: XXX.XXX.X.XXX/LES_API_INDICADOR_EXTERNO_TOP
El Endpoint espera como datos en el cuerpo (body) de la petición un JSON. Ejemplo:
{
"FECHA_TOP": "27/03/2024",
"INDICADOR": "Velocidad MQ",
"OBJETIVO": 90.90,
"VALOR": 80.80
}
Donde:
En caso de que se ha dado de alta o se ha modificado un indicador con éxito, devolveremos un JSON informando, con status 200.
La modificación de los datos de indicadores se realiza cuando se genera de nuevo la TOP, la API no puede modificar los datos de una TOP cerrada.
4. Endpoint entidades (para alta y modificación)
Envío petición POST
URL: XXX.XXX.X.XXX/api/LES-Db_dat/v1
El Endpoint espera como datos en el cuerpo (body) de la petición un JSON. Ejemplo:
{
"id": "1",
"name": "AAAAA",
"name_comercial": "A",
"imagen": "Imagen en Base64",
"es_personal_empresa":true,
"es_miembro_gap":true,
"codigo_cliente":"1",
"email":"Email@email.com"
}
Las imágenes de han de pasar en Base64 y el ancho no puede ser más grande que el alto ya que se colocarán giradas. Luego es posible girarlas manualmente, pero es un aspecto a tener el cuenta. Se recomienda que las fotos sean cuadradas, mismo ancho y alto.
Donde:
La API también permite eliminar entidades pero debido a la configuración del LES no es posible eliminar entidades si tiene incidencias, acciones, ha asistido a reuniones, etc... por lo que se recomienda modificar el nombre o nombre comercial para indicar si está de baja