Referencia de la API Central de Sellia
Esta API de comunicación unificada abstrae la complejidad de múltiples canales. Permite a los desarrolladores gestionar conversaciones con clientes usando los conceptos de Canal, Cliente y Plantilla.
Objetivo Principal
El objetivo de esta API es ofrecer una plataforma de comunicación unificada y de alto nivel que abstrae la complejidad de múltiples canales de mensajería. En lugar de interactuar directamente con la API de cada proveedor (como Meta o Telegram), el desarrollador interactúa con los conceptos generalizados de "Canal", "Cliente" y "Plantilla" de Sellia. Su propósito es gestionar el ciclo de vida completo de las conversaciones con clientes, sin importar el canal subyacente.
Utilidad Práctica
La utilidad de esta guía es para desarrolladores que están construyendo una aplicación de gestión de clientes o un centro de comunicaciones omnicanal. Es ideal para:
Crear una bandeja de entrada compartida
Centralizar en una sola interfaz las conversaciones de WhatsApp, Telegram y otros posibles canales.
Gestionar agentes y conversaciones
Permite recuperar historiales de chat por cliente y cerrar sesiones, facilitando el trabajo de los equipos de soporte.
Simplificar el desarrollo multicanal
Enviar mensajes y campañas a través de diferentes plataformas usando una sola integración de API, reduciendo el tiempo y la complejidad del desarrollo.
Integración con CRMs
Funciona como el backend perfecto para un CRM, conectando los perfiles de los clientes con su historial de comunicación en diferentes plataformas.
Tokens de Acceso
La API utiliza tokens de acceso JWT (JSON Web Token) para autenticar las solicitudes. Para obtener un token, debes realizar una solicitud POST al endpoint /login/manager con tu username y password.
Este token debe ser incluido en la cabecera Authorization de todas las solicitudes posteriores como un token de portador (Bearer Token). Ejemplo: Authorization: Bearer <tu_token_jwt>. Dado que estos tokens tienen una vida útil limitada, asegúrate de gestionar su renovación cuando expiren.
Paginación
Los endpoints que devuelven listas, como el historial de mensajes (GET /messages/{CLIENT_ID}), utilizan paginación basada en cursor. Para navegar a través de los resultados, puedes usar el parámetro opcional LAST_MESSAGE_ID en tu solicitud para indicar el último mensaje que recibiste, obteniendo así el siguiente conjunto de resultados en la lista.
Secciones
Esta sección describe cómo obtener acceso seguro a la API. El proceso consiste en enviar un nombre de usuario y una contraseña al endpoint de login para recibir un token de acceso (JWT). Este token debe incluirse en todas las solicitudes posteriores para validar la identidad y los permisos.
Aquí se agrupan todas las funciones relacionadas con la comunicación directa. Permite enviar y recibir mensajes de distintos tipos, como texto, imágenes, videos, documentos y ubicaciones. También incluye la capacidad de consultar el historial de una conversación y cerrar una sesión de chat activa.
Se refiere a la gestión de las plataformas de comunicación. A través de esta sección, es posible crear y consultar los canales que la empresa utiliza para interactuar con sus clientes, como pueden ser cuentas de WhatsApp.
Esta funcionalidad permite administrar mensajes predefinidos y reutilizables. Incluye endpoints para crear, consultar y enviar plantillas que pueden contener variables o marcadores de posición (placeholders) para personalizar la comunicación a gran escala.
Los modelos definen la estructura de los datos que se intercambian con la API. Describen el formato exacto (esquema) de los objetos en las solicitudes y respuestas, como la estructura de un objeto Message, Channel o Template, asegurando que la comunicación entre sistemas sea consistente.
La documentación de API ofrece una solución integral que abstrae la complejidad de la comunicación omnicanal. Permite a los desarrolladores construir aplicaciones de gestión de clientes de forma más rápida y eficiente sobre una única plataforma unificada.
Last updated