Documentación API

5 min Avanzado
Volver a Configuración

¿Qué es la Documentación API?

La página de Documentación API es la referencia integrada para conectar tus propios sistemas a ChatCenter: enviar mensajes de WhatsApp, gestionar productos y pedidos, usar SMS, horarios, citas y más.

Bueno saber: Ábrela desde el menú de tu perfil: Configuración > Documentación API.
Nota: Solo el dueño de la cuenta puede abrir esta sección. Es distinta de Automatizaciones externas, que envían eventos a n8n/Make/Zapier sin que tú programes llamadas API.

Botones superiores en la página de Documentación API

Ayuda

Abre esta guía en una pestaña nueva

Diseño de la página

La página tiene dos zonas:

  • Quick Navigation (left): Menú plegable con enlaces a cada tema. Al pulsar un enlace, saltas a esa sección a la derecha.
  • Content panels (right): Tarjetas con método, URL, cuerpo de la petición, parámetros, respuestas y ejemplos listos para copiar.

El bloque URL base muestra la dirección de tu instalación con /api/ al final. Usa ese prefijo en todas las llamadas.

Autenticación (dos métodos)

La página de documentación indica que distintas llamadas usan credenciales diferentes:

1. Mensajes de WhatsApp y tienda
  • Usa el token de acceso de tu cuenta WhatsApp en la cabecera Authorization como Bearer TOKEN.
  • Si tienes WhatsApp conectado, el token aparece arriba en la sección Autenticación.
  • Si no hay cuenta conectada, verás un aviso para conectar WhatsApp primero.
  • Aplica a: envío de mensajes, plantillas Meta, productos, carrito, pedidos, categorías, marcas y analíticas.
2. Llamadas de SMS, horarios y citas
  • Requieren un token de sesión de usuario obtenido al iniciar sesión mediante el endpoint de login de la API.
  • Copia el token de la respuesta de login y envíalo como Bearer TOKEN con Accept: application/json.
  • Estos módulos también dependen de tu plan y de los permisos de tu usuario.
Bueno saber: Los ejemplos de cabeceras para ambos métodos están en la tarjeta Autenticación de la página de documentación.

Secciones en la navegación rápida

Envío de mensajes

Texto, imagen, documento, video, audio, ubicación, plantilla, producto de tienda y producto de catálogo

Plantillas Meta (WhatsApp)

Listar, ver y crear plantillas; incluye tablas de IDs de categoría e idioma

Productos

Listar productos de tienda y catálogo; crear, actualizar y eliminar productos

Carrito y pedidos

Operaciones de carrito, listar y crear pedidos, actualizar estado del pedido

Categorías y marcas

Listar categorías y marcas de productos

Analíticas

Analíticas de productos y ventas con filtros de fecha

SMS

Panel, envío, historial, estadísticas, campañas y paquetes

Agenda

Listar horarios, crear, disponibilidad y calendario

Citas

Listar, crear, cambiar estado y consultar disponibilidad

Chatbot avanzado

Intenciones, artículos de base de conocimiento y análisis de sentimiento

Referencia

Códigos de error y ejemplos listos para usar (cURL, JavaScript)

Nota: Las secciones de ecommerce, SMS, horarios, citas y chatbot avanzado solo aplican si esos módulos están activos en tu cuenta y tu usuario tiene los permisos necesarios.

Cómo usar la documentación

  1. Abre Documentación API desde Configuración en el menú de tu perfil.
  2. Lee Autenticación y copia tu token de acceso de WhatsApp si necesitas mensajería o tienda.
  3. Para SMS, horarios o citas, obtén un token de usuario con el login que describe la página.
  4. Usa Navegación rápida para encontrar la operación que necesitas.
  5. Copia URL, cabeceras y cuerpo de la tarjeta a tu herramienta o aplicación.
  6. Consulta la sección Referencia para códigos de error y peticiones de ejemplo.

Envío de mensajes de WhatsApp por API

La mayoría de tipos de mensaje usan el mismo endpoint POST /api/whatsapp/send con distintos campos en el cuerpo (texto, URL de archivo, nombre de plantilla, etc.). La documentación muestra una tarjeta por tipo con el JSON exacto.

Enviar productos de tienda o catálogo usa endpoints dedicados descritos en Envío de mensajes y Productos.

Solución de problemas

  • No aparece el token de WhatsApp: Conecta una cuenta en Configuración > Cuentas WhatsApp primero.
  • Error 401 (token inválido): Usa el token correcto: token de WhatsApp para mensajes/tienda; token de usuario para SMS/horarios/citas.
  • Error 404 (no encontrado): Revisa ID de producto, pedido o vinculación de cuenta en la petición.
  • Error 422 (validación): Compara tu petición con la tabla de parámetros de la tarjeta de documentación.
  • Falta una sección en el menú: El módulo puede no estar en tu plan o tu rol no tiene acceso.
  • Falla crear plantilla: Usa category_id y language_id de las tablas de la tarjeta Crear plantilla Meta; las plantillas carrusel solo se crean desde el panel.

Consejos

  • Mantén los tokens en privado; no los publiques en sitios web
  • Usa siempre HTTPS con la URL base que muestra la página
  • Prueba con los ejemplos cURL de Referencia antes de usar en producción
  • Al crear plantillas, usa los IDs de categoría e idioma de las tablas de la documentación
  • Usa Automatizaciones externas si solo necesitas avisos de eventos sin programar API

Errores frecuentes

  • Usar el token de WhatsApp para endpoints de SMS o citas
  • Buscar URLs distintas para cada tipo de archivo — casi todos comparten POST /api/whatsapp/send
  • Buscar gestión de contactos en esta página — no está en la documentación API actual
  • Confundir Documentación API con Automatizaciones externas o Integraciones de ecommerce
  • Crear plantillas carrusel por API — deben crearse en el panel

Secciones relacionadas

Automatizaciones externas

Enviar eventos a n8n, Make o Zapier sin escribir integraciones API

Cuentas de WhatsApp

Conectar WhatsApp para obtener el token usado en los endpoints de mensajería

Podemos utilizar cookies cuando accedes a nuestro sitio web, incluyendo cualquier plataforma de medios relacionada o aplicaciones móviles. Estas tecnologías se emplean para mejorar la funcionalidad del sitio y optimizar tus interacciones con nuestros servicios.