Recursos para desarrolladores



Añadir Queue-Fair

La sala de espera virtual Queue-Fair se añade fácilmente a una amplia variedad de plataformas web y de aplicaciones en cuestión de minutos. Sólo tiene que utilizar uno de nuestros adaptadores. Puede encontrar más información sobre la mejor manera de integrar Queue-Fair con su sistema existente en la Guía Técnica, o en el Portal Queue-Fair > sección de Ayuda.

El adaptador del lado del cliente

Para los sitios web, la forma más sencilla de integrarse con Queue-Fair es añadir la etiqueta JavaScript del Adaptador Queue-Fair del lado del cliente a sus páginas. Puede añadir con seguridad el Adaptador a todas las páginas de su sitio, y utilizar las Reglas de Activación en el Portal Q FXNPQ para determinar qué páginas pueden lanzar una cola.

Como se ejecuta en los navegadores de sus visitantes, el Adaptador del Lado del Cliente puede ser desactivado por los visitantes técnicamente capacitados, pero es muy eficaz para evitar la sobrecarga, ya que sólo una minoría muy pequeña de personas intentará saltarse la cola manipulando el JavaScript. La mayoría de nuestros clientes utilizan el Adaptador del lado del cliente porque es eficaz para evitar que el sitio se bloquee, es fácil de instalar y no introduce ninguna dependencia entre nuestro sistema y el suyo.

Puede añadir una capa de seguridad sustituyendo la etiqueta JavaScript por un adaptador del lado del servidor, o combinar la flexibilidad del adaptador JavaScript con el modelo de seguridad híbrido descrito en esta página; ambos métodos son entonces seguros.

Una sola línea de código

Para añadir el adaptador del lado del cliente a su sitio web, sólo tiene que añadir la siguiente línea de código al archivo <head> de sus páginas:

Añada nuestra sala de espera virtual a su sitio web con esta única línea de código y evite las caídas del sitio web

Algunos clientes añaden la palabra defer a la etiqueta, lo que hace que el script del Adaptador se descargue paralelamente al análisis de la página y que sólo se inicie la ejecución del script en el navegador del visitante cuando la página haya terminado de analizarse (por lo tanto, normalmente después de que cualquier otro script de su página haya terminado).

Añadir la palabra aplazar puede mejorar el Tiempo a la Primera Pintura en una pequeña fracción de segundo en algunos casos, pero si decide hacer esto significará que cualquier visitante que deba estar en cola verá su página protegida durante una fracción de segundo más antes de ser enviada a la cola.

Google Tag Manager

También proporcionamos la etiqueta adaptadora de JavaScript a través de Google Tag Manager. Busque Queue-Fair en la Galería de plantillas de la comunidad, en Añadir etiqueta. Tenga en cuenta que algunos bloqueadores de anuncios impiden la descarga del maestro gtm.js de Google, lo que bloquea todas las operaciones de Google Tag Manager, incluida la ejecución del Adaptador para esos visitantes.Nuestra etiqueta de sala de espera virtual para Google Tag Manager

Repositorios de GitHub

Google Tag Manager

Google Tag Manager

El repositorio de GitHub para la etiqueta del adaptador del lado del cliente de Google Tag Manager Queue-Fair Virtual Waiting Room.

Páginas de cola dinámicas

Cualquier dato que desee se puede pasar desde su sitio a nuestros servidores y a las páginas de cola que ven sus visitantes utilizando el atributo data-queue-fair-extra que está disponible en la etiqueta JavaScript del lado del cliente y en la implementación de Google Tag Manager. Póngase en contacto con el servicio de asistencia técnica si desea habilitar las páginas de cola dinámicas en su cuenta.

Puede utilizar esta función para personalizar las páginas de la cola sobre la marcha. También puede utilizar Queue-Fair para pasar los datos que nos envíe con sus visitantes de vuelta a su sitio cuando pasen por la cola, para una capa adicional de seguridad.

También proporcionamos una API de página de cola dinámica que utiliza los datos adicionales para personalizar cualquier aspecto de una página de cola, por lo que puede crear una cola para todo su sitio y personalizarla automáticamente para diferentes eventos o productos en su sitio, sin tener que hacer ningún cambio en sus páginas de cola en el portal de Queue-Fair.



Wordpress y WooCommerce

Si está utilizando un sitio basado en Wordpress, como el sistema de carrito de compras WooCommerce, puede añadir fácilmente la etiqueta Client-Side JavasScript Adapter utilizando el plugin Wordpress Insert Headers & Footers, sin tener que modificar ninguno de sus temas o tocar ningún código de Wordpress.

Sólo tienes que descargar el plugin Insert Headers & Footers, descomprimirlo en tu carpeta /wp-content/plugins/, activar el plugin en el menú Plugins, abrir el plugin desde el menú Settings, añadir la etiqueta a Scripts in Header como se muestra, pulsar Save en la parte inferior de la página, ¡y ya está!

El panel del portal Queue-Fair

Recursos adicionales del adaptador del lado del cliente

El adaptador del lado del cliente se describe completamente en la Guía Técnica. La Guía Técnica está disponible en el Portal Queue-Fair > sección de Ayuda, o puede solicitarnos una copia.


Adaptadores del lado del servidor

Mientras que el adaptador del lado del cliente se ejecuta en JavaScript en los navegadores de sus visitantes, los adaptadores del lado del servidor Queue-Fair se ejecutan en su servidor web.

Adaptadores para servidores web

Esto significa que su servidor web puede aprovechar las características de seguridad adicionales para denegar el acceso a las personas que no han sido puestas en cola. Esto también significa que su servidor web evita la carga de generar y servir páginas que contienen el script del Adaptador.

La adición de las bibliotecas del Adaptador del lado del servidor de Queue-Fair sólo lleva unos minutos con cambios mínimos en el código para activar y ejecutar el Adaptador.

La mayoría de nuestros clientes comienzan con el adaptador JavaScript del lado del cliente y pasan al adaptador del lado del servidor sólo cuando existe una necesidad empresarial específica.

Modo sencillo y seguro

Los adaptadores del lado del servidor Queue-Fair pueden funcionar en modo simple o seguro.

En el Modo Simple, todos los visitantes son enviados a los Servidores Queue-Fair para ser contados, se haya formado o no una Cola. Cuando no hay cola, son devueltos a su Servidor Web directamente, sin ver una Página de Cola - pero con la firma que su Servidor Web necesita para asegurar que sólo las personas que han sido pasadas por la cola puedan acceder a sus recursos protegidos.

En el Modo Seguro, los visitantes sólo son enviados a los Servidores Queue-Fair cuando hay una Cola. Su servidor web consulta directamente a nuestros servidores de colas para tomar esta determinación. Los visitantes siguen estando firmados digitalmente de forma segura tanto si se muestra una página de cola como si no.

El modo seguro se recomienda para las colas del día a día. El modo simple es apropiado para un evento cronometrado en el que se esperan miles de personas, ya que elimina la latencia debida a la llamada de comprobación desde su servidor web a nuestros servidores de colas, lo que significa que puede enviar personas a la cola de forma más eficiente.

Repositorios de GitHub

Adaptador PHP para salas de espera virtuales') ?>

PHP

El repositorio de GitHub para el adaptador del lado del servidor de la sala de espera virtual Queue-Fair en PHP.

Adaptador Java para salas de espera virtuales

Java

El repositorio de GitHub para el adaptador del lado del servidor de la sala de espera virtual Queue-Fair para Java, incluidos JBoss y Tomcat.

Adaptador de sala de espera virtual Ruby

Ruby

El repositorio de GitHub para el adaptador del lado del servidor de la sala de espera virtual Queue-Fair en Ruby y (opcionalmente) en Rails.

Adaptador de sala de espera virtual de Python

Python

El repositorio de GitHub para el adaptador del lado del servidor de la sala de espera virtual Queue-Fair en Python y (opcionalmente) Django.

Adaptador de sala de espera virtual dotNet

.NET

El repositorio de GitHub para el adaptador del lado del servidor de la sala de espera virtual Queue-Fair para .NET, ASP y C#.

Adaptador de sala de espera virtual de Node.js y JavaScript

Node.js & JavaScript

El repositorio de GitHub para el adaptador del lado del servidor de la sala de espera virtual Queue-Fair para Node.js y (opcionalmente) Express.



Páginas de cola dinámicas

Al igual que con el Adaptador del lado del cliente, se puede pasar cualquier dato que desee desde su servidor web a nuestros servidores y a las páginas de cola que ven sus visitantes, pasando esta información en la llamada del Adaptador del lado del servidor. Esto facilita la personalización dinámica de las páginas de la cola u otras personalizaciones sobre la marcha de la misma manera - todas las características del adaptador del lado del cliente son totalmente compatibles. Póngase en contacto con el servicio de asistencia técnica si desea activar las páginas de cola dinámicas en su cuenta.

Recursos adicionales del adaptador del lado del servidor

Nuestros adaptadores del lado del servidor se describen completamente en la Guía Técnica. La Guía Técnica está disponible en el Portal Queue-Fair > sección de Ayuda, o puede solicitarnos una copia. También puedes encontrar más información sobre cada uno de los adaptadores en el README.md de cada repositorio de GitHub.


APIs REST

Queue-Fair ofrece a los desarrolladores acceso a seis módulos API REST. Necesitará una cuenta Queue-Fair para utilizar la API. Para habilitar el acceso a la API para su cuenta, póngase en contacto con el servicio de asistencia de Queue-Fair. Nuestros módulos API REST cumplen con los estándares OpenAPI, RFC 7807 y RFC 3339.

Nuestro conjunto de módulos API es muy completo: todo lo que puede hacer en el Portal, también lo puede hacer con la API, excepto la gestión de los usuarios del Portal, que está excluida por razones de privacidad.

Cada módulo de la API está completamente documentado en api.queue-fair.net, donde también encontrará una interfaz Swagger para facilitar el uso y las pruebas. Por seguridad, todas las llamadas a la API están protegidas por un cifrado TLS seguro y requieren una clave de API específica para su cuenta.

Módulos API

API de informes

Para obtener informes en vivo y en tiempo real, informes históricos y estadísticas de colas agregadas.

API de gestión de colas

Para crear y modificar colas de forma programada en tiempo real.

API de gestión de cuentas

Para ver y actualizar la configuración de toda la cuenta.

API de gestión de activos

Para gestionar los activos utilizados por sus páginas de cola servidas por Google CDN.

Presentación API

Para cambiar cualquier aspecto del HTML de sus páginas de cola y la actualización y creación de variantes sobre la marcha.

API de activación

Para configurar las Reglas de Activación que determinan qué páginas de su sitio pueden activar una cola, y qué página se muestra.



Páginas de cola dinámicas

También puede modificar sus páginas de cola sobre la marcha sin tener que actualizar la base de datos utilizando el Portal o la API de presentación - Póngase en contacto con el servicio de asistencia para obtener más detalles y para activar las páginas de cola dinámicas en su cuenta.

Recursos adicionales de la API REST

Tal y como exige el RFC 7807, puede encontrar documentación sobre los mensajes de error que pueden devolver nuestros módulos API REST en queue-fair.com/api-error


Aplicaciones nativas

Queue-Fair se ve muy bien tanto en los navegadores móviles como en los ordenadores de sobremesa y portátiles.

También puede utilizar Queue-Fair directamente en sus aplicaciones nativas de iOS y Android, y también en las aplicaciones de React Native en iOS, Android, Windows y MacOS, para proteger las actividades u operaciones que consumen muchos recursos.

Los adaptadores de aplicaciones Queue-Fair utilizan un WebClient para mostrar a sus usuarios visualizaciones de colas personalizadas cuando sus servicios están demasiado ocupados, con la flexibilidad y facilidad de uso del Queue-Fair Portal.

Puede poner a los usuarios en la misma cola que a los visitantes de su sitio web, o establecer una cola separada para los usuarios de su aplicación; usted decide.

Al igual que nuestras colas basadas en la web, el lugar de cada usuario se guarda automáticamente si también navega fuera de su aplicación.

Repositorios de GitHub

Adaptador de sala de espera virtual para iOS, MacOS y Apple

iOS & MacOS

El repositorio de GitHub para el adaptador Queue-Fair Virtual Waiting Room para iOS y MacOS.

Adaptador de sala de espera virtual para Android

Android

El repositorio de GitHub para el adaptador de sala de espera virtual Queue-Fair para Android.

Adaptador de sala de espera virtual de React Native App

React Native

El repositorio de GitHub para el adaptador de sala de espera virtual Queue-Fair para aplicaciones React Native para Android, iOS, MacOS y Windows.

Notificaciones de colas

El Adaptador Queue-Fair facilita el envío de notificaciones push a los usuarios que no están utilizando su aplicación o cola cuando se llama su turno. El lugar del usuario en la cola es automáticamente almacenado de forma persistente por el adaptador en su aplicación. Si el usuario se aleja de su aplicación, su aplicación le dice a su servidor de notificaciones push que se debe enviar una notificación, enviando la información de la posición en la cola almacenada como parte de ese mensaje a su servidor de notificaciones push.

Es la misma tecnología que utilizamos para nuestra aplicación para consumidores WeQ4U, que ha tenido alrededor de 2 millones de descargas sólo en el Reino Unido.

Su servidor de notificaciones push consulta periódicamente la API de estado de Queue-Fair para consultar la posición en la cola que se está sirviendo actualmente. Cuando ésta es mayor que la posición en la cola de un usuario concreto, es el momento de enviar la notificación a ese usuario. Si el usuario vuelve a la cola o se pasa antes de que se haya enviado una notificación push, el adaptador se lo notifica a su aplicación, y ésta le dice a su servidor de notificaciones push que la notificación ya no es necesaria.

Por lo que sabemos, somos el único proveedor de salas de espera virtuales que admite esta función.

Recursos de vídeo

Aquí hay un video del Native App Adapter en acción, mostrando que el lugar del usuario se guarda incluso si la aplicación está completamente detenida, y también mostrando los ganchos del Adapter que su aplicación utiliza para enviar notificaciones push.

Recursos adicionales

Nuestros adaptadores de aplicaciones nativas se describen en la Guía Técnica. La Guía Técnica está disponible en el Portal Queue-Fair > sección de Ayuda, o puede solicitarnos una copia. También puedes encontrar más información sobre cada uno de los adaptadores específicos para iOS y Android en el README.md de cada repositorio de GitHub.


Adaptadores de comercio electrónico

Queue-Fair puede añadirse fácilmente a cualquier sistema de comercio electrónico utilizando el adaptador JavaScript del lado del cliente descrito anteriormente.

También ofrecemos un código adaptador para trabajar en el lado del servidor con muchos servidores populares de comercio electrónico.

Repositorios de GitHub

Magento Plugin

Magento

El repositorio de GitHub para el adaptador de sala de espera virtual Queue-Fair para Magento.

Adaptador de sala de espera virtual WooCommerce/PHP

WooCommerce

El repositorio de GitHub para el adaptador de sala de espera virtual Queue-Fair para WooCommerce en PHP.

Adaptador de sala de espera virtual PrestaShop/PHP

PrestaShop

El repositorio de GitHub para el adaptador de sala de espera virtual Queue-Fair para PrestaShop en PHP.

Recursos adicionales

Nuestros adaptadores se describen en la Guía Técnica. La Guía Técnica está disponible en el Portal Queue-Fair > sección de Ayuda, o puede solicitarnos una copia.

También disponemos de Guías complementarias para la mayoría de las plataformas de comercio electrónico, sólo tiene que solicitar la que desee.


Seguridad híbrida

Puede combinar fácilmente la flexibilidad del adaptador JavaScript del lado del cliente con la capa de seguridad adicional que proporciona nuestro código del lado del servidor.

Queue-Fair firma a cada visitante que pasamos con una huella digital que es única para ese visitante. De manera única en la industria, la firma también incluye un código específico para el navegador del visitante, para evitar que los tokens de acceso sean compartidos.

Su servidor web puede validar la firma utilizando un secreto conocido sólo por usted y por nosotros -no por sus visitantes- para garantizar que cada visitante ha pasado limpiamente por los servidores de Queue-Fair.

Por lo tanto, puede utilizar el adaptador JavaScript del lado del cliente para enviar y recibir visitantes desde y hacia la cola, y comprobar si hay manipulación antes de que pidan con un código mínimo del lado del servidor, y evitar introducir una dependencia en nuestro sistema.

En nuestros repositorios de GitHub se incluye código de ejemplo en los principales lenguajes de programación web.

Repositorios de GitHub

PHP

PHP

El repositorio de GitHub para el adaptador del lado del servidor de la sala de espera virtual Queue-Fair en PHP.

Java

Java

El repositorio de GitHub para el adaptador del lado del servidor de la sala de espera virtual Queue-Fair para Java, incluidos JBoss y Tomcat.

Ruby

Ruby

El repositorio de GitHub para el adaptador del lado del servidor de la sala de espera virtual Queue-Fair en Ruby y (opcionalmente) en Rails.

Python

Python

El repositorio de GitHub para el adaptador del lado del servidor de la sala de espera virtual Queue-Fair en Python y (opcionalmente) Django.

.NET

.NET

El repositorio de GitHub para el adaptador del lado del servidor de la sala de espera virtual Queue-Fair para .NET, ASP y C#.

Node.js & JavaScript Virtual Waiting Room Adapter') ?>

Node.js & JavaScript

El repositorio de GitHub para el adaptador del lado del servidor de la sala de espera virtual Queue-Fair para Node.js y (opcionalmente) Express.

Recursos adicionales

El Modelo de Seguridad Híbrido se describe completamente en la Guía Técnica. La Guía Técnica está disponible en el Portal Queue-Fair > sección de Ayuda, o puede solicitarnos una copia.


Licencia

Nuestro código publicado está disponible en el repositorio GitHub Queue-Fair bajo la licencia MIT, que es una de las más permisivas de las licencias de código abierto.


¿Quieres saber cómo funciona Queue-Fair?