Recursos para desenvolvedores



Adicionando Queue-Fair

A Sala de espera virtual Queue-Fair é facilmente adicionada a uma grande variedade de plataformas web e de aplicativos em minutos. Basta usar um de nossos adaptadores. Você pode encontrar mais informações sobre a melhor maneira de integrar o Queue-Fair com seu sistema existente no Guia Técnico, ou na seção Portal Queue-Fair > Ajuda.

O Adaptador do lado do cliente

Para websites, a maneira mais simples de integrar com Queue-Fair é adicionar a tag JavaScript do Adaptador Queue-Fair do lado do Cliente a suas páginas. Você pode seguramente adicionar o Adaptador a todas as páginas de seu site, e usar as Regras de Ativação no Portal Queue-Fair para determinar quais páginas podem lançar uma fila.

Como funciona nos navegadores de seus visitantes, o Adaptador Client-Side pode ser desativado por visitantes tecnicamente habilitados, mas é muito eficaz na prevenção de sobrecarga, pois apenas uma minoria muito pequena de pessoas tentará pular a fila adulterando o JavaScript. A maioria de nossos clientes usa o Adaptador Client-Side porque ele é eficaz na prevenção de uma falha no local, simples de instalar e não introduz nenhuma dependência entre nosso sistema e o seu.

Você pode adicionar uma camada de segurança substituindo a tag JavaScript por um Adaptador Server-Side, ou combinar a flexibilidade do Adaptador JavaScript com o Modelo Híbrido de Segurança descrito nesta página; ambos os métodos são então seguros.

Linha única de código

Para adicionar o Adaptador Client-Side ao seu site, basta adicionar a seguinte linha única de código ao <head> seção de suas páginas:

Adicione nossa Sala de Espera Virtual ao seu site com esta única linha de código e evite que o site falhe

Alguns clientes acrescentam a palavra defer à tag, o que faz com que o script do Adaptador seja carregado em paralelo à análise da página e também para iniciar a execução do script no navegador do visitante somente quando a página tiver terminado a análise (portanto, normalmente depois que qualquer outro script em sua página tiver terminado).

Adicionar a palavra adiar pode melhorar o Tempo para Primeira Tinta por uma pequena fração de segundo em alguns casos, mas se você optar por fazer isso, isso significará que qualquer visitante que deva ser deixado em fila verá sua página protegida por uma fração de segundo a mais antes de ser enviado para a fila.

Gerenciador de tags do Google

Nós também fornecemos o JavaScript Adapter Tag via Google Tag Manager. Procure por Queue-Fair na Galeria de Modelos Comunitários, em Adicionar Tag. Observe que alguns bloqueadores de anúncios impedem o download do gtm.js mestre do Google, que bloqueia todas as operações do Google Tag Manager, incluindo a execução do Adaptador para aqueles visitantes.Nossa Tag de Sala de Espera Virtual para Google Tag Manager

Repositórios GitHub

Gerenciador de tags do Google

Gerenciador de tags do Google

O repositório GitHub para a Sala de Espera Virtual Queue-Fair Google Tag Manager Client-Side Adapter Tag.

Páginas de Fila Dinâmica

Qualquer dado que você desejar pode ser passado de seu site para nossos servidores e as Páginas de Fila de Espera que seus visitantes vêem, utilizando o atributo data-queue-fair-extra que está disponível na Tag JavaScript do lado do Cliente e na implementação do Google Tag Manager. Favor entrar em contato com o suporte se desejar ativar as Páginas de Fila Dinâmicas em sua conta.

Você pode usar este recurso para personalizar as Páginas de Fila na mosca. Você também pode usar o Queue-Fair para passar os dados que você nos envia com seus visitantes de volta ao seu site à medida que eles são passados pela fila, para uma camada adicional de segurança.

Também fornecemos uma API de Página de Fila Dinâmica que usa os dados extras para personalizar qualquer aspecto de uma Página de Fila, para que você possa criar uma fila para todo o seu site e personalizá-la automaticamente para diferentes eventos ou produtos em seu site, sem ter que fazer qualquer alteração em suas Páginas de Fila no Portal Queue-Fair

.



Wordpress & WooCommerce

Se você estiver usando um site baseado no Wordpress, como o sistema de carrinho de compras WooCommerce, você pode facilmente adicionar a tag Adaptador JavasScript do lado do cliente usando o plugin Inserir Cabeçalhos e Rodapés do Wordpress, sem ter que modificar nenhum de seus Temas ou tocar qualquer código do Wordpress.

Basta baixar o Plugin Insert Headers & Footers, descompactá-lo para sua pasta /wp-content/plugins/, ativar o plugin no menu Plugins, abrir o plugin no menu Settings, adicionar a tag ao Scripts no Cabeçalho como mostrado, pressionar Save no final da página, e pronto!

O Painel de Controle do Portal Queue-Fair

Adaptador do lado do cliente Recursos adicionais

O Adaptador do lado do cliente está totalmente descrito no Guia Técnico. O Guia Técnico está disponível na seção Portal Queue-Fair > Ajuda, ou você pode solicitar uma cópia de nós.


Adaptadores do lado do servidor

Onde quer que o Adaptador do lado do cliente seja executado em JavaScript nos navegadores de seus visitantes, os Adaptadores Queue-Fair Server-Side são executados em seu servidor web.

Adaptadores para Servidores Web

Isto significa que seu servidor web pode tirar proveito de recursos adicionais de segurança para negar o acesso às pessoas que não foram enfileiradas. Isto também significa que seu servidor web evita a carga de gerar e servir páginas contendo o script do Adaptador.

Adicionar as bibliotecas do Queue-Fair Server-Side Adapter leva apenas alguns minutos com o mínimo de mudanças de código para ativar e executar o Adapter.

A maioria de nossos clientes começa com o Adaptador JavaScript do lado do cliente e passa para o Adaptador Server-Side apenas onde há uma necessidade comercial específica.

Modo simples e seguro

Os adaptadores Queue-Fair Server-Side podem operar em modo simples ou seguro.

No Modo Simples, todos os visitantes são enviados aos Servidores Queue-Fair para serem contados, independentemente de ter sido formada ou não uma Fila de espera. Quando não há fila, eles são devolvidos ao seu Servidor Web imediatamente, sem ver uma Página de Fila - mas com a assinatura de seu Servidor Web precisa garantir que somente pessoas que tenham sido Passadas pela fila possam acessar seus recursos protegidos.

No Modo Seguro, os visitantes só são enviados para os Servidores Queue-Fair quando há uma Fila de espera. Seu servidor web consulta diretamente nossos Servidores de Fila para fazer esta determinação. Os visitantes ainda são assinados digitalmente de forma segura, quer uma Página de Fila seja mostrada ou não.

O Modo Seguro é recomendado para as filas do dia-a-dia. O modo simples é apropriado para um evento cronometrado quando você está esperando milhares de pessoas, pois elimina a latência devido à chamada de verificação do seu servidor web para nossos Servidores de Fila, o que significa que você pode enviar pessoas para a fila de forma mais eficiente.

Repositórios GitHub

Adaptador de Sala de Espera Virtual PHP') ?>

PHP

O repositório GitHub para o Queue-Fair Virtual Waiting Room Server-Side Adapter em PHP.

Adaptador da Sala de Espera Virtual Java

Java

O repositório GitHub para o Queue-Fair Virtual Waiting Room Server-Side Adapter para Java, incluindo JBoss e Tomcat.

Adaptador da Sala de Espera Virtual Ruby

Ruby

O repositório GitHub para o Queue-Fair Adaptador do lado do servidor da sala de espera virtual em Ruby e (opcionalmente) Rails.

Adaptador da Sala de Espera Virtual Python

Python

O repositório GitHub para o Queue-Fair Virtual Waiting Room Server-Side Adapter em Python e (opcionalmente) Django.

Adaptador para Sala de Espera Virtual dotNet

.NET

O repositório GitHub para o Queue-Fair Virtual Waiting Room Server-Side Adapter para .NET, ASP e C#.

Node.js & JavaScript Adaptador de Sala de Espera Virtual

Node.js & JavaScript

O repositório GitHub para o Queue-Fair Virtual Waiting Room Server-Side Adapter for Node.js e (opcionalmente) Express.



Páginas de Fila Dinâmica

Assim como no Adaptador do lado do cliente, quaisquer dados que você desejar podem ser passados de seu servidor web para nossos servidores e as páginas de fila que seus visitantes vêem ao passar estas informações na chamada do Adaptador do lado do servidor. Isto facilita a Página de Fila Dinâmica ou outra personalização em tempo real da mesma forma - todas as características do Adaptador Client-Side são totalmente suportadas. Entre em contato com o suporte se desejar ativar as Páginas Dinâmicas de Fila de Espera em sua conta.

Adaptador do lado do servidor Recursos adicionais

Nossos adaptadores do lado do servidor estão totalmente descritos no Guia Técnico. O Guia Técnico está disponível na seção Portal Queue-Fair > Ajuda, ou você pode solicitar uma cópia de nós. Você também pode encontrar mais informações sobre cada um dos Adaptadores no README.md de cada repositório GitHub.


REST APIs

O Queue-Fair dá aos desenvolvedores acesso a seis Módulos API REST. Você precisará de uma conta Queue-Fair para usar a API. Para ativar o acesso à API para sua conta, entre em contato com o Suporte Queue-Fair. Nossos Módulos REST API estão em conformidade com as normas OpenAPI, RFC 7807 e RFC 3339.

Nosso conjunto de Módulos API é abrangente - qualquer coisa que você possa fazer no Portal, você também pode fazer com a API, exceto gerenciar Usuários do Portal, o que é excluído por razões de privacidade.

Cada módulo API é totalmente documentado no api.queue-fair.net, onde você também encontrará uma interface Swagger para facilidade de uso e teste. Para segurança, todas as chamadas API são protegidas por criptografia TLS segura e requerem uma chave API específica para sua conta.

Módulos API

Relatório API

Para relatórios ao vivo, em tempo real, relatórios históricos e estatísticas agregadas das filas.

API de gerenciamento de filas

Para criar e modificar filas programáticas em tempo real.

API de gerenciamento de contas

Para visualizar e atualizar as configurações de toda a sua conta.

API de gerenciamento de ativos

Para gerenciar os ativos utilizados por suas Páginas de Fila servidas pelo Google CDN.

Apresentação API

Para alterar qualquer aspecto do HTML de suas Páginas de Fila de Espera e a atualização e criação de variantes em tempo real.

Ativação API

Para configurar as Regras de Ativação que determinam quais páginas em seu site podem acionar uma fila, e qual página é mostrada.



Páginas de Fila Dinâmica

Você também pode modificar suas Páginas de Fila de Espera em tempo real sem ter que atualizar o banco de dados usando o Portal ou a API de Apresentação - Contate o Suporte para maiores detalhes e para ativar as Páginas de Fila Dinâmicas em sua conta.

Recursos adicionais REST API

Como requerido pelo RFC 7807, você pode encontrar documentação sobre mensagens de erro que podem ser retornadas por nossos Módulos API REST em queue-fair.com/api-error


Aplicações nativas

O Queue-Fair fica ótimo em navegadores móveis, assim como em desktops e laptops.

Você também pode usar o Queue-Fair diretamente em seus aplicativos nativos iOS e Android, e também Reagir aplicativos nativos em iOS, Android, Windows e MacOS, para proteger atividades ou operações de recursos intensivos.

Os Adaptadores de Aplicação Queue-Fair utilizam um Cliente Web para exibir filas personalizadas para seus usuários quando seus serviços estão muito ocupados, com a flexibilidade e facilidade de uso do Queue-Fair Portal.

Você pode enfileirar os usuários na mesma fila que os visitantes de seu site, ou criar uma fila separada para os usuários de seu aplicativo - isso depende de você.

Assim como nossas filas baseadas na web, o lugar de cada usuário é automaticamente salvo se ele também navegar para longe de seu aplicativo.

Repositórios GitHub

iOS, MacOS e Adaptador de Sala de Espera Virtual Apple

iOS & MacOS

O repositório GitHub para a Sala de espera virtual Queue-Fair iOS e MacOS Adapter.

Adaptador de Sala de Espera Virtual Android

Android

O repositório GitHub para o Adaptador de Sala de Espera Virtual Queue-Fair para Android.

Adaptador de Sala de Espera Virtual Reage Native App

React Native

O repositório GitHub para o Adaptador de Sala de Espera Virtual Queue-Fair para aplicativos React Native para Android, iOS, MacOS e Windows.

Notificações de fila

O Adaptador Queue-Fair facilita o envio de Notificação de Push aos usuários que não estão usando seu aplicativo ou fila de espera quando sua vez é chamada. O lugar do usuário na fila é automaticamente armazenado de forma persistente pelo Adaptador em seu aplicativo. Se o usuário navegar para longe de seu aplicativo, seu aplicativo diz a seu servidor de Notificação Push que uma notificação deve ser enviada, enviando a informação armazenada da posição da fila como parte dessa mensagem para seu servidor de Notificação Push.

É a mesma tecnologia que usamos para nosso aplicativo de consumo WeQ4U, que já teve cerca de 2 milhões de downloads somente no Reino Unido.

Seu servidor Push Notification consulta periodicamente a API de status Queue-Fair para consultar a posição da fila que está sendo atendida atualmente. Quando esta é maior que a posição de um determinado usuário na fila, é hora de enviar a notificação a esse usuário. Se o usuário retornar à fila ou for Passado antes que uma Notificação Push tenha sido enviada, o Adaptador notifica seu aplicativo, e seu aplicativo informa seu servidor de Notificação Push que a notificação não é mais necessária.

Segundo nosso conhecimento, somos o único fornecedor de Sala de Espera Virtual que apóia este recurso.

Recursos em vídeo

Aqui está um vídeo do Adaptador Nativo em ação, mostrando que o lugar do usuário é salvo mesmo que o aplicativo esteja completamente parado, e também mostrando os ganchos do Adaptador que seu aplicativo usa para enviar Notificações Push.

Recursos adicionais

Nossos adaptadores de aplicação nativos estão descritos no Guia Técnico. O Guia Técnico está disponível na seção Portal Queue-Fair > Ajuda, ou você pode solicitar uma cópia de nós. Você também pode encontrar mais informações sobre cada um dos Adaptadores específicos para iOS e Android no README.md de cada repositório GitHub.


Adaptadores de ECommerce

O Queue-Fair pode ser adicionado facilmente a qualquer sistema de eCommerce usando o Adaptador JavaScript do lado do cliente descrito acima.

Também oferecemos código Adaptador para trabalhar no lado do servidor com muitos servidores de eCommerce populares.

Repositórios GitHub

Magento Plugin

Magento

O repositório GitHub para o Queue-Fair Adaptador de Sala de Espera Virtual para Magento.

Adaptador de Sala de Espera Virtual WooCommerce/PHP

WooCommerce

O repositório GitHub para o Queue-Fair Adaptador de Sala de Espera Virtual para WooCommerce em PHP.

PrestaShop/PHP Adaptador de Sala de Espera Virtual

PrestaShop

O repositório GitHub para o Queue-Fair Adaptador de Sala de Espera Virtual para PrestaShop em PHP.

Recursos adicionais

Nossos adaptadores estão descritos no Guia Técnico. O Guia Técnico está disponível na seção Portal Queue-Fair > Ajuda, ou você pode solicitar uma cópia de nós.

Temos também guias suplementares disponíveis para a maioria das plataformas de comércio eletrônico - basta pedir aquele que você deseja.


Segurança Híbrida

Você pode facilmente combinar a flexibilidade do Adaptador JavaScript do lado do cliente com a camada adicional de segurança fornecida por nosso código do lado do servidor.

Queue-Fair assina cada visitante que passamos com uma impressão digital que é única para aquele Visitante. Exclusivamente no setor, a assinatura também inclui código específico do navegador do visitante, para evitar que os tokens de acesso sejam compartilhados.

Seu servidor web pode validar a assinatura usando um segredo conhecido somente por você e por nós - não por seus visitantes - para garantir que cada visitante tenha sido passado de forma justa pelos servidores Queue-Fair.

Assim, você pode usar o Adaptador JavaScript do lado do cliente para enviar e receber visitantes de e para a fila de espera, e verificar se há adulteração antes que eles façam o pedido com um código mínimo do lado do servidor, e evitar introduzir uma dependência em nosso sistema.

O código de exemplo está incluído em nossos Repositórios GitHub em todas as principais linguagens de programação web.

Repositórios GitHub

PHP

PHP

O repositório GitHub para o Queue-Fair Virtual Waiting Room Server-Side Adapter em PHP.

Java

Java

O repositório GitHub para o Queue-Fair Virtual Waiting Room Server-Side Adapter para Java, incluindo JBoss e Tomcat.

Ruby

Ruby

O repositório GitHub para o Queue-Fair Virtual Waiting Room Server-Side Adapter em Ruby e (opcionalmente) Rails.

Python

Python

O repositório GitHub para o Queue-Fair Virtual Waiting Room Server-Side Adapter em Python e (opcionalmente) Django.

.NET

.NET

O repositório GitHub para o Queue-Fair Virtual Waiting Room Server-Side Adapter para .NET, ASP e C#.

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

Node.js & JavaScript

O repositório GitHub para o Queue-Fair Virtual Waiting Room Server-Side Adapter for Node.js e (opcionalmente) Express.

Recursos adicionais

O Modelo de Segurança Híbrido é descrito em sua totalidade no Guia Técnico. O Guia Técnico está disponível na seção Portal Queue-Fair > Ajuda, ou você pode solicitar uma cópia de nós.


Licença

Nosso código publicado disponível no The GitHub Queue-Fair Repository é licenciado sob a Licença MIT, que está entre as licenças de código aberto mais permissivas.


Deseja saber como funciona o Queue-Fair?