Claves de API
Actualizado el
Dónde: Configuración > Integraciones > Claves de API
Para qué sirve:
"Dale a un programa externo su propia clave para enviar a través de SyBox: el token de WhatsApp nunca sale del servidor y, si una clave se filtra, se revoca de forma independiente". Tu ERP, punto de venta o programa de escritorio utiliza una clave de SyBox. Nunca necesita tus credenciales reales de WhatsApp.
Qué puede hacer un programa con una clave (descrito en la página pública de Documentación para desarrolladores):
- Enviar mensajes de WhatsApp desde tu propio número conectado. Utiliza el mismo formato de solicitud que la API Cloud de WhatsApp de Meta, por lo que un programa ya programado para ella solo necesita una nueva dirección y una clave de SyBox. Funciona con texto, plantillas, imágenes, documentos y mensajes interactivos. Las respuestas y los errores se devuelven exactamente como los entrega Meta.
- Registrar una reclamación desde tu propio sistema, por ejemplo una queja registrada en tu ERP. El cliente ya debe existir en SyBox.
- Importar SMS desde un teléfono a la bandeja de entrada.
Quién puede abrirlo: el administrador principal y los miembros del equipo con el permiso "Administrar números de WhatsApp".
El interruptor "Puerta de enlace de API":
En la parte superior de la pantalla de claves de API hay un interruptor llamado "Puerta de enlace de API". Está desactivado de forma predeterminada. Mientras esté desactivado, ninguna clave funciona y no puedes crear claves nuevas. Si lo intentas, verás: "La puerta de enlace de API está desactivada. Actívala con el interruptor en la parte superior de esta pantalla antes de crear claves". El interruptor se guarda en el momento en que haces clic en él.
- Ve a Configuración > Integraciones > Claves de API.
- Activa el interruptor "Puerta de enlace de API".
- Haz clic en "Nueva clave".
- Elige el "Tipo de clave":
- "Enviar por WhatsApp": el programa envía mensajes a tus clientes.
- "Registrar una reclamación": el programa abre casos en SyBox. No puede enviar mensajes.
- "Importar SMS desde un teléfono": un teléfono reenvía sus mensajes SMS a la bandeja de entrada.
- Completa el "Nombre del dispositivo o programa", por ejemplo "Ordenador de la oficina" o "Sistema de contabilidad". Dale a cada dispositivo o programa su propia clave.
- Para una clave de tipo "Enviar por WhatsApp", configura también:
- "Envía desde": el número de WhatsApp desde el que envía esta clave (obligatorio).
- "Permitir mensajes de texto libre": activado o desactivado.
- "Permitir plantillas aprobadas": activado o desactivado. Al menos uno de estos dos debe estar activado, o verás: "Permite al menos texto libre o plantillas; de lo contrario, la clave no podrá enviar nada".
- "Permitir envío de multimedia": activado o desactivado.
- "Plantillas" (opcional): nombres de las plantillas, separados por comas. Déjalo vacío para permitir cualquier plantilla.
- "Países de destinatarios permitidos" (opcional): códigos de país de dos letras, por ejemplo MA,FR,EG. Déjalo vacío para permitir cualquier país.
- "Envío permitido de" ... "Para": el horario en el que la clave puede enviar. Deja ambos iguales para no aplicar límite de tiempo. Las horas corresponden a la zona horaria local del espacio de trabajo.
- "Límite diario de mensajes (0 = ilimitado)".
- Para una clave de tipo "Importar SMS desde un teléfono", configura "Solo contactos y clientes". Cuando está activado, un SMS de cualquier otro número se queda en el teléfono y nunca llega a la bandeja de entrada. Desactívalo solo si el teléfono se usa exclusivamente para el trabajo.
- Haz clic en Guardar.
- Una ventana muestra la "URL base" y la "Clave API". Cópialas ahora. "Copia esta clave ahora — solo se muestra una vez.". Introdúcelas en la configuración de tu programa.
Qué muestra la tarjeta de la clave:
- El nombre de la clave y el número desde el que envía (o la etiqueta de su tipo, para una clave que no envía).
- Los últimos caracteres de la clave, para que puedas distinguirlas.
- "usado por última vez", con fecha y hora, o "nunca".
- Los límites aplicados: "Solo texto libre", "Solo plantillas", "sin multimedia", "Plantillas", países permitidos, horario de envío y el límite diario mostrado como enviados hoy / límite / día. Una clave de SMS que acepta cualquier número muestra "Todos los números".
- Haz clic en Editar en la tarjeta de la clave. Puedes cambiar su nombre, número y límites. El tipo de clave no se puede cambiar después de crearla, y la clave en sí no se vuelve a mostrar nunca.
- Haz clic en Activar / Desactivar para pausar una clave temporalmente.
- Haz clic en Eliminar y luego confirma: "¿Eliminar esta clave de API? Cualquier programa que aún la use deja de funcionar de inmediato.".
He perdido mi clave de API. ¿Puedo volver a verla?
No. Solo se muestra una vez. Crea una clave nueva, ponla en tu programa y luego elimina la clave antigua.
Creo que se ha filtrado una clave. ¿Qué hago?
Elimina esa clave o desactívala de inmediato. Solo esa clave dejará de funcionar. Tu número de WhatsApp y tus otras claves no se verán afectados.
La lista "Envía desde" está vacía.
La lista solo muestra números de WhatsApp que están conectados y activados. Conecta primero un número en Configuración > Mensajería > Canales.
Mi programa recibe un rechazo al enviar.
Comprueba que el interruptor "Puerta de enlace de API" esté activado y que la clave esté activa. Revisa también los límites de la clave: texto libre vs. plantillas, multimedia, plantillas permitidas, países permitidos, horario de envío y límite diario. Las propias reglas de WhatsApp también se siguen aplicando. Por ejemplo, el texto libre solo funciona dentro de las 24 horas posteriores al último mensaje del cliente.
¿Puede una clave de tipo "Registrar una reclamación" enviar también mensajes?
No, por diseño. Una clave que registra casos no puede enviar mensajes a los clientes, y una clave de envío no puede registrar casos. Usa una clave distinta para cada tarea.
Tengo una clave antigua del tipo "Recibir de un programa". ¿Sigue funcionando?
Sí, las claves existentes de ese tipo siguen funcionando. Ya no se pueden crear claves nuevas de ese tipo. Utiliza "Registrar una reclamación" para ese tipo de tarea.