Complemento de API Mewayz
Descubre el poder de la integración API de Mewayz para una gestión fluida de proyectos y tareas. Amplía y personaliza con facilidad. ¡Pruébalo ahora!
Introducción
El Generador de Documentación de API es un potente complemento que proporciona documentación completa de la API para la plataforma Mewayz. Este complemento ayuda a los desarrolladores y equipos técnicos a acceder a información detallada de la API, incluidos endpoints, encabezados, parámetros y ejemplos de respuesta. La documentación cubre 14 módulos principales de la plataforma y permite a los usuarios crear aplicaciones personalizadas, integrar sistemas externos o probar las API manualmente con herramientas como Postman.
Cómo habilitar este módulo
Para configurar el complemento de API, puedes seguir este enlace: Configurar el complemento.
¿Cómo usar el complemento de API?
Generar documentación de API
Tras comprar e instalar este complemento, ve a la barra lateral de tu panel y busca el complemento API Docs.
Para acceder a la documentación de la API, dirígete a la sección Documentos de API desde tu panel principal. La documentación está organizada por 14 módulos, lo que facilita encontrar las APIs concretas que necesitas para tu proyecto de integración.
La sección incluye una introducción general que explica cómo usar las API de forma eficaz. Esta descripción cubre los requisitos de autenticación, los encabezados comunes y las pautas básicas de uso que se aplican a todos los endpoints de la API.
Each module contains powerful API listings with complete technical details. For every API endpoint, you’ll find the API name, exact endpoint URL, required headers for authentication and data format, input parameters with their data types and validation rules, example success responses showing the expected data structure, and example error responses with common error codes and messages.
Gestión de Introducciones
Esta completa documentación de la API es tu puerta de entrada para aprovechar todo el potencial de las funciones de Mewayz, lo que te permite optimizar tu trabajo, aumentar la productividad y llevar tus proyectos al siguiente nivel.
Esta documentación de la API es un recurso para desarrolladores, tanto experimentados como noveles, que quieran aprovechar las capacidades de Mewayz dentro de sus aplicaciones. Esto es lo que encontrarás.
Puedes explorar la referencia completa e interactiva dentro del producto en Configuración → Documentación de la API.
La sección de endpoints abarca GET para obtener datos, POST para crear nuevos datos, POST para actualizar datos existentes y DELETE para eliminar datos. Puedes usar métodos HTTP como GET para obtener datos, POST para crear nuevos datos, POST para actualizar datos existentes y DELETE para eliminar datos.
Los parámetros de solicitud se utilizan para personalizar el comportamiento de tus solicitudes de API y proporcionar detalles más específicos al interactuar con la API. Para Mewayz, podrías tener los siguientes tipos de parámetros de solicitud: parámetros de consulta para filtrar u ordenar datos al recuperar información, encabezados de solicitud para la autenticación y metadatos adicionales sobre la solicitud, y un cuerpo de solicitud con datos JSON que se van a crear o actualizar.
La API de Mewayz normalmente responde con datos en formato JSON. La respuesta suele incluir un código de estado HTTP que indica el resultado de la solicitud, y los datos reales están contenidos dentro de la «datos» field.
Gestión de autenticación
Las API de autenticación proporcionan la funcionalidad esencial de inicio de sesión, la capacidad de renovar tokens para mantener las sesiones y los procedimientos de cierre de sesión para finalizar de forma segura las sesiones de usuario.
El endpoint de inicio de sesión POST /api/login requiere cabeceras con «Aceptar»: “application/json” y parámetros que incluyen el correo electrónico, como «[email protected]» y una contraseña como **“john****”**.
Las respuestas de error devuelven 422 Unprocessable Content con “éxito”: false, «mensaje»: «Validación cuando la validación es un error.
Las respuestas de error devuelven 400 No autorizado con “éxito”: false, «mensaje»: «El proporcionado» cuando las credenciales no son válidas.
Las respuestas de inicio de sesión correctas devuelven 200 OK con “éxito”: true y autorización que contenga token y tipo «bearer» para las llamadas posteriores a la API.
El endpoint de actualización de autenticación POST /api/refresh usa cabeceras de autorización con un token Bearer para gestionar la sesión.
Las respuestas de actualización correctas devuelven información detallada del usuario, incluido 200 OK con “éxito”: true, y los detalles del usuario, id, name, email, mobile_no, type : «empresa», avatar: «URL», idioma: “en” y token.
Gestión de usuarios
- APIs de usuario para la administración de usuarios, la gestión de roles y el perfil
operaciones.
Gestión de almacenes
- APIs de almacén para la configuración de almacenes y las transferencias entre almacenes
gestión.
Product & Service Management
- Product & Service section APIs manage product categories, taxes,
unidades de medida, productos y gestión de stock con integración de almacenes.
Gestión de facturas de compra
- APIs de Factura de Compra para Lista, Crear y Detalle de Factura de Compra,
Gestión de actualización, eliminación y registro de facturas.
Gestión de devoluciones de compras
- APIs para gestionar Lista de devoluciones de compra, Crear, Detalle de devolución,
Delete, Approve, Complete processing.
Gestión de propuestas de venta
- APIs de Propuestas Comerciales para la gestión y conversión de propuestas
procesos.
Gestión de facturas de venta
- Las API de facturas de venta gestionan el listado, la creación, la actualización y la eliminación de facturas,
Gestión de registro de facturas.
Gestión de devoluciones de facturas de venta
- APIs para gestionar la lista de devoluciones de facturas de venta: crear, ver detalle, eliminar,
Aprobar y completar.
Gestión de cuentas
- Las interfaces de programación de la sección Cuenta te permiten gestionar Clientes, Proveedores,
- El módulo de Cuenta incluye APIs de listas rápidas para recuperar datos simples
registros de Cuentas bancarias, Plan de cuentas, Ingresos, Gastos, Notas de crédito, Notas de débito, Pagos a proveedores, Pagos de clientes, Transacciones bancarias y Transferencias bancarias. Puedes realizar operaciones como listar registros, crear nuevas entradas, ver detalles, actualizar información y eliminar registros según lo necesites.
listas de clientes y proveedores, lista de cuentas del libro mayor, junto con categorías de ingresos y gastos para selecciones desplegables y consultas rápidas.
Gestión de proyectos
- Las API de la sección de proyectos gestionan proyectos, tareas, errores, hitos,
archivos y diversos informes con sus etapas y flujos de trabajo asociados.
Gestión de TPV
- Las API de TPV gestionan las operaciones de punto de venta, incluida la gestión de pedidos
y los Detalles del Pedido.
Gestión de CRM
- Las APIs de la sección CRM cubren la gestión del pipeline, las etapas de leads y tratos,
etiquetas, fuentes y la gestión completa de Clientes potenciales y la gestión de Tratos. Puedes administrar tareas, usuarios, productos, fuentes, correos electrónicos, conversaciones, archivos y llamadas asociados tanto a clientes potenciales como a tratos.
Gestión de RR. HH.
- Las API de RR. HH. gestionan la administración de empleados, la estructura organizativa,
control de asistencia, gestión de ausencias, procesamiento de nóminas y diversos registros de RR. HH., incluidos Reconocimientos, Ascensos, Renuncias, Despidos, Advertencias, Quejas, Traslados de Empleados, días festivos, eventos, documentos, Anuncios y Acuses de recibo.
Cada endpoint de la API en la documentación incluye ejemplos prácticos que puedes copiar y usar directamente en tu entorno de desarrollo o en tus herramientas de pruebas. Los ejemplos de respuesta muestran tanto operaciones exitosas como escenarios de error comunes, ayudándote a implementar un manejo de errores adecuado en tus aplicaciones.
Lista de APIs por módulos:
- Autenticación:
- Iniciar sesión
- Renovación de token
- Cerrar sesión
- Usuario:
- Usuario: Listar, Crear, Actualizar, Eliminar,
- Rol: Lista
- Registro de usuario: Lista
- Usuarios del personal : Lista
- Usuarios cliente: Lista
- Usuarios del proveedor: Lista
- Almacén:
Actualización de perfil, Cambio de contraseña, Restablecer contraseña, Verificar
- Almacén: Listar, Crear, Detalle, Actualizar,
- Transferencia: Lista, Crear datos de solicitud,
- Producto y servicio:
Delete
Create, Delete
- Categoría de producto : List, Create, Update,
- Impuesto : Listar, Crear, Actualizar, Eliminar
- Unidad: Listar, Crear, Actualizar, Eliminar
- Producto: Listar, Crear, Detalle, Actualizar,
- Stock del producto : Listar, Agregar
- Producto de almacén: Lista
- Factura de compra:
Delete
Delete
- Factura: Listar, Crear, Detalle, Actualizar,
- Devolución de compra:
Eliminar, Publicar
- Devolución : Listar, crear, ver detalle, eliminar,
- Propuesta de venta:
Aprobar, Completar
- Propuesta: Listar, Crear, Detalle, Actualizar,
- Factura de venta:
Eliminar, Enviado, Aceptar, Rechazar, Convertir en factura
- Factura: Listar, Crear, Detalle, Actualizar,
- Devolución de factura de venta:
Eliminar, Publicar
- Devolución : Listar, crear, ver detalle, eliminar,
- Cuenta:
Aprobar, Completar
- Obtener clientes: Lista de clientes sencilla
- Obtener proveedores : Simple vendor list
- Cliente: Listar, Crear, Actualizar, Eliminar
- Proveedor: Listar, Crear, Actualizar, Eliminar
- Cuenta contable: Lista
- Cuenta bancaria: Listar, Crear, Actualizar, Eliminar
- Categorías de ingresos : Lista
- Ingresos: Listar, Crear, Actualizar, Eliminar,
- Categorías de gastos: Lista
- Gasto: Listar, Crear, Actualizar, Eliminar,
- Tipos de Cuenta : Lista
- Plan de cuentas: Lista
- Transacción bancaria: Lista
- Transferencia bancaria : Lista
- Pagos a proveedores : Lista
- Pagos de clientes: Lista
- Nota de crédito: Lista
- Nota de débito: Lista
- Proyecto:
Aprobar, Publicar
Aprobar, Publicar
- Proyecto: Listar, Crear, Detalle, Actualizar,
- Miembro del proyecto: Delete
- Cliente del proyecto: Listar, Invitar, Eliminar
- Hito del proyecto : List, Create, Update,
- Archivo del proyecto: Create, Delete
- Tarea: Tablero de Tareas, Crear, Detalle, Actualizar,
- Comentario de la tarea: Create, Delete
- Subtarea de tarea: Crear, Actualizar
- Estado del error : Lista
- Error: Listar, Crear, Detalle, Actualizar, Eliminar
- Comentario del error: Create, Delete
- Informe de proyecto: Lista, Detalle
- Etapa de la tarea: Listar, Ordenar, Crear, Actualizar,
- Etapa del error: Listar, Ordenar, Crear, Actualizar,
- TPV:
Delete
Delete
Delete
Delete
Delete
- Pedido : Lista, Detalle
- CRM :
- Pipeline: Listar, Crear, Actualizar, Eliminar
- Etapa del lead: Listar, Crear, Actualizar, Eliminar
- Etapa del trato: Listar, Crear, Actualizar, Eliminar
- Etiquetas: Listar, Crear, Actualizar, Eliminar
- Fuentes : Listar, Crear, Actualizar, Eliminar
- Cliente potencial: Listar, Crear, Detalle, Actualizar,
- Tarea del lead: Crear, actualizar, eliminar
- Usuario principal del lead: Create, Delete
- Producto principal: Create, Delete
- Origen del lead : Create, Delete
- Correo del Lead: Crear
- Debate del lead: Crear
- Lead File : Create, Delete
- Llamada de prospecto: Crear, actualizar, eliminar
- Trato: Listar, Crear, Detalle, Actualizar,
- Tarea del trato: Crear, actualizar, eliminar
- Usuario del trato : Create, Delete
- Producto de la oportunidad: Create, Delete
- Origen de la oportunidad: Create, Delete
- Correo del trato: Crear
- Discusión de la oportunidad: Crear
- Archivo del Trato : Create, Delete
- Deal Client : Create, Delete
- Llamada de negociación: Crear, actualizar, eliminar
- HRM :
Eliminar, Añadir etiqueta, Convertir en oportunidad
Eliminar, Agregar etiqueta
- Empleado : Listar, Crear, Detalle, Actualizar,
- Asistencia: Listar, Crear, Actualizar, Eliminar
- Tipos de permiso: Lista
- Solicitudes de permiso: List, Create, Update,
- Saldos de ausencias : Comprobar
- Nómina: Lista, Detalle
- Nómina: Generate
- Turnos: Lista
- Sucursales: Lista
- Departamentos: Lista
- Cargos : Lista
- Tipos de documento: Lista
- Días festivos: Lista
- Premios : Lista
- Promociones: Lista
- Renuncias: Lista
- Bajas: Lista
- Advertencias: Lista
- Reclamaciones : Lista
- Transferencias de empleados: Lista
- Documentos : Lista
- Agradecimientos: Lista
- Anuncios: Lista
- Eventos : Lista
Delete
Delete, Update Status