Hola, Humans. ¿En qué podemos ayudarte?

01. Tokens y Webhooks para usar en las APIs en Zenvia Customer Cloud
5 min
Creado por Ligia Sarmento en 26/02/2024 15:45
Actualizado por Ligia Sarmento en 08/03/2024 16:15

Zenvia Customer Cloud permite que realices automatizaciones a través de nuestras APIs de canales disponibles. Para utilizar los recursos, simplemente regístrate en la solución y obtén las credenciales necesarias, las cuales este artículo explica. Luego, podrás integrar nuestra API Multicanal a tu sistema y comunicarte con tus clientes en varios canales.

 

Supongamos que un cliente hizo un pedido y proporcionó su número de teléfono y dirección de correo electrónico durante el proceso de compra. Con la API de SMS, por ejemplo, puedes enviar un mensaje informando que el producto ha sido recibido y está siendo procesado. O con la API de correo electrónico, enviar automáticamente detalles de seguimiento tan pronto como se despache el pedido.


⚠️ Atención:: Esta funcionalidad está disponible solo para usuarios con el perfil de Operador, Admin o SysAdmin.


La integración de una API requiere conocimientos técnicos avanzados, por lo tanto, es importante contar con la ayuda de un desarrollador. Puedes consultar información sobre APIs en las
APIs de Zenvia.

Cómo acceder

La pantalla de creación de Tokens y Webhooks posibilita el uso de las APIs multicanal. Para acceder, sigue las siguientes instrucciones:

 

En el menú lateral, haz clic en Ajustes > Tokens y Webhooks.

Crear nuevo token

El Token es una clave de autenticación con nuestras APIs. Es con ella que realizas las integraciones y demás llamadas. Para crearlo, sigue los siguientes pasos en la pantalla de Tokens y Webhooks:


  1. Haz clic en la opción Crear Nuevo en Tokens.
  2. Ingresa un Nombre para identificación.
  3. Elige el tipo de Tipo de autenticación:
  • Estándar: utiliza solo el token para validar la conexión entre sistemas.
  • Con firma: incorpora una firma digital al token, proporcionando una capa extra de seguridad.

      4. Finaliza haciendo clic en Guardar.

Listo. Una nueva pantalla mostrará tu clave. Almacena este código de manera segura, ya que es el único momento en que estará disponible.

💡 Tip: Si lo prefieres, haz clic en el botón Cargar.CSV para tener el archivo con la clave guardada.

Si deseas borrar el Token, regresa a la pantalla de Tokens y Webhooks y haz clic en la opción Borrar.

Crear nuevo Webhook

Los Webhooks son opcionales y te permiten recibir eventos en la URL configurada para recibir la información deseada. Sigue las instrucciones en la pantalla de Tokens y Webhooks:

 

  1. Haz clic en la opción Crear Nuevo en Webhook e selecciona las opciones:
  • Estado: Elige entre Activa o Inactiva. La diferencia está relacionada con la recepción de notificaciones automáticas de eventos.
  • Versión: Selecciona el tipo de versión, refiriéndote a la iteración específica de un servicio de webhook para indicar actualizaciones o cambios a lo largo del tiempo para mejoras o correcciones.
  • Tipo de evento: Indica el tipo de evento deseado: Mensaje o Estado del mensaje. Los eventos de mensaje notifican sobre el contenido, mientras que los eventos de estado se centran en actualizaciones sobre la entrega o procesamiento del mensaje.
  • Canal: Elige el canal para recibir notificaciones automáticas solo para eventos relacionados con él.
  • URL: Indica la URL válida para recibir las notificaciones automáticas.
  • Cabeceras: Rellena los campos Llave y Valor para configurar cabeceras HTTP, como "Content-Type: application/json". Personaliza según los requisitos de autenticación del destino.

      4.Finaliza haciendo clic en Guardar.

Si deseas borrar el Webhook, regresa a la pantalla de Tokens y Webhooks y haz clic en la opción Borrar.

¡Listo! Ahora tienes Tokens y Webhooks y puedes seguir utilizando nuestras APIs. Consulta nuestra documentación técnica para obtener más información sobre las solicitudes realizadas en cada canal, o realiza pruebas en Sandbox.

 

¿Te ha útil este artículo?
Vistos recientemente