API REST - iZap Developers

La API REST de iZap vive en /api/v1 en cada entorno y se autentica con OAuth 2.0 / JWT (consulta Autenticación). Explora el esquema completo de solicitudes y respuestas —y prueba llamadas en vivo— en la sección Endpoints de esta pestaña.

Entorno	Origen
Producción	`https://api.izap.ai`
Staging	`https://api-staging.izap.ai`

¿Eres nuevo en iZap? El asistente de configuración genera un cliente funcional (REST, MCP, webhooks o SSE) en tu stack con un solo comando.

Recursos

Recurso	Ruta	Propósito
Auth	`/api/v1/auth/`, `/oauth/`	Login con JWT y OAuth 2.0; consulta Autenticación también para los tokens de acceso personal
Tokens de API	`/api/v1/me/api-tokens/*`	Crear, listar y revocar tokens de acceso personal
Negocios	`/api/v1/businesses/*`	Configuración del tenant, horarios, menús y recursos de la biblioteca
Chats	`/api/v1/chats/*`	Lectura y escritura de conversaciones y envío
Plantillas de WhatsApp	`/api/v1/whatsapp_templates/*`	Gestionar y sincronizar plantillas de mensajes
Transmisiones	`/api/v1/transmissions/*`	Envíos masivos de WhatsApp
Webhooks	`/api/v1/webhook-endpoints/*`	Registrar una URL para recibir eventos; consulta Webhooks

Convenciones

Versionado: la API está montada en /api/v1; los cambios incompatibles pasan a una nueva ruta de versión.
Auth: envía Authorization: Bearer <jwt> en cada solicitud.
Tipo de contenido: cuerpos de solicitud y respuesta en JSON, excepto la autenticación, que usa formulario codificado.

Estado

Consulta el estado en vivo de la plataforma en la página de estado. El endpoint /health sigue disponible como prueba de vida en JSON, legible por máquinas, para tu propio monitoreo.

Modelo de errores

Estado	Significado
`401`	Token ausente o expirado: vuelve a autenticarte.
`422`	Error de validación: revisa el cuerpo de la solicitud.
`400`	Conflicto de dominio o de datos.
`500`	Error del servidor.