Primeros pasos

En este tutorial, se proporciona información sobre cómo configurar el cliente de la API de instalaciones locales, registrar un número de teléfono de la empresa, actualizar tu configuración y enviar un mensaje de prueba.

El proceso para empezar a utilizar esta API puede dividirse en tres partes:

  1. Prepara los recursos: antes de empezar, debes configurar los recursos necesarios para completar la integración de la API, incluida una cuenta de WhatsApp Business.
  2. Instala el cliente de la API de instalaciones locales: instala el cliente de la API. Una vez que el cliente esté funcionando, puedes actualizar la configuración de la app.
  3. Empieza a usar el cliente: registra tu número de teléfono con una llamada a la API /account y envía un mensaje de prueba con una llamada a /messages.

Antes de empezar

Necesitas lo siguiente:

Después de verificar tu empresa, se revisará que cumpla con las Condiciones del servicio de WhatsApp y con la Política de comercio de WhatsApp. Este paso se inicia automáticamente. Puedes comprobar el estado de la verificación y la revisión de empresas en la pestaña Configuración de tu cuenta de WhatsApp Business en el administrador comercial. Después de las aprobaciones, la verificación de empresas se mostrará como verificada y el estado de la cuenta se mostrará como aprobado.

Configuración de tu cuenta de WhatsApp

Agrega un número de teléfono y el nombre para mostrar a tu cuenta de WhatsApp Business. El nombre para mostrar se enviará a revisión.

Si deseas cambiar el nombre para mostrar, puedes hacerlo tantas veces como quieras hasta que termines de completar tu registro. Luego deberás esperar 30 días entre cada solicitud de cambio de nombre para mostrar.

Una vez que se completen todas las revisiones, podrás visualizar y acceder a tu certificado con codificación Base64, que es necesario para registrar tu cliente de la API de instalaciones locales. Te recomendamos que, para empezar la integración, te registres con un nombre para mostrar aprobado, antes de hacerle cualquier otro cambio. Puedes cambiar tu nombre para mostrar en cualquier momento después de la integración.

Revisar la información relacionada con la facturación y los precios

Una vez que tu negocio comience a enviar mensajes a través de la API de instalaciones locales, es importante entender el proceso de facturación, por ejemplo, cómo y cuándo se cobra, y cómo ver y pagar la factura mensual. Para obtener más información, consulta Información sobre la facturación de una cuenta de WhatsApp Business. Si quieres conocer las reglas de precios y el costo por mensaje, consulta nuestra página de precios.

Software Versión Detalles

API de instalaciones locales

Revisa el registro de cambios

Revisa el registro de cambios

API de instalaciones locales para AWS

Revisa el registro de cambios


Versión de la plantilla: v3.0.1

Revisa el registro de cambios

MySQL

5.7.xx y 8.0.xx

Ten en cuenta que la base de datos que se migró a MySQL 8 no se puede cambiar a MySQL 5. Por lo tanto, haz una copia de seguridad de la base de datos antes de migrarla.

PostgreSQL

13.8

Se admiten 13.x, 12.x y 11.x

Docker

18.04 o posterior; no se incluye la versión 19.03.7

Se requiere la versión 18.04, comenzando con la v2.33.


Asegúrate de que la llamada al sistema statx esté en las llamadas al sistema autorizadas del Docker.

Postman

Cualquier versión reciente

libseccomp

2.3.3

Solo se admite 2.3.3.

glibc

2.28

Solo se admite 2.28 o posterior.

Sistema operativo (SO)

La versión más reciente

Usa al menos la versión de kernel 4.11 mínima.

Paso 1: Instalar el cliente de la API de instalaciones locales

Entorno

En esencia, el cliente de la API de instalaciones locales se basa en Docker. Consulta Arquitectura del cliente para obtener información sobre los componentes.

En estos momentos, el cliente de la API de instalaciones locales no es compatible con Docker para Windows ni con el subsistema de Windows para Linux. En relación con las necesidades de desarrollo, la solución recomendada es usar una máquina virtual Linux y ejecutar Docker en esta máquina. Respecto a las cargas de trabajo de producción, aconsejamos utilizar un servidor Linux para evitar problemas de compatibilidad y rendimiento.

Equipo

El cliente de la API de instalaciones locales puede ejecutarse en cualquier máquina conectada a Internet en la que se pueda ejecutar Docker para Linux, ya sea en una máquina virtual o un servidor de Linux. Para obtener más información, consulta las preguntas frecuentes. Por ejemplo, se pueden realizar pruebas simples en una computadora portátil. Para un servidor del entorno de producción, recomendamos, como mínimo, una SSD de 250 GB, 16 GB de memoria RAM y una CPU de cuatro núcleos. No se recomienda usar discos duros ya que, con carga, las velocidades de E/S provocarán cuellos de botella.

En la mayoría de los casos, debes ejecutar la base de datos en un servidor físico separado de los contenedores de la app principal y de la app web. El servidor de la base de datos debe tener solo unos pocos milisegundos de latencia respecto de las máquinas de cómputo.

Instalación

Existen dos formas de comenzar a utilizar la API de instalaciones locales:

  • Instalación local: puedes configurar los contenedores de Docker tú mismo con nuestra guía de instalación. Recomendamos comenzar con una de las Configuraciones de desarrollador para familiarizarse con el proceso de configuración y el envío de mensajes. Esta solución en las instalaciones puede usarse en tu computadora antes de migrar a un entorno de producción.
  • Amazon Web Services (AWS): si usas AWS o deseas una solución más independiente, consulta la guía para AWS. La opción de AWS permite configurar una solución completa de la API de instalaciones locales, con copias de seguridad, recuperación y mucho más, en una nube AWS que tú administras y que te pertenece.

Una vez que el cliente de la API de instalaciones locales se esté ejecutando, debes tener una sesión iniciada como admin para llevar a cabo los pasos restantes de la configuración.

Actualiza tus ajustes

Una vez que el cliente de la API de instalaciones locales esté funcionando, puedes realizar cambios en la configuración de la app. Sin embargo, no tienes acceso a las distintas configuraciones del perfil de tu cliente de la API de instalaciones locales hasta que se completa el registro.

  • La configuración de la app está relacionada con cómo funciona el cliente (configuración de devolución de llamada, webhooks, paginación de llamadas, estado de enviado, comportamiento de descarga de contenido multimedia, etc.). Nota: Se recomienda configurar una URL de webhook para recibir notificaciones sobre errores o mensajes entrantes.
  • La configuración del perfil de empresa y la configuración del perfil cubren los datos de tu empresa, como la dirección, el correo electrónico, el sitio web, el sector, la información y foto del perfil.

Paso 2: Empezar a utilizar el cliente

Registro

Una vez que tienes el cliente de la API de instalaciones locales en funcionamiento, puedes registrar tu número de teléfono enviando una llamada a la API al punto de conexión account.

Enviar un mensaje de prueba

Puedes enviar mensajes de prueba usando el punto de conexión messages. Primero, consulta el estado del número de teléfono que estás usando para la prueba. Deberás enviar a tu cuenta de WhatsApp un mensaje desde el número de teléfono de prueba para activar el intervalo de servicio de atención al cliente, que te permite enviar cualquier tipo de mensaje dentro del intervalo de 24 horas (consulta control de corte para obtener detalles). A continuación, envía un mensaje de texto al número de tu teléfono de prueba. Si el mensaje llega, significa que la instalación se realizó correctamente. Si el mensaje no llega, revisa tu webhook para ver si hay alguna notificación que indique algún problema.

Seguridad

Consulta nuestra guía Seguridad, que brinda información sobre contraseñas, autenticación, configuración SSL, segregación de red, comunicaciones encriptadas, encabezados HTTP y el protocolo TLS de servidor web relacionados con el cliente de la API de instalaciones locales.

Proceso de inicio

La API de instalaciones locales de WhatsApp se somete a un procedimiento de inicio cuando se establece una conexión con el servidor. Este proceso es fundamental para garantizar un medio fluido y fiable de envío y recepción de mensajes. Durante esta fase de inicio, la aplicación principal espera el cumplimiento de varios requisitos previos, incluidos los siguientes:

  • Carga de mensajes de plantilla: la API carga mensajes de plantilla desde el servidor como parte del proceso de inicialización.

  • Recibiendo y procesando mensajes sin conexión: también se encarga de recibir y procesar mensajes sin conexión.

Si los intentos de enviar mensajes se hacen sin cumplir estos requisitos previos, la aplicación principal responde con el mensaje de error "La aplicación principal no está lista" y los registros muestran el error de "El servicio no está listo". Es importante tener en cuenta que este proceso de inicio se ejecuta cada vez que se establece una nueva conexión con el servidor de WhatsApp. Por lo tanto, si la aplicación principal se reinicia o se desconecta, el proceso de inicio se inicia de nuevo para establecer el estado de la aplicación principal como "lista". Así, se garantiza la fiabilidad y preparación de la API de instalaciones locales de WhatsApp para la comunicación de mensajes.

Procesamiento de mensajes sin conexión

Cuando no se encuentran mensajes sin conexión, se omite el paso de procesamiento de este tipo de mensajes. Es decir, si no hay mensajes esperando en un estado sin conexión, se omite esta fase específica de tratamiento de mensajes.

En condiciones típicas, la API de instalaciones locales de WhatsApp sigue un protocolo estándar para el tratamiento de mensajes sin conexión. Espera la recepción y el procesamiento de todos los mensajes sin conexión, con un tiempo máximo predefinido de 6 minutos. Una vez transcurridos estos 6 minutos, se considera que la fase de procesamiento de mensajes sin conexión se completó con éxito.

Sugerencias adicionales

RECOMENDACIONES

Primero, empieza enviando y recibiendo mensajes entre empleados internos para comprobar que el sistema funciona.

Responde a todos los clientes en un plazo de 24 horas.

Cumple con nuestras políticas, que se describen en la Política de WhatsApp Business y la Política de comercio de WhatsApp.

Usa varios números de teléfono para el desarrollo, las pruebas y la producción.

Consulta las preguntas frecuentes antes de abrir un ticket de asistencia directa.

Envía comentarios sobre el producto. La asistencia directa es el mejor canal para eso.

Proporciona detalles para reproducir tu problema, como registros, información de asistencia de nodos de health y support, datos de WADebug, llamadas a la API para reproducir, etc.

EVITA LO SIGUIENTE

Enviar notificaciones duplicadas a varios canales.

Enviar spam.

Usar números 1-800 para las pruebas.

Crear un administrador comercial solo para integraciones con WhatsApp. Si ya hay uno disponible, úsalo.

Si detectamos que infringiste alguna de nuestras normas o políticas, nos reservamos el derecho de limitar o eliminar tu acceso a WhatsApp.