La API de Mercately te permite conectar tus aplicaciones, CRM, ERP, eCommerce o cualquier sistema propio con la plataforma para automatizar procesos, sincronizar información y desarrollar integraciones personalizadas.
📌 Importante: Antes de consumir cualquier endpoint de la API es necesario generar una API Key desde Mercately, ya que será utilizada para autenticar todas las solicitudes.
Si aún no sabes cómo generar tu API Key, te invitamos a consultar la siguiente guía:
¿Qué puedes hacer con la API?
La API está organizada por módulos para que puedas integrar únicamente las funcionalidades que necesites.
👤 Agentes
Obtén el listado de agentes registrados dentro de tu cuenta de Mercately para asignaciones, reportes o integraciones.
Funciones principales
Consultar agentes.
👥 Clientes
Administra toda la información de tus clientes desde sistemas externos.
Funciones principales
Consultar clientes.
Crear clientes.
Actualizar clientes.
Buscar por ID, correo o teléfono.
💬 Conversaciones
Consulta el historial de conversaciones de tus clientes.
Canales disponibles
WhatsApp
Messenger
Instagram
📌 Importante: Las conversaciones únicamente pueden consultarse para el Retailer (cuenta de Mercately) autenticado mediante la API. No es posible obtener conversaciones pertenecientes a otros retailers.
💼 Negociaciones (Deals)
Administra el ciclo de vida de tus oportunidades comerciales.
Funciones principales
Consultar negociaciones.
Crear negociaciones.
Actualizar negociaciones.
Eliminar negociaciones.
🤵Messenger
Obtén los clientes que te han escrito por Messenger
Funciones principales
Consultar clientes.
Permite interactuar con WhatsApp desde aplicaciones externas.
Funciones principales
Consultar plantillas.
Enviar mensajes mediante WhatsApp Business API.
Enviar mensajes mediante integración QR.
⚙️ Automatizaciones (Flows)
Administra los flujos automatizados de Mercately.
Funciones principales
Consultar Flows.
Desactivar Flows.
Preactivar Flows V2.
🛒 Órdenes
Gestiona las órdenes creadas desde Mercately.
Funciones principales
Consultar órdenes.
Crear órdenes.
Actualizar órdenes.
Eliminar órdenes.
📦 Productos
Administra el catálogo completo de productos.
Funciones principales
Consultar productos.
Crear productos.
Actualizar productos.
Eliminar productos.
🎨 Variantes
Gestiona las variantes de tus productos.
Funciones principales
Crear variantes.
Consultar variantes.
Actualizar variantes.
Eliminar variantes.
🗂️ Categorías
Administra categorías y subcategorías del catálogo.
Funciones principales
Consultar categorías.
Crear categorías.
Actualizar categorías.
Eliminar categorías.
📅 Eventos del Cliente
Registra eventos personalizados asociados a cada cliente.
Funciones principales
Registrar eventos.
Consultar historial de eventos.
📊 Estadísticas
Obtén información para construir reportes o dashboards personalizados.
Funciones principales
Estadísticas por canal.
Estadísticas por embudo.
Métricas de rendimiento.
Indicadores comerciales.
Arquitectura REST
La API utiliza el estándar REST, permitiendo integrarse fácilmente desde cualquier lenguaje de programación.
Métodos disponibles
GET → Consultar información.
POST → Crear registros.
PUT → Actualizar registros completos.
PATCH → Actualizar información parcial.
DELETE → Eliminar registros.
Las respuestas son entregadas en formato JSON utilizando códigos HTTP estándar.
💡 Recomendaciones
Antes de comenzar tu integración recomendamos:
Revisar la documentación oficial.
Validar la autenticación requerida.
Realizar pruebas en un ambiente de desarrollo.
Implementar manejo de errores HTTP.
Validar el formato JSON esperado por cada endpoint.
Revisar la documentación junto con un equipo de desarrollo para una implementación más eficiente. Esto facilitará la comprensión de cada recurso y permitirá realizar una integración más rápida y segura con Mercately.
🔗 Portal para Desarrolladores
Allí encontrarás la documentación actualizada de todos los recursos disponibles, ejemplos de uso y especificaciones técnicas para facilitar la integración con Mercately.
🤝 ¿Necesitas ayuda?
Si tienes dudas o deseas acompañamiento durante el proceso:
💬 Chat en vivo: disponible desde tu plataforma Mercately
📧 Correo: [email protected]
Nuestro equipo estará encantado de ayudarte 😊