DOCUMENTACION API SMARTCHAT
INTRODUCCIÓN PARA PARTNERS EXTERNOS
Propósito de la API
La API está diseñada para que un sistema externo pueda crear y actualizar contactos, etiquetarlos, activar flujos automatizados, gestionar oportunidades en pipelines y manejar carritos y pedidos de ecommerce sin usar la interfaz web de Smartchat. Esto facilita integraciones con CRMs, ERPs, plataformas de ecommerce y herramientas internas que necesite sincronizar datos de clientes y ventas en tiempo real.
Recursos principales disponibles
La API se organiza en cuatro grupos de recursos:
- Accounts: configuración de cuenta, administradores, etiquetas, flujos y campos personalizados globales.
- Contacts: creación y consulta de contactos, gestión de tags, campos personalizados y envío de mensajes o flujos.
- Pipelines: administración de pipelines, etapas, oportunidades y comentarios de seguimiento comercial.
- Ecommerce: carritos, productos y pedidos asociados a contactos para flujos de venta conversacional.
Autenticación y seguridad
El acceso a la API se realiza mediante una API key que identifica de forma única a la cuenta del partner y define sus permisos de uso. Todas las peticiones deben hacerse sobre HTTPS, y se recomienda almacenar la API key de forma segura en el backend del partner, nunca en código público ni frontends, para proteger datos de contactos y operaciones comerciales.
Casos de uso típicos para partners
Un partner puede, por ejemplo, sincronizar automáticamente leads creados en su CRM hacia Smartchat, mover oportunidades entre etapas de un pipeline a partir de acciones en otra herramienta, o disparar envíos de productos y enlaces de pago cuando se complete una acción en un sistema externo. De esta manera, la API actúa como capa de integración que mantiene alineados los datos de clientes, conversaciones y ventas entre Smartchat y las soluciones del partner.
Powered by