Ir al contenido

Referencia de API

Autenticación

La API de Waiify se autentica con una API key enviada como token Bearer.

Crea tu key en Configuración → Desarrolladores. Ver API keys (se abre en una pestaña nueva). Se muestra completa una sola vez: guárdala en un lugar seguro.

Incluye la key en el encabezado Authorization de cada petición:

Ventana de terminal
curl "https://api.waiify.com/api/workspaces/WORKSPACE_ID/contacts" \
-H "Authorization: Bearer TU_API_KEY"

Está en la misma pantalla que las keys: Configuración → Desarrolladores, en la tarjeta ID del workspace, con un botón para copiarlo al portapapeles.

Es el valor que va en la ruta de cada endpoint, donde los ejemplos escriben WORKSPACE_ID:

Ventana de terminal
export WAIIFY_API_KEY="tu_api_key"
export WORKSPACE_ID="el_id_copiado_del_dashboard"
curl "https://api.waiify.com/api/workspaces/$WORKSPACE_ID/contacts" \
-H "Authorization: Bearer $WAIIFY_API_KEY"

Si cambias de workspace en el dashboard, la tarjeta muestra el del workspace activo: copia el que corresponda a la key que estés usando.

Los endpoints de recursos van bajo /workspaces/:workspaceId/. Una API key solo funciona para el workspace exacto en el que la creaste — usarla contra otro workspaceId devuelve un 403 (se abre en una pestaña nueva), aunque tu cuenta también sea miembro de ese otro workspace.

La API key funciona en los recursos de integración: contactos (se abre en una pestaña nueva), asistentes (se abre en una pestaña nueva), conversaciones (se abre en una pestaña nueva), base de conocimiento, flows (se abre en una pestaña nueva), pipelines (se abre en una pestaña nueva), calendario (se abre en una pestaña nueva), campañas (se abre en una pestaña nueva), mensajería, campañas de SMS, uso, analítica, CRM events y el resto de otros recursos (se abre en una pestaña nueva).

En otras palabras, una key puede operar los recursos workspace-scoped que el backend expone para integraciones: contactos, conversaciones, búsqueda, conocimiento, flujos, asistentes, analítica, calendario, campañas de llamadas, agentes de voz, consumo, mensajería y eventos CRM. La key no sustituye la sesión del dashboard para conectar OAuth, administrar miembros, gestionar permisos, conectar números de WhatsApp, gestionar plantillas de WhatsApp o crear otras keys.

Solo aceptan sesión del dashboard (no API key): gestionar miembros e invitaciones, crear/revocar otras API keys, conectar credenciales OAuth (Google, Meta, GHL, Kommo), aprovisionar números de voz y conectar redes sociales. Son acciones de administración de la cuenta, no de integración — se hacen desde el dashboard.

  • Una API key da el mismo nivel de acceso que el dueño (OWNER) del workspace, dentro de ese workspace. Trátala como una contraseña, no como un token de solo lectura.
  • Nunca publiques la key en el navegador, apps móviles o repositorios. Úsala solo desde tu servidor.
  • Usa una key por integración para poder revocarla sin afectar las demás.
  • Revoca de inmediato cualquier key filtrada. Ver API keys (se abre en una pestaña nueva).
  • El widget de chat embebible (Chat (se abre en una pestaña nueva)) usa un mecanismo aparte, pensado para ir en HTML público: no confundas el widgetToken del sitio con tu API key. Ver Widget (público) (se abre en una pestaña nueva).
CódigoCausa
401Falta el token o es inválido/revocado
403El token es válido pero no tiene acceso a ese workspace o acción

Ver Errores (se abre en una pestaña nueva).