API REST - TaskFlow


Información de la función auth

Comprueba los datos de acceso del usuario y devuelve el token de sesión. El token tiene una duración de 7 días.

Esta autenticación consiste en una petición HTTP POST contra la URL https://api.lyzus.com/taskflow/v1/auth con un JSON con el siguiente formato:

 

Parámetros necesarios Respuesta
  • usuario: Usuario del usuario
  • password: Contraseña del usuario
Ejemplo de solicitud:
{ "usuario": "usuario", "password": "password_usuario" } 		La función devuelve un JSON con los siguientes datos:
  • status: Indica si la petición fue correcta o no
  • result: Resultado
    • token: Devuelve el token del usuario
    • nombre: Nombre del usuario
    • ciudad: Ciudad del usuario
  • error: Muestra el error
    • error_id: ID del error
    • error_msg: Mensaje de error
Ejemplo login correcto:
{ "status":"ok", "result":{ "token":"8312f936a787acf8ae10065cb2zt47fe.5qLyPDJdIUjm1Zf94.3MaOCb70BXKxN_", "nombre": "Josefina", "ciudad": "Murcia" } }
Ejemplo login incorrecto:
{ "status":"error", "result":{ "error_id":"400", "error_msg":"Datos enviados incompletos o con formato incorrecto." } }

Información de la función resetpassword

Comprueba que el email exista y envia un enlace al email para restablecer la contraseña

Para obtener la información sobre el recinicio de contraseña es necesario realizar una petición HTTP POST contra la URL https://api.lyzus.com/taskflow/v1/resetpassword con un JSON con el siguiente formato:

 

Parámetros necesarios Respuesta
  • email: Email del usuario registrado
Ejemplo de solicitud:
{ "email": "[email protected]" } 		La función devuelve un JSON con los siguientes datos:
  • status: Indica si la petición fue correcta o no
  • result: Resultado
    • email: Devuelve el email del usuario registrado
  • error: Muestra el error
    • error_id: ID del error
    • error_msg: Mensaje de error
Ejemplo del reinicio de contraseña correcto:
{ "status": "ok", "result": { "email": "[email protected]" } }
Ejemplo del reinicio de contraseña incorrecto:
{ "status": "error", "result": { "error_id": "401", "error_msg": "No autorizado." } }

Información de la función projects

Encuentra todos los proyectos que tiene asignado un usuario

Para obtener la información sobre los proyectos es necesario realizar una petición HTTP GET contra la URL https://api.lyzus.com/taskflow/v1/projects con un JSON con el siguiente formato:

 

Parámetros necesarios Respuesta
  • Token: Token de validación
Ejemplo de solicitud:
headers: { "Token": token_de_validación } 		La función devuelve un JSON con los siguientes datos:
  • status: Indica si la petición fue correcta o no
  • result: Array del listado de los proyectos
  • error: Muestra el error
    • error_id: ID del error
    • error_msg: Mensaje de error
Ejemplo de listado correcto:
{ "status": "ok", "result": { "limit_page": "30", "total": "5", "proyectos": [{ "id": "1", "nombre": "Desarrollo de Página Web Corporativa", "descripcion": "Creación de una página web para una empresa, con diseño personalizado y secciones funcionales.", "fecha_meta": "2024-11-20 15:18:26" }] } }
Ejemplo del listado incorrecto:
{ "status": "error", "result": { "error_id": "401", "error_msg": "No autorizado." } }

Información de la función task

Encuentra todos las tareas

Para obtener la información sobre las tareas es necesario realizar una petición HTTP GET contra la URL https://api.lyzus.com/taskflow/v1/task/{tareas_usuario} con un JSON con el siguiente formato:

 

Parámetros necesarios Respuesta
  • Token: Token de validación
  • tareas_usuario: Muestra todas las tareas (0) o solo las de un usuario (1)
Ejemplo de solicitud:
headers: { "Token": token_de_validación } 		La función devuelve un JSON con los siguientes datos:
  • status: Indica si la petición fue correcta o no
  • result: Array del listado de las tareas
  • error: Muestra el error
    • error_id: ID del error
    • error_msg: Mensaje de error
Ejemplo de listado correcto:
{ "status": "ok", "result": { "limit_page": "30", "total": "5", "tareas": [{ "id_proyecto": "1", "nombre_usuario": "Josefina", "nombre_tarea": "Diseñar la maqueta del sitio web", "descripcion": "Crear bocetos y diseños iniciales utilizando herramientas como Figma o Adobe XD", "tiempo_acumulado": "120", "tiempo_legible": "1 hora 15 minutos 29 segundos", "fecha_inicio": "2024-11-20 15:18:26", "fecha_fin": "2024-11-28 15:18:26", "fecha_meta": "2024-11-20 15:18:26", "estado": "2" }] } }
Ejemplo del listado incorrecto:
{ "status": "error", "result": { "error_id": "401", "error_msg": "No autorizado." } }

Información de la función task

Registro de las tareas

Para obtener la información sobre las taras es necesario realizar una petición HTTP POST contra la URL https://api.lyzus.com/taskflow/v1/task con un JSON con el siguiente formato:

 

Parámetros necesarios Respuesta
  • Token: Token de validación
  • id_tarea: Identificador de la tarea a registrar
  • observaciones: Observaciones de la tarea registrada
  • estado: Estado del registro de la tarea donde 1 empieza y 2 finaliza
Ejemplo de solicitud:
headers: { "Token": token_de_validación }
{ "id_tarea": "1", "observaciones": "Esto es un ejemplo de una observación.", "estado": "1"} 		La función devuelve un JSON con los siguientes datos:
  • status: Indica si la petición fue correcta o no
  • result: Resultado
    • estado: Devuelve el estado de la tarea
  • error: Muestra el error
    • error_id: ID del error
    • error_msg: Mensaje de error
Ejemplo del registro correcto:
{ "status": "ok", "result": { "estado": "3" } }
Ejemplo del registro incorrecto:
{ "status": "error", "result": { "error_id": "401", "error_msg": "No autorizado." } }

Información de la función changepassword

Recibe la contraseña actual y la nueva y si es correcto envía un email

Para obtener la información sobre el cambio de contraseña es necesario realizar una petición HTTP POST contra la URL https://api.lyzus.com/taskflow/v1/changepassword con un JSON con el siguiente formato:

 

Parámetros necesarios Respuesta
  • Token: Token de validación
  • password_actual: Contraseña actual
  • password_nueva: Nueva contraseña, que tiene que cumplir lo siguiente: mínimo 8 carácteres, que contengan al menos una letra, un número, un caracter especial
Ejemplo de solicitud:
headers: { "Token": token_de_validación }
{ "password_actual": "1245ERrt*", "password_nueva": "456%YUjh!x" } 		La función devuelve un JSON con los siguientes datos:
  • status: Indica si la petición fue correcta o no
  • result: Resultado
    • email_enviado: Devuelve 1 si el email fue enviado correctamente
  • error: Muestra el error
    • error_id: ID del error
    • error_msg: Mensaje de error
Ejemplo del reinicio de contraseña correcto:
{ "status": "ok", "result": { "email_enviado": "1" } }
Ejemplo del reinicio de contraseña incorrecto:
{ "status": "error", "result": { "error_id": "401", "error_msg": "No autorizado." } }

Información de la función comments

Encuentra todos los cometarios que tiene asignado un proyecto

Para obtener la información sobre los comentarios es necesario realizar una petición HTTP GET contra la URL https://api.lyzus.com/taskflow/v1/comments/{id_proyecto} con un JSON con el siguiente formato:

 

Parámetros necesarios Respuesta
  • Token: Token de validación
  • id_proyecto: Identificador del proyecto
Ejemplo de solicitud:
headers: { "Token": token_de_validación }
 		La función devuelve un JSON con los siguientes datos:
  • status: Indica si la petición fue correcta o no
  • result: Array del listado de los comentarios
  • error: Muestra el error
    • error_id: ID del error
    • error_msg: Mensaje de error
Ejemplo de listado correcto:
{ "status": "ok", "result": { "limit_page": "30", "total": "5", "comentarios": [{ "nombre_usuario": "Josefina", "comentario": "Ejemplo de un comentario.", "fecha_creacion": "2024-11-20 15:18:26" }] } }
Ejemplo del listado incorrecto:
{ "status": "error", "result": { "error_id": "401", "error_msg": "No autorizado." } }

Información de la función comments

Registro de los comentarios

Para obtener la información sobre las comentarios es necesario realizar una petición HTTP POST contra la URL https://api.lyzus.com/taskflow/v1/comments con un JSON con el siguiente formato:

 

Parámetros necesarios Respuesta
  • Token: Token de validación
  • id_proyecto: Identificador del proyecto
  • comentario: Comentario
Ejemplo de solicitud:
headers: { "Token": token_de_validación }
{ "id_proyecto": "1", "comentario": "Esto es un ejemplo de un comentario."} 		La función devuelve un JSON con los siguientes datos:
  • status: Indica si la petición fue correcta o no
  • result: Resultado
    • registro: Devuelve 1 tras el registro
  • error: Muestra el error
    • error_id: ID del error
    • error_msg: Mensaje de error
Ejemplo del registro correcto:
{ "status": "ok", "result": { "registro": "1" } }
Ejemplo del registro incorrecto:
{ "status": "error", "result": { "error_id": "401", "error_msg": "No autorizado." } }

Información de la función kpi/user

Muestra las KPI's del usuario

Para obtener la información sobre las KPI's es necesario realizar una petición HTTP GET contra la URL https://api.lyzus.com/taskflow/v1/kpi/user con un JSON con el siguiente formato:

 

Parámetros necesarios Respuesta
  • Token: Token de validación
Ejemplo de solicitud:
headers: { "Token": token_de_validación } 		La función devuelve un JSON con los siguientes datos:
  • status: Indica si la petición fue correcta o no
  • result: Resultado
    • total_proyectos: Total de los proyectos del usuario
    • total_proyectos_finalizados: Total del los proyectos finalizados
    • total_tareas: Total de tareas del usuario
    • total_tareas_completas: Total de tareas completadas del usuario
    • total_tareas_incompletas: Total de tareas incompletas del usuario
    • total_comentarios: Total de los comentarios del usuario
    • total_comentarios_proyectos: Total de los comentarios de un proyecto usuario
    • total_horas: Total de horas realizadas del usuario
  • error: Muestra el error
    • error_id: ID del error
    • error_msg: Mensaje de error
Ejemplo de listado correcto:
{ "status": "ok", "result": { "total_proyectos": "5", "total_proyectos_finalizados": "1", "total_tareas": "8", "total_tareas_completas": "1", "total_tareas_incompletas": "7", "total_comentarios": "3", "total_comentarios_proyectos": [ { "nombre_proyecto": "Desarrollo de Página Web Corporativa", "total": "3" } ], "total_horas": "129" } }
Ejemplo del listado incorrecto:
{ "status": "error", "result": { "error_id": "401", "error_msg": "No autorizado." } }

Información de la función kpi/project

Muestra las KPI's de un proyecto

Para obtener la información sobre las KPI's es necesario realizar una petición HTTP GET contra la URL https://api.lyzus.com/taskflow/v1/kpi/project/{id_proyecto} con un JSON con el siguiente formato:

 

Parámetros necesarios Respuesta
  • Token: Token de validación
  • id_proyecto: Identificador del proyecto
Ejemplo de solicitud:
headers: { "Token": token_de_validación }
 		La función devuelve un JSON con los siguientes datos:
  • status: Indica si la petición fue correcta o no
  • result: Resultado
    • total_tareas: Total de las tareas del proyecto
    • total_tareas_completas: Total de las tareas completas
    • total_tareas_incompletas: Total de las tareas incompletadas
    • total_comentarios: Total de los comentarios
    • total_comentarios_usuarios: Total de los comentarios de cada usuario del proyecto
    • total_horas: Total de horas realizadas
  • error: Muestra el error
    • error_id: ID del error
    • error_msg: Mensaje de error
Ejemplo de listado correcto:
{ "status": "ok", "result": { "total_tareas": "5", "total_tareas_completas": "1", "total_tareas_incompletas": "4", "total_comentarios": "4", "total_comentarios_usuarios": [ { "nombre_usuario": "Josefina", "total": "3" }, { "nombre_usuario": "Test", "total": "1" } ], "total_horas": "129" } }
Ejemplo del listado incorrecto:
{ "status": "error", "result": { "error_id": "401", "error_msg": "No autorizado." } }

Información de la función calendar

Encuentra todos los festivos del calendario

Para obtener la información sobre el calendario es necesario realizar una petición HTTP GET contra la URL https://api.lyzus.com/taskflow/v1/calendar con un JSON con el siguiente formato:

 

Parámetros necesarios Respuesta
  • Token: Token de validación
Ejemplo de solicitud:
headers: { "Token": token_de_validación } 		La función devuelve un JSON con los siguientes datos:
  • status: Indica si la petición fue correcta o no
  • result: Array del listado del calendario
  • error: Muestra el error
    • error_id: ID del error
    • error_msg: Mensaje de error
Ejemplo de listado correcto:
{ "status": "ok", "result": { "calendario": [{ "nombre": "San Francisco Javier", "color": "#592BCA", "icono": "sparkles-outline", "fecha_evento": "2024-12-03 00:00:00" }] } }
Ejemplo del listado incorrecto:
{ "status": "error", "result": { "error_id": "401", "error_msg": "No autorizado." } }

Información de la función firebase/auth

Registra el token de firebase al usuario correspondiente

Para registrar el token de firebase es necesario realizar una petición HTTP POST contra la URL https://api.lyzus.com/taskflow/v1/firebase/auth con un JSON con el siguiente formato:

 

Parámetros necesarios Respuesta
  • Token: Token de validación
  • token_firebase: Token de Firebase
Ejemplo de solicitud:
{ "token_firebase": "j0zYZtq9oE_dMohODADAkVo2U96VNQc" } 		La función devuelve un JSON con los siguientes datos:
  • status: Indica si la petición fue correcta o no
  • result: Resultado
    • token_registrado: Devuelve 1 si fue registrado correctamente
  • error: Muestra el error
    • error_id: ID del error
    • error_msg: Mensaje de error
Ejemplo del registro correcto:
{ "status": "ok", "result": { "token_registrado": "1" } }
Ejemplo del registro incorrecto:
{ "status": "error", "result": { "error_id": "401", "error_msg": "No autorizado." } }

Información de la función firebase/notification

Confirma que la notificación ha sido recibida correctamente

Para registrar la notificación con firebase es necesario realizar una petición HTTP PUT contra la URL https://api.lyzus.com/taskflow/v1/firebase/notification con un JSON con el siguiente formato:

 

Parámetros necesarios Respuesta
  • Token: Token de validación
  • id_proyecto: Identificador del proyecto
Ejemplo de solicitud:
headers: { "Token": token_de_validación }
{ "id_proyecto": "1" } 		La función devuelve un JSON con los siguientes datos:
  • status: Indica si la petición fue correcta o no
  • result: Resultado
    • registrado: Devuelve 1 si fue registrado correctamente
  • error: Muestra el error
    • error_id: ID del error
    • error_msg: Mensaje de error
Ejemplo del registro correcto:
{ "status": "ok", "result": { "registrado": "1" } }
Ejemplo del registro incorrecto:
{ "status": "error", "result": { "error_id": "401", "error_msg": "No autorizado." } }

Información de la función pulling/notification

Confirma que la notificación ha sido recibida correctamente

Para registrar la notificación con pulling es necesario realizar una petición HTTP PUT contra la URL https://api.lyzus.com/taskflow/v1/pulling/notification con un JSON con el siguiente formato:

 

Parámetros necesarios Respuesta
  • Token: Token de validación
Ejemplo de solicitud:
headers: { "Token": token_de_validación } 		La función devuelve un JSON con los siguientes datos:
  • status: Indica si la petición fue correcta o no
  • result: Resultado
    • title: Nombre del proyecto
    • body: Comentario registrado
    • target_page: URL a la que se va a redireccionar
  • error: Muestra el error
    • error_id: ID del error
    • error_msg: Mensaje de error
Ejemplo del registro correcto:
{ "status": "ok", "result": { "title": "Desarrollo de Página Web Corporativa", "body": "Josefina dice: Comentario D", "target_page": "comentarios.html?i=MXxEZXNhcnJvbGxvIGRlIFDDoWdpbmEgV2ViIENvcnBvcmF0aXZh" } }
Ejemplo del registro incorrecto:
{ "status": "error", "result": { "error_id": "401", "error_msg": "No autorizado." } }