Saltar al contenido principal

¿Qué es la versión Compatibilidad con Z-API?

La versión Compatibilidad con Z-API se creó para facilitar la migración de los clientes que hoy usan Z-API y quieren pasarse a Omni Z-API como su solución oficial de API para WhatsApp. Sabemos que cambiar de proveedor de API puede ser un proceso laborioso, sobre todo cuando ya tienes integraciones funcionando en producción. Por eso hemos desarrollado esta capa de compatibilidad, que mantiene la misma estructura que ya conoces.

¿Qué cambia en la práctica?

Los únicos cambios necesarios en tu aplicación son la base URL y el header de autenticación. Además, al utilizar la API oficial de WhatsApp, algunas funcionalidades de Z-API no están disponibles. Consulta la página de Limitaciones de la API Oficial para más detalles.
La versión Compatibilidad con Z-API funciona solo con canales WhatsApp Oficial (API oficial de Meta). Un envío a un canal de otro tipo, como WhatsApp Web, Instagram, Messenger o Telegram, se rechaza con 422:
Para enviar por esos canales, usa las rutas de mensajes de Omni Z-API.

Sobre la nomenclatura

En Omni Z-API, lo que antes se llamaba instancia (instance_id) ahora se trata como canal (channel_id). El concepto es el mismo —representa la conexión con un número de WhatsApp—, pero hemos adoptado el término «canal» porque es más amplio, ya que Omni Z-API admite varios canales de mensajería además de WhatsApp.
Por compatibilidad, la API acepta tanto /instances/ como /channels/ en el path. Si estás migrando desde Z-API, puedes mantener /instances/ sin problema: tus integraciones seguirán funcionando. Para integraciones nuevas recomendamos usar /channels/.
Es decir, si hoy tu aplicación hace una llamada como esta:
Solo tienes que cambiarla por esta:
Fíjate en que solo han cambiado la base URL y el header de autenticación: el path y el body son idénticos. El secret del header Authorization se genera en el panel de Omni Z-API al crear tu instancia. Los payloads de envío y los bodies de los webhooks mantienen exactamente la misma estructura, lo que garantiza que tus integraciones sigan funcionando sin roturas.

¿Por qué migrar?

API Oficial de WhatsApp

Usa la API oficial de WhatsApp Business, con toda la seguridad y estabilidad que eso aporta.

Menor riesgo de bloqueo

Al utilizar la API oficial de WhatsApp, el riesgo de baneo es bastante menor que con las soluciones no oficiales.

Migración sencilla

Cambia solo la base URL y listo: tus integraciones seguirán funcionando.

Soporte dedicado

Cuenta con el apoyo del equipo de Omni Z-API durante todo el proceso de migración.

Cómo migrar

1

Crea tu cuenta en Omni Z-API

Entra en el Panel y crea tu cuenta.
2

Configura tu instancia

Crea una instancia nueva y conecta tu número de WhatsApp.
3

Actualiza la base URL y la autenticación

Sustituye https://api.z-api.io por https://zapi.omni.z-api.io y cambia el header Client-Token por Authorization: Bearer SU_SECRET.
4

Configura los webhooks

Actualiza la URL de callback de los webhooks en el panel para que apunte a tu servidor. Los eventos que recibas tendrán la misma estructura que antes.
5

Prueba y valida

Haz pruebas de envío y de recepción para asegurarte de que todo funciona correctamente.
¿Necesitas ayuda con la migración? Escríbenos al correo suporte@z-api.io.