Artículo de ayuda · Waclis

API REST de Cuenta y Client API: autenticación, tokens y endpoints principales

La API REST Universal de Waclis Inbox permite integrar programáticamente cualquier backend corporativo, ERP, CRM o aplicación móvil con tu operación omnicanal. Mediante peticiones HTTPS en formato JSON, puedes administrar contactos, conversaciones, mensajes, tarjetas Kanban y tareas, o conectar un canal propio mediante una bandeja de tipo Canal API.

Qué puedes hacer

  • Autenticar llamadas backend enviando tu Token de acceso personal en la cabecera HTTP api_access_token.
  • Crear una bandeja Canal API en Ajustes > Entradas > + Añadir bandeja de entrada > API para integrar aplicaciones móviles o portales propios.
  • Operar recursos de cuenta con la Application API (/api/v1/accounts/{account_id}/...) sobre /contacts, /conversations, /messages, /kanban_items y /tasks.
  • Construir chats para clientes finales con la Client API (/public/api/v1/inboxes/{inbox_identifier}/...) sin exponer tokens administrativos.
  • Manejar paginación y códigos HTTP (200, 401, 404, 422, 429) con control de errores estándar.

Cuándo conviene usarla

  • Notificaciones y mensajes transaccionales: Cuando un sistema externo debe iniciar o responder una conversación automáticamente.
  • Sincronización de clientes (CRM / ERP): Para dar de alta o actualizar fichas en /api/v1/accounts/{account_id}/contacts junto con sus atributos personalizados.
  • Gestión programática de ventas y tareas: Para crear oportunidades en /kanban_items o recordatorios en /tasks desde un sistema comercial.
  • Chat nativo en tu propia app: Cuando usas un Canal API y la Client API (/public/api/v1/inboxes/{inbox_identifier}/...) dentro de tu aplicación móvil o web.

Disponibilidad por plan

  • Plan Estándar: Incluye Token de acceso, Application API (/api/v1/accounts/{account_id}/...), Client API (/public/api/v1/inboxes/...) y creación de bandejas Canal API.
  • Plan Premium: Añade operación programática de bots de agentes, automatizaciones avanzadas y embudos comerciales.
  • Plan Evolución: Incorpora conectividad mediante Servidor MCP y capacidades avanzadas de auditoría y gobierno.

Requisitos previos

  1. Cuenta activa en Waclis Inbox con permisos acordes al endpoint (Administrador o Agente).
  2. Identificador numérico account_id, visible en la URL del navegador (la URL de tu cuenta en el navegador).
  3. Peticiones sobre HTTPS con cabecera Content-Type: application/json; charset=utf-8.

Cómo funciona en Waclis Inbox paso a paso

Parte 1: Obtener el Token de acceso personal

  1. Haz clic en tu avatar abajo a la izquierda y abre Ajustes de perfil.
  2. Desplázate hasta la sección Token de acceso.
  3. Pulsa Copiar para obtener la clave (o regénérala si necesitas rotar credenciales).
  4. En tus llamadas a /api/v1/accounts/{account_id}/..., envía la cabecera api_access_token: TU_TOKEN.

Parte 2: Crear una bandeja de tipo Canal API

  1. Ve a Ajustes > Entradas y haz clic en + Añadir bandeja de entrada.
  2. Selecciona el ícono API (Canal API).
  3. Define el Nombre del canal y la URL del webhook donde recibirás las respuestas de los agentes.
  4. Asigna los agentes con permiso y finaliza la creación.
  5. Copia el inbox_identifier en la configuración de la bandeja si utilizarás la Client API.

Opciones y configuraciones disponibles

Resumen de las dos familias de endpoints y los códigos HTTP principales:

Recurso / Código Ruta o Cabecera Propósito técnico
Cabecera de autenticación api_access_token: <token> Autentica llamadas a la Application API (/api/v1/accounts/{account_id}/...).
Contactos /api/v1/accounts/{account_id}/contacts Listar, buscar (/contacts/search), crear o actualizar clientes.
Conversaciones y Mensajes /api/v1/accounts/{account_id}/conversations y /messages Abrir hilos, cambiar estados y enviar mensajes o notas privadas.
Kanban y Tareas /api/v1/accounts/{account_id}/kanban_items y /tasks Crear y mover tarjetas del embudo comercial y tareas operativas.
Client API (Pública) /public/api/v1/inboxes/{inbox_identifier}/contacts/... Permite que el cliente final gestione su propia sesión y mensajes.
Códigos 200 / 401 / 404 Estado HTTP 200 OK (éxito), 401 Unauthorized (token inválido), 404 Not Found (recurso inexistente).
Códigos 422 / 429 Validación y Rate Limit 422 Unprocessable Entity (datos inválidos), 429 Too Many Requests (límite superado).

Alternativas y cuándo elegir cada una

Familia / Herramienta Nivel de acceso Cuándo elegirla
Application API (/api/v1/accounts/...) Nivel cuenta (según rol del api_access_token). Integraciones servidor a servidor con tu ERP, CRM o backend.
Client API (/public/api/v1/inboxes/...) Acotado al contacto (inbox_identifier + contact_identifier). Aplicaciones móviles o portales web ejecutados del lado del usuario final.
Servidor MCP Herramientas para agentes de IA. Para conectar modelos de IA externos sin codificar llamadas REST manuales.

Cómo se combina con otras funciones

  • Webhooks salientes: Escuchas eventos en tiempo real por Webhook y llamas a la API REST solo cuando necesitas ejecutar una acción o consulta.
  • Atributos personalizados: Los endpoints de /contacts y /conversations reciben el objeto custom_attributes para inyectar datos de negocio.
  • Bots de agentes (Agent Bots): Usan tokens de bot para responder chats y pasarlos a estado open.

Relación con otros productos Waclis

  • En Waclis Inbox (Nativo): La API REST opera los recursos nativos de Inbox (contactos, chats, mensajes, Kanban y tareas).
  • Con el ecosistema Waclis (Waclis Connect, WaclisPOS, Waclis Factur, WaclisCAL y Waclis Reach): Waclis Connect gobierna la identidad y sesión única entre aplicaciones manteniendo el aislamiento de datos por organización. Para integrar sistemas externos o articular flujos programáticos con herramientas como Waclis Reach, WaclisPOS o tu propio ERP, puedes utilizar la API REST de Cuenta y los Webhooks.
  • Con panel.waclis.com: Los planes y asientos de la cuenta se administran desde panel.waclis.com.

Buenas prácticas

Importante: Jamás expongas tu api_access_token en código frontend o aplicaciones móviles: En clientes públicos utiliza exclusivamente la Client API (/public/api/v1/inboxes/{inbox_identifier}/...).
Consejo: Usa paginación (?page=N) y reintentos ante códigos 429: Recorre colecciones extensas página por página y aplica exponential backoff si recibes 429 Too Many Requests.

Errores frecuentes y solución de problemas

Síntoma Causa raíz Solución
Error 401 Unauthorized Se envió Authorization: Bearer en vez de api_access_token. Usa la cabecera exacta api_access_token: TU_TOKEN.
Error 422 Unprocessable Entity en contactos El email o teléfono E.164 (+549...) ya pertenece a otro contacto o es inválido. Busca primero con /contacts/search?q=... y actualiza la ficha existente.
Error 404 Not Found con token válido El account_id es incorrecto o el usuario no tiene acceso a esa bandeja. Confirma el account_id en la URL web y los permisos del agente.
El listado devuelve solo los primeros registros Los endpoints devuelven resultados paginados. Solicita las páginas siguientes con ?page=2, ?page=3 verificando meta.

Preguntas frecuentes

¿Dónde obtengo mi api_access_token en Waclis Inbox?

En tu avatar abajo a la izquierda, ingresa a Ajustes de perfil y copia la clave ubicada en la sección Token de acceso.

¿Cómo publico una nota privada interna mediante la API?

Envía un POST a /api/v1/accounts/{account_id}/conversations/{conversation_id}/messages incluyendo "private": true y "content": "Texto".

¿Qué sucede si regenero mi Token de acceso en Ajustes de perfil?

El token anterior queda revocado al instante y deberás actualizar la credencial en todos tus servicios externos.

¿Cómo envío archivos adjuntos por la API REST?

Envía el POST a /messages con formato multipart/form-data adjuntando los archivos en el campo attachments[].

Artículos relacionados

¿Necesitas más ayuda?

Si este artículo no resolvió tu consulta, nuestro equipo puede ayudarte personalmente.

Soporte por WhatsApp