Desarrolladores · API REST

Construido sobre
Mewayz.

Una sola API REST para todo tu espacio de trabajo: CRM, ventas, facturación, contabilidad, proyectos, TPV, RR. HH. y más. 372 endpoints, JSON en todas partes y autenticación con token bearer. La misma referencia navegable está disponible dentro de la app en Configuración → Documentación de la API.

URL base · app.mewayz.com/api Auth · Token de portador Formato · JSON Endpoints · 372

Autenticación

Cada solicitud se autentica con un token bearer. Genera uno en tu panel, en Configuración → Claves API — se muestra una sola vez, así que cópialo en ese momento. Un token hereda los roles y permisos del usuario que lo creó, y la mayoría de los endpoints de recursos también requieren que el módulo correspondiente esté habilitado en tu plan.

Encabezado de autorización
# Pasa tu token en cada solicitud curl https://app.mewayz.com/api/leads \ -H "Authorization: Bearer 12|aZ8f3a...d92c" \ -H "Accept: application/json"

¿Prefieres autenticarte de forma programática? POST /api/login con tu correo y contraseña devuelve un token bearer que puedes usar de la misma manera, y POST /api/refresh lo rota.

Inicio rápido

Crea un cliente potencial en el CRM en menos de un minuto. La API funciona sobre los mismos datos que ves en el producto: no hay una capa de sincronización aparte.

POST /api/lead/create
curl -X POST https://app.mewayz.com/api/lead/create \ -H "Authorization: Bearer 12|aZ8f3a..." \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "name": "Ada Lovelace", "email": "[email protected]" }'

Errores y códigos de estado

Usamos códigos de estado HTTP convencionales. Los cuerpos de error incluyen un mensaje legible mensaje puedes mostrar directamente.

200OK — solicitud exitosa
201Creado — recurso creado
401No autorizado: token faltante o no válido
422No procesable: la validación falló
429Demasiadas solicitudes: has alcanzado un límite de frecuencia
500Error del servidor: lo tendremos activado estado

Límites de tasa

El tráfico de la API tiene un límite de frecuencia para mantener la plataforma rápida para todos. Si superas el límite, recibirás un HTTP 429 respuesta: reduce el ritmo y vuelve a intentarlo. El Retry-After el encabezado te indica cuándo puedes reanudar.

Autenticación y sesión /api/login

Inicia sesión, actualiza o revoca tu token, obtén el usuario conectado, edita el perfil y consulta las listas de usuarios del personal, clientes y proveedores. (11 puntos finales)

POST/api/change-password
OBTENER/api/client-user
ELIMINAR/api/delete-account
POST/api/edit-profile
POST/api/login
POST/api/logout
POST/api/refresh
OBTENER/api/staff-user
POST/api/upload-photos
OBTENER/api/user
OBTENER/api/vendor-user

Claves de API /api/v1/settings/api-keys

Lista, crea y revoca tus tokens de acceso personal: las mismas claves que generas en Configuración → Claves API. (3 endpoints)

OBTENER/api/v1/settings/api-keys
POST/api/v1/settings/api-keys
ELIMINAR/api/v1/settings/api-keys/{id}

CRM — leads, oportunidades y pipeline /api/leads

CRUD completo sobre leads, oportunidades, pipelines, etapas, etiquetas y fuentes, además de sus tareas, llamadas, archivos, notas y productos. (79 puntos finales)

ELIMINAR/api/deal-call/delete/{call_id}
POST/api/deal-call/store
POST/api/deal-call/update/{call_id}
POST/api/deal-client/store/{deal_id}
ELIMINAR/api/cliente-acuerdo/{id_acuerdo}/delete/{id_cliente}
POST/api/deal-discussion/store/{deal_id}
POST/api/deal-email/store/{deal_id}
POST/api/deal-file/store/{deal_id}
ELIMINAR/api/deal-file/{deal_id}/delete/{file_id}
POST/api/deal-source/store/{deal_id}
ELIMINAR/api/deal-source/{deal_id}/delete/{source_id}
POST/api/deal-stage/create
ELIMINAR/api/deal-stage/delete/{id}
POST/api/deal-stage/update/{id}
OBTENER/api/deal-stages
POST/api/deal-task/create
ELIMINAR/api/deal-task/delete/{id}
POST/api/deal-task/update/{id}
POST/api/usuario-oferta/store/{oferta_id}
ELIMINAR/api/deal-user/{deal_id}/delete/{user_id}
POST/api/deal/add-label/{id}
POST/api/deal/assign-products/{deal_id}
POST/api/deal/create
ELIMINAR/api/deal/delete/{id}
OBTENER/api/deal/show/{id}
POST/api/oferta/actualización/{id}
ELIMINAR/api/deal/{deal_id}/products/{product_id}
OBTENER/api/deals
POST/api/label/create
ELIMINAR/api/label/delete/{id}
POST/api/label/update/{id}
OBTENER/api/labels
ELIMINAR/api/lead-call/delete/{call_id}
POST/api/lead-call/store
POST/api/lead-call/update/{call_id}
POST/api/lead-discussion/store/{lead_id}
POST/api/lead-email/store/{lead_id}
POST/api/lead-file/store/{lead_id}
ELIMINAR/api/lead-file/{lead_id}/delete/{file_id}
POST/api/lead-source/store/{lead_id}
ELIMINAR/api/lead-source/{lead_id}/delete/{source_id}
POST/api/lead-stage/create
ELIMINAR/api/lead-stage/delete/{id}
POST/api/lead-stage/update/{id}
OBTENER/api/lead-stages
POST/api/lead-task/create
ELIMINAR/api/lead-task/delete/{id}
POST/api/lead-task/update/{id}
POST/api/lead-user/store/{lead_id}
ELIMINAR/api/lead-user/{lead_id}/delete/{user_id}
POST/api/lead/add-label/{id}
POST/api/lead/assign-products/{lead_id}
POST/api/lead/convert-to-deal/{id}
POST/api/lead/create
ELIMINAR/api/lead/delete/{id}
OBTENER/api/lead/get-request-data
OBTENER/api/lead/get-users
POST/api/lead/home
POST/api/lead/lead-create-update
POST/api/lead/lead-delete
POST/api/lead/lead-details
POST/api/lead/lead-stage-create-update
POST/api/lead/lead-stage-update
POST/api/lead/lead-stages
POST/api/lead/leadboard
POST/api/lead/pipeline-create-update
OBTENER/api/lead/pipelines
OBTENER/api/lead/show/{id}
POST/api/lead/update/{id}
ELIMINAR/api/lead/{lead_id}/products/{product_id}
OBTENER/api/leads
POST/api/pipeline/create
ELIMINAR/api/pipeline/delete/{id}
POST/api/pipeline/update/{id}
OBTENER/api/pipelines
POST/api/source/create
ELIMINAR/api/source/delete/{id}
POST/api/source/update/{id}
OBTENER/api/sources

Ventas /api/sales/sales-orders

Oportunidades, presupuestos, reuniones, pedidos de venta y consultas de almacén. (23 endpoints)

OBTENER/api/sales/RequestData
POST/api/sales/get-warehouse-products
OBTENER/api/sales/home
ELIMINAR/api/sales/meeting/destroy/{id}
POST/api/ventas/reunión/tienda
POST/api/sales/meeting/update/{id}
OBTENER/api/ventas/reuniones
OBTENER/api/sales/opportunities
ELIMINAR/api/sales/opportunities/delete/{id}
POST/api/ventas/oportunidades/actualización/{id}
POST/api/sales/opportunitity/store
POST/api/sales/parent-records
OBTENER/api/sales/quotes
ELIMINAR/api/sales/quotes/destroy/{id}
POST/api/sales/quotes/store
POST/api/sales/quotes/update/{id}
OBTENER/api/sales/quotes/{id}
ELIMINAR/api/sales/sales-order/delete/{id}
POST/api/sales/sales-order/store
POST/api/sales/sales-order/update/{id}
OBTENER/api/sales/sales-orders
OBTENER/api/sales/sales-orders/{id}
OBTENER/api/sales/warehouses

Propuestas comerciales /api/sales-proposal

Redacta, envía, acepta/rechaza propuestas y conviértelas en facturas. (9 endpoints)

OBTENER/api/sales-proposal
POST/api/sales-proposal/accept/{proposal_id}
POST/api/sales-proposal/convert-to-invoice/{proposal_id}
POST/api/propuesta-de-ventas/create
ELIMINAR/api/propuesta-de-venta/delete/{proposal_id}
POST/api/sales-proposal/reject/{proposal_id}
POST/api/sales-proposal/sent/{proposal_id}
OBTENER/api/sales-proposal/show/{proposal_id}
POST/api/sales-proposal/update/{proposal_id}

Facturas de venta /api/sales-invoice

Lista, crea, actualiza, elimina y contabiliza facturas de venta. (6 endpoints)

OBTENER/api/sales-invoice
POST/api/sales-invoice/create
ELIMINAR/api/factura-venta/delete/{invoice_id}
POST/api/sales-invoice/post/{invoice_id}
OBTENER/api/sales-invoice/show/{invoice_id}
POST/api/sales-invoice/update/{invoice_id}

Devoluciones de facturas de venta /api/sales-invoice-return

Crea, aprueba y completa devoluciones de facturas de venta. (6 endpoints)

OBTENER/api/sales-invoice-return
POST/api/sales-invoice-return/approve/{return_id}
POST/api/sales-invoice-return/complete/{return_id}
POST/api/sales-invoice-return/create
ELIMINAR/api/sales-invoice-return/delete/{return_id}
OBTENER/api/sales-invoice-return/show/{return_id}

Facturas de compra /api/purchase-invoice

Lista, crea, actualiza, elimina y registra facturas de compra. (6 endpoints)

OBTENER/api/purchase-invoice
POST/api/purchase-invoice/create
ELIMINAR/api/purchase-invoice/delete/{invoice_id}
POST/api/purchase-invoice/post/{invoice_id}
OBTENER/api/purchase-invoice/show/{invoice_id}
POST/api/purchase-invoice/update/{invoice_id}

Devoluciones de compras /api/purchase-return

Crea, aprueba y completa devoluciones de compra. (6 endpoints)

OBTENER/api/purchase-return
POST/api/purchase-return/approve/{return_id}
POST/api/compra-devolución/completa/{return_id}
POST/api/purchase-return/create
ELIMINAR/api/purchase-return/delete/{return_id}
OBTENER/api/purchase-return/show/{return_id}

Contabilidad /api/chart-of-accounts

Clientes, proveedores, cuentas bancarias, plan de cuentas, ingresos, gastos, pagos, notas de crédito/débito y transferencias. (37 endpoints)

OBTENER/api/account-types
OBTENER/api/bank-accounts
POST/api/bank-accounts/create
ELIMINAR/api/bank-accounts/delete/{id}
POST/api/bank-accounts/update/{id}
OBTENER/api/bank-transactions
OBTENER/api/transferencias-bancarias
OBTENER/api/chart-of-accounts
OBTENER/api/credit-notes
OBTENER/api/customer-payments
OBTENER/api/customers
POST/api/customers/create
ELIMINAR/api/customers/delete/{id}
POST/api/customers/update/{id}
OBTENER/api/debit-notes
OBTENER/api/expense-categories
OBTENER/api/expenses
POST/api/expenses/approve/{id}
POST/api/expenses/create
ELIMINAR/api/expenses/delete/{id}
POST/api/expenses/post/{id}
POST/api/expenses/update/{id}
OBTENER/api/get-clients
OBTENER/api/get-vendors
OBTENER/api/gl-accounts
OBTENER/api/revenue-categories
OBTENER/api/revenues
POST/api/revenues/approve/{id}
POST/api/revenues/create
ELIMINAR/api/ingresos/delete/{id}
POST/api/revenues/post/{id}
POST/api/revenues/update/{id}
OBTENER/api/vendor-payments
OBTENER/api/vendors
POST/api/vendors/create
ELIMINAR/api/vendors/delete/{id}
POST/api/vendors/update/{id}

Productos y servicios /api/products

Productos, categorías, impuestos, unidades y stock. (20 endpoints)

OBTENER/api/product-service/items
POST/api/product-stock/add
OBTENER/api/product-stocks
OBTENER/api/product/category
POST/api/product/category/create
ELIMINAR/api/product/category/delete/{id}
POST/api/product/category/update/{id}
POST/api/product/create
ELIMINAR/api/product/delete/{id}
OBTENER/api/product/detail/{id}
POST/api/product/update/{id}
OBTENER/api/products
OBTENER/api/tax
POST/api/tax/create
ELIMINAR/api/tax/delete/{id}
POST/api/tax/update/{id}
POST/api/unit/create
ELIMINAR/api/unit/delete/{id}
POST/api/unit/update/{id}
OBTENER/api/units

Almacén e inventario /api/almacén

Almacenes y transferencias de existencias. (9 endpoints)

OBTENER/api/transfer
POST/api/transfer/crear
ELIMINAR/api/transfer/delete/{transfer_id}
OBTENER/api/transfer/request-data
OBTENER/api/almacén
POST/api/warehouse/create
ELIMINAR/api/warehouse/delete/{warehouse_id}
OBTENER/api/warehouse/product/{warehouse_id}
POST/api/warehouse/update/{warehouse_id}

Proyectos, tareas y errores /api/projects

Proyectos, hitos, tableros de tareas, tareas, subtareas, errores e informes. (45 endpoints)

OBTENER/api/bug-status-list
OBTENER/api/get-projects
POST/api/project/bug-stage/create
ELIMINAR/api/project/bug-stage/delete/{id}
POST/api/project/bug-stage/order
POST/api/project/bug-stage/update/{id}
OBTENER/api/project/bug-stages
POST/api/project/bug/create/{project_id}
OBTENER/api/project/bug/show/{bug_id}
POST/api/project/bug/{bug_id}/comment/create
ELIMINAR/api/project/bug/{id}/comment/delete
OBTENER/api/project/bug/{project_id}
ELIMINAR/api/project/client/delete/{id}
POST/api/project/client/invite
OBTENER/api/project/clients
ELIMINAR/api/project/delete/{id}
POST/api/project/file/create
ELIMINAR/api/project/file/delete/{id}
ELIMINAR/api/project/member/delete/{id}
POST/api/project/milestone/create
ELIMINAR/api/project/milestone/delete/{id}
POST/api/project/milestone/update/{id}
OBTENER/api/project/milestones
OBTENER/api/project/report/{id}
OBTENER/api/project/reports
OBTENER/api/project/show/{id}
POST/api/project/task-stage/create
ELIMINAR/api/project/task-stage/delete/{id}
POST/api/project/task-stage/order
POST/api/project/task-stage/update/{id}
OBTENER/api/project/task-stages
POST/api/project/task-subtask/create/{task_id}
POST/api/project/task-subtask/update/{subtask_id}
ELIMINAR/api/project/task/comment/delete/{comment_id}
OBTENER/api/project/task/show/{id}
POST/api/project/task/{task_id}/comment/create
POST/api/project/update/{id}
OBTENER/api/project/{id}/task-board
POST/api/project/{id}/task/create
POST/api/project/{id}/task/update/{task_id}
ELIMINAR/api/project/{project_id}/bug/delete/{bug_id}
POST/api/project/{project_id}/bug/update/{bug_id}
ELIMINAR/api/project/{project_id}/task/delete/{task_id}
OBTENER/api/projects
POST/api/projects/create

Punto de venta /api/pos

Pedidos de TPV y detalle de pedidos. (2 endpoints)

OBTENER/api/pos
OBTENER/api/pos/show/{id}

Mesa de soporte /api/support-ticket/tickets

Tickets y respuestas, preguntas frecuentes y artículos de la base de conocimientos. (16 endpoints)

POST/api/support-ticket/faq/delete/{faq_id}
POST/api/support-ticket/faq/update/{faq_id}
OBTENER/api/support-ticket/faqs
POST/api/support-ticket/faqs/store
OBTENER/api/support-ticket/get-request-data
OBTENER/api/support-ticket/home
POST/api/support-ticket/knowledge/delete/{knowledge_id}
POST/api/support-ticket/knowledge/store
POST/api/support-ticket/knowledge/update/{knowledge_id}
OBTENER/api/support-ticket/knowledges
POST/api/support-ticket/ticket/add-reply/{ticket_id}
POST/api/support-ticket/ticket/delete/{ticket_id}
POST/api/support-ticket/ticket/note/store/{ticket_id}
POST/api/support-ticket/ticket/store
POST/api/support-ticket/ticket/update/{ticket_id}
OBTENER/api/support-ticket/tickets

Taskly /api/taskly/projects

Proyectos y tareas de Taskly para el módulo ligero de proyectos. (18 endpoints)

OBTENER/api/taskly/home
POST/api/taskly/project-activity
POST/api/taskly/project-create-update
POST/api/taskly/project-delete
POST/api/taskly/project-details
ELIMINAR/api/taskly/project-file-delete/{id}
POST/api/taskly/project-file-upload
POST/api/taskly/project-list
POST/api/taskly/project-status-update
OBTENER/api/taskly/projects
OBTENER/api/taskly/projects/{project}/tasks
POST/api/taskly/task-create-update
POST/api/taskly/task-delete
POST/api/taskly/task-details
POST/api/taskly/task-list
POST/api/taskly/task-stage-update
POST/api/taskly/taskboard
OBTENER/api/taskly/users

Control de tiempo /api/add-tracker

Inicia y detén los contadores de tiempo. (3 endpoints)

POST/api/add-tracker
POST/api/stop-tracker
POST/api/tracker-login

Usuarios y roles /api/users

Administra los usuarios del espacio de trabajo y consulta los roles. (8 endpoints)

OBTENER/api/roles
ELIMINAR/api/user/delete/{id}
POST/api/user/reset-password/{id}
POST/api/user/store
POST/api/user/update/{id}
PUT/api/user/verify/{id}
OBTENER/api/users
OBTENER/api/users/log

RR. HH. y nóminas /api/employees

Empleados, asistencia, permisos, nómina, además del conjunto completo de registros de RR. HH. (sucursales, departamentos, días festivos, premios y más). (44 endpoints)

OBTENER/api/acknowledgments
OBTENER/api/announcements
POST/api/attendance/create
ELIMINAR/api/attendance/delete/{attendance_id}
POST/api/attendance/update/{attendance_id}
OBTENER/api/attendances
OBTENER/api/awards
OBTENER/api/branches
OBTENER/api/quejas
OBTENER/api/departments
OBTENER/api/designations
OBTENER/api/document-types
OBTENER/api/employee-transfers
POST/api/employee/create
ELIMINAR/api/employee/delete/{id}
OBTENER/api/employee/show/{id}
POST/api/employee/update/{id}
OBTENER/api/employees
OBTENER/api/eventos
OBTENER/api/holidays
OBTENER/api/hrm-documents
POST/api/hrm/attendence-history
POST/api/hrm/clock-in-out
POST/api/hrm/events
OBTENER/api/hrm/get-leaves
OBTENER/api/hrm/get-leaves-types
OBTENER/api/hrm/holidays-list
OBTENER/api/hrm/home
POST/api/hrm/solicitud de licencia
POST/api/leave-application/create
ELIMINAR/api/leave-application/delete/{leaveapplication_id}
POST/api/leave-application/update-status/{leaveapplication_id}
POST/api/leave-application/update/{leaveapplication_id}
OBTENER/api/leave-applications
OBTENER/api/leave-balances
OBTENER/api/leave-types
OBTENER/api/payrolls
OBTENER/api/nóminas/{payroll_id}
OBTENER/api/payslip/{payroll_entry_id}
OBTENER/api/promotions
OBTENER/api/resignations
OBTENER/api/shifts
OBTENER/api/terminations
OBTENER/api/warnings

API de terceros (v1) /api/v1/customers

Una porción estable y versionada, diseñada para herramientas sin código como Zapier: clientes y facturas. (7 endpoints)

OBTENER/api/v1/customers
POST/api/v1/customers
OBTENER/api/v1/customers/{id}
PUT/api/v1/customers/{id}
OBTENER/api/v1/invoices
POST/api/v1/invoices
OBTENER/api/v1/invoices/{id}

Endpoints públicos /api/public/plans

Ayudantes sin autenticación: el catálogo público de planes y el widget integrable de captación de leads y la insignia de socio. (4 endpoints)

OBTENER/api/badge/{token}
OBTENER/api/public/plans
POST/api/widget/lead
OBTENER/api/widget/{token}

Plataforma de marca blanca /api/wl/plans

Endpoints de servidor a servidor utilizados por las instancias de marca blanca para facturación y Stripe Connect (autenticados por token). (6 endpoints)

POST/api/wl/checkout
POST/api/wl/connect/onboard
OBTENER/api/wl/connect/status
OBTENER/api/wl/plans
POST/api/wl/subscription/{stripe_subscription_id}/cancel
POST/api/wl/webhook-callback

Endpoints de integración /api/microsofttodo

Endpoints auxiliares para las integraciones conectadas (Microsoft To Do, Vonage SMS, publicaciones de Facebook). (3 endpoints)

OBTENER/api/facebookpost
OBTENER/api/microsofttodo
OBTENER/api/vonagesms

Más endpoints

Endpoints registrados adicionales. (1 endpoint)

OBTENER/api/agents/{agent}/outstanding-commissions