Este artículo explica cómo alojar el script de Bootstrap del SDK Appcues en su propio servidor y configurarlo para que actúe como proxy de los puntos finales de la API Appcues . El alojamiento en su propio servidor no se recomienda en todos los casos, ya que tiene un coste. Consulte la nota importante a continuación.

Una vez autoalojado:

• Sus usuarios finales cargarán este script desde un host que usted configure en lugar de desde Appcues fast.appcues.com
• Puede crear un hash de integridad de subrecurso para el script. Esto permite a los navegadores verificar que el script que están recuperando se entrega "tal cual". Funciona proporcionando un hash criptográfico con el que debe coincidir el recurso recuperado.
• Necesitará actualizar manualmente a nuevas versiones del script cada vez que se produzcan cambios en el script de arranque.

Notas importantes

• A menos que sus necesidades lo requieran específicamente, no se recomienda el autohospedaje ni el proxy opcional. Autohospedar el script de arranque del SDK implica que no recibirá automáticamente nuevas versiones del script y deberá actualizar su copia si se realizan cambios. Si no lo actualiza, podría no recibir nuevas funciones Appcues . Para recibir alertas sobre cambios, le recomendamos seguir el repositorio de Github donde se aloja este script.
• Esta guía no le permite autoalojar completamente el SDK Appcues . Autoalojar el script de arranque del SDK solo le permite proteger su instalación de Appcues con etiquetas de integridad de contenido. Incluso al autoalojar, el script de arranque del SDK incluye una función de actualización automática que podría estar bloqueada por políticas de seguridad estrictas en su aplicación.

Requisitos

• Capacidad para alojar el archivo javascript de arranque y entregarlo a sus usuarios finales. Dependiendo del volumen de usuarios finales, podría ser conveniente alojar el script en una CDN.

Cómo hacerlo

Para alojar por sí mismo el script Bootstrap del SDK se requieren los siguientes pasos:

1. Reemplace <your appcues account id> por su ID de cuenta (ubicada en la página de Configuración en Studio).
2. Aloje el script para que su producto pueda cargarlo según sea necesario.

Pruebas

Las pruebas se pueden realizar cargando el script en su sitio y viéndolo funcionar.

La prueba más fácil es abrir la consola JavaScript de su navegador y ejecutar el comando Appcues .debug() . Más información sobre el comando debug.

Proxy de Appcues

También es posible proxyar los puntos finales de la API de Appcues para que sus usuarios finales interactúen directamente con su proxy en lugar de hacerlo directamente con fast.appcues.com y api.appcues.net.

Importante : Para usar un proxy en los endpoints Appcues , es necesario alojar y configurar un proxy compatible con la escala de usuarios finales. Appcues no proporciona una implementación de proxy predefinida, por lo que debe proporcionar la suya propia. El proxy es una opción que solicitan algunas organizaciones para satisfacer sus necesidades de seguridad específicas.

Requisitos

• Si utiliza como proxy fast.appcues.com , su proxy debe admitir todas las solicitudes GET del dom fast.appcues.com .
• Si utiliza como proxy api.appcues.net , su proxy debe soportar solicitudes GET y POST para cualquier ruta del dom api.appcues.net además de soportar el proxy para conexiones WebSocket.
  • Para usar api.appcues.net como proxy, es necesario que el proxy admita todo el tráfico de red de los usuarios finales. Appcues no puede proporcionar estimaciones de este tráfico, ya que depende de los usuarios activos, la cantidad de solicitudes que la aplicación realiza a la API Appcues mediante el SDK Appcues , el tamaño del contenido y la cantidad de contenido mostrado.

Cómo hacerlo

1. Cree un sistema proxy que cumpla con los requisitos descritos anteriormente. Esto puede lograrse con la tecnología de proxy que prefiera, por ejemplo, NGINX . Un ejemplo de arquitectura para un proxy NGINX en los endpoints de Appcues podría ser el siguiente:
2. Una vez configurado su proxy, actualice el script de arranque del SDK autohospedado para hacer referencia a su proxy.
   • Si utiliza como proxy fast.appcues.com, actualice el nombre de host en el valor de APPCUES_BUNDLE_DOMAIN para reflejar el dom host de su dominio proxy.
   • Si utiliza api.appcues.net como proxy, actualice el valor de APPCUES_API_HOSTNAME para reflejar su dom proxy.

Pruebas

Probar es tan sencillo como cargar el script en su sitio y ver cómo funciona.

La prueba más sencilla es abrir la consola Javascript del navegador y ejecutar el comando Appcues .debug() . Puede encontrar más información sobre el comando debug en nuestra documentación.

¿Preguntas?

El soporte Appcues puede responder cualquier pregunta que tenga sobre el contenido de este artículo, sin embargo, Appcues no puede asesorarlo sobre la implementación de su proxy.