Ressources pour les développeurs



Ajout de Queue-Fair

La salle d'attente virtuelle Queue-Fair s'ajoute facilement à une grande variété de plateformes web et d'applications en quelques minutes. Il suffit d'utiliser l'un de nos adaptateurs. Vous pouvez trouver plus d'informations sur la meilleure façon d'intégrer Queue-Fair à votre système existant dans le Guide technique, ou dans la section Portail Queue-Fair > Aide.

L'adaptateur côté client

Pour les sites Web, le moyen le plus simple d'intégrer Queue-Fair est d'ajouter la balise JavaScript Client-Side Queue-Fair Adapter à vos pages. Vous pouvez ajouter l'adaptateur à toutes les pages de votre site en toute sécurité et utiliser les règles d'activation du portail Queue-Fair pour déterminer quelles pages peuvent lancer une file d'attente.

Parce qu'il s'exécute dans le navigateur de vos visiteurs, l'adaptateur côté client peut être désactivé par des visiteurs techniquement compétents, mais il est très efficace pour prévenir la surcharge, car seule une très petite minorité de personnes tentera de sauter la file d'attente en manipulant le JavaScript. La plupart de nos clients utilisent l'adaptateur côté client parce qu'il est efficace pour éviter un plantage du site, qu'il est simple à installer et qu'il n'introduit aucune dépendance entre notre système et le vôtre.

Vous pouvez ajouter une couche de sécurité en remplaçant la balise JavaScript par un adaptateur côté serveur, ou combiner la souplesse de l'adaptateur JavaScript avec le modèle de sécurité hybride décrit sur cette page ; les deux méthodes sont alors sécurisées.

Une seule ligne de code

Pour ajouter l'adaptateur côté client à votre site, il suffit d'ajouter la ligne de code suivante au fichier <head> de vos pages:

Ajoutez notre salle d'attente virtuelle à votre site avec cette seule ligne de code et évitez les plantages de sites web.

Certains clients ajoutent le mot defer à la balise, ce qui a pour effet de télécharger le script de l'adaptateur parallèlement à l'analyse syntaxique de la page et de ne lancer l'exécution du script dans le navigateur du visiteur qu'une fois l'analyse syntaxique de la page terminée (donc généralement après la fin de tous les autres scripts de votre page).

L'ajout du mot " defer" peut améliorer le temps de la première peinture d'une petite fraction de seconde dans certains cas, mais si vous choisissez de le faire, cela signifie que tous les visiteurs qui devraient être mis en file d'attente verront votre page protégée pendant une fraction de seconde de plus avant d'être envoyés dans la file d'attente.

Gestionnaire de balises Google

Nous fournissons également le JavaScript Adapter Tag via Google Tag Manager. Recherchez Queue-Fair dans la galerie des modèles communautaires, sous Ajouter un tag. Veuillez noter que certains bloqueurs de publicité empêchent le téléchargement du master gtm.js de Google, ce qui bloque toutes les opérations de Google Tag Manager, y compris l'exécution de l'adaptateur pour ces visiteurs.Notre balise Salle d'attente virtuelle pour Google Tag Manager

Dépôts GitHub

Gestionnaire de balises Google

Gestionnaire de balises Google

Le dépôt GitHub pour la balise Salle d'attente virtuelle Queue-Fair Google Tag Manager Client-Side Adapter Tag.

Pages de file d'attente dynamique

Toutes les données que vous souhaitez peuvent être transmises de votre site à nos serveurs et aux pages de la file d'attente que vos visiteurs voient en utilisant l'attribut data-queue-fair-extra qui est disponible dans la balise JavaScript côté client et dans l'implémentation de Google Tag Manager. Veuillez contacter le service d'assistance si vous souhaitez activer les pages de file d'attente dynamiques sur votre compte.

Vous pouvez utiliser cette fonctionnalité pour personnaliser les pages de la file d'attente à la volée. Vous pouvez également utiliser Queue-Fair pour transmettre à votre site les données que vous nous envoyez avec vos visiteurs lorsqu'ils passent par la file d'attente, pour une couche supplémentaire de sécurité.

Nous fournissons également une API de page d'attente dynamique qui utilise les données supplémentaires pour personnaliser n'importe quel aspect d'une page d'attente, de sorte que vous pouvez créer une file d'attente pour l'ensemble de votre site et la personnaliser automatiquement pour différents événements ou produits sur votre site, sans avoir à apporter des modifications à vos pages d'attente dans le portail Queue-Fair.



Wordpress et WooCommerce

Si vous utilisez un site basé sur Wordpress, tel que le système de panier d'achat WooCommerce, vous pouvez facilement ajouter la balise Client-Side JavasScript Adapter à l'aide du plugin Wordpress Insert Headers & Footers, sans devoir modifier vos thèmes ou toucher au code Wordpress.

Il suffit de télécharger le plugin Insert Headers & Footers, de le décompresser dans votre dossier /wp-content/plugins/, d'activer le plugin dans le menu Plugins, d'ouvrir le plugin dans le menu Paramètres, d'ajouter la balise à Scripts in Header comme indiqué, de cliquer sur Enregistrer en bas de la page, et le tour est joué !

Le tableau de bord du portail Queue-Fair

Ressources supplémentaires pour l'adaptateur côté client

L'adaptateur côté client est entièrement décrit dans le guide technique. Le guide technique est disponible dans le portail Queue-Fair > Aide, ou vous pouvez nous en demander une copie.


Adaptateurs côté serveur

Alors que l'adaptateur côté client s'exécute en JavaScript dans le navigateur de vos visiteurs, les adaptateurs côté serveur Queue-Fair s'exécutent sur votre serveur Web.

Adaptateurs de serveur Web

Cela signifie que votre serveur Web peut tirer parti de fonctions de sécurité supplémentaires pour refuser l'accès aux personnes qui n'ont pas été mises en file d'attente. Cela signifie également que votre serveur web évite la charge de générer et de servir des pages contenant le script de l'adaptateur.

L'ajout des bibliothèques de l'adaptateur Queue-Fair côté serveur ne prend que quelques minutes et les modifications du code sont minimes pour activer et exécuter l'adaptateur.

La plupart de nos clients commencent par l'adaptateur JavaScript côté client et ne passent à l'adaptateur côté serveur que lorsqu'ils ont un besoin commercial spécifique.

Mode simple et sûr

Les adaptateurs côté serveur Queue-Fair peuvent fonctionner en mode simple ou sécurisé.

En mode simple, tous les visiteurs sont envoyés aux serveurs Queue-Fair pour être comptés, qu'une file d'attente se soit formée ou non. S'il n'y a pas de file d'attente, ils sont renvoyés directement à votre serveur Web, sans voir de page de file d'attente, mais avec la signature dont votre serveur Web a besoin pour s'assurer que seules les personnes qui sont passées par la file d'attente peuvent accéder à vos ressources protégées.

En mode sans échec, les visiteurs ne sont envoyés vers les serveurs Queue-Fair que lorsqu'il y a une file d'attente. Votre serveur Web consulte directement nos serveurs de file d'attente pour déterminer s'il y a une file d'attente. Les visiteurs bénéficient toujours d'une signature numérique sécurisée, qu'une page de file d'attente soit affichée ou non.

Le mode sans échec est recommandé pour les files d'attente quotidiennes. Le mode simple est approprié pour un événement chronométré où vous attendez des milliers de personnes, car il élimine la latence due à l'appel de vérification de votre serveur web à nos serveurs de file d'attente, ce qui signifie que vous pouvez envoyer des personnes dans la file d'attente plus efficacement.

Dépôts GitHub

Adaptateur de salle d'attente virtuelle PHP') ?>

PHP

Le dépôt GitHub pour l'adaptateur côté serveur de la salle d'attente virtuelle Queue-Fair en PHP.

Adaptateur de salle d'attente virtuelle Java

Java

Le dépôt GitHub pour l'adaptateur côté serveur de la salle d'attente virtuelle Queue-Fair pour Java, y compris JBoss et Tomcat.

Adaptateur pour salle d'attente virtuelle Ruby

Ruby

Dépôt GitHub de l'adaptateur côté serveur de la salle d'attente virtuelle Queue-Fair en Ruby et (éventuellement) Rails..

Adaptateur pour salle d'attente virtuelle Python

Python

Le dépôt GitHub pour l'adaptateur côté serveur de la salle d'attente virtuelle Queue-Fair en Python et (en option) Django.

Adaptateur de salle d'attente virtuelle dotNet

.NET

Dépôt GitHub de l'adaptateur côté serveur de la salle d'attente virtuelle Queue-Fair pour .NET, ASP et C#.

Adaptateur de salle d'attente virtuelle Node.js & JavaScript

Node.js & JavaScript

Le dépôt GitHub de l'adaptateur côté serveur de la salle d'attente virtuelle Queue-Fair pour Node.js et (en option) Express.



Pages de file d'attente dynamique

Comme avec l'adaptateur côté client, toutes les données que vous souhaitez peuvent être transmises de votre serveur Web à nos serveurs et aux pages de la file d'attente que vos visiteurs voient en transmettant ces informations dans l'appel de l'adaptateur côté serveur. Cela facilite la personnalisation à la volée des pages de file d'attente dynamique ou autre de la même manière - toutes les fonctionnalités de l'adaptateur côté client sont entièrement prises en charge. Veuillez contacter le support si vous souhaitez activer les Dynamic Queue Pages sur votre compte.

Adaptateur côté serveur Ressources supplémentaires

Nos adaptateurs côté serveur sont entièrement décrits dans le guide technique. Le guide technique est disponible dans le portail Queue-Fair > Aide, ou vous pouvez nous en demander une copie. Vous pouvez également trouver plus d'informations sur chacun des adaptateurs dans le fichier README.md de chaque dépôt GitHub.


APIs REST

Queue-Fair donne aux développeurs l'accès à six modules API REST. Vous aurez besoin d'un compte Queue-Fair pour utiliser l'API. Pour activer l'accès à l'API pour votre compte, veuillez contacter l'assistance Queue-Fair. Nos modules API REST sont conformes aux normes OpenAPI, RFC 7807 et RFC 3339.

Notre suite de modules API est complète - tout ce que vous pouvez faire dans le portail, vous pouvez également le faire avec l'API, à l'exception de la gestion des utilisateurs du portail qui est exclue pour des raisons de confidentialité.

Chaque module API est entièrement documenté sur api.queue-fair.net, où vous trouverez également une interface Swagger pour faciliter l'utilisation et les tests. Pour des raisons de sécurité, tous les appels API sont protégés par un cryptage TLS sécurisé et nécessitent une clé API spécifique à votre compte.

Modules API

API de rapport

Pour obtenir des rapports en direct et en temps réel, des rapports historiques et des statistiques globales sur les files d'attente.

API de gestion des files d'attente

Pour créer et modifier les files d'attente de manière programmatique et en temps réel.

API de gestion de compte

Pour consulter et mettre à jour les paramètres de votre compte.

API de gestion des actifs

Pour gérer les actifs utilisés par vos pages de file d'attente servies par Google CDN.

API de présentation

Pour modifier tout aspect du HTML de vos pages de file d'attente et mettre à jour et créer des variantes à la volée.

API d'activation

Pour configurer les règles d'activation qui déterminent quelles pages de votre site peuvent déclencher une file d'attente, et quelle page est affichée.



Pages de file d'attente dynamique

Vous pouvez également modifier vos pages de file d'attente à la volée sans avoir à mettre à jour la base de données en utilisant le portail ou l'API de présentation. Contactez le support pour plus de détails et pour activer les pages de file d'attente dynamiques sur votre compte.

Ressources supplémentaires pour l'API REST

Comme l'exige la RFC 7807, vous pouvez trouver de la documentation sur les messages d'erreur qui peuvent être renvoyés par nos modules API REST à l'adresse queue-fair.com/api-error.


Applications natives

Queue-Fair s'adapte aussi bien aux navigateurs mobiles qu'aux ordinateurs de bureau et portables.

Vous pouvez également utiliser Queue-Fair directement dans vos applications natives iOS et Android, ainsi que dans les applications React Native sur iOS, Android, Windows et MacOS, pour protéger les activités ou opérations gourmandes en ressources.

Les adaptateurs d'applications Queue-Fair utilisent un client Web pour afficher des files d'attente personnalisées à l'intention de vos utilisateurs lorsque vos services sont trop occupés, avec la souplesse et la facilité d'utilisation de l'outil de gestion des files d'attente. Queue-Fair Portal.

Vous pouvez placer les utilisateurs dans la même file d'attente que les visiteurs de votre site web, ou créer une file d'attente distincte pour les utilisateurs de votre application - c'est vous qui voyez.

Tout comme nos files d'attente en ligne, la place de chaque utilisateur est automatiquement sauvegardée s'il quitte votre application.

Dépôts GitHub

Adaptateur pour salle d'attente virtuelle iOS, MacOS et Apple

iOS & MacOS

Le dépôt GitHub pour l'adaptateur iOS et MacOS de la salle d'attente virtuelle Queue-Fair.

Adaptateur Android pour salle d'attente virtuelle

Android

Le dépôt GitHub pour l'adaptateur de salle d'attente virtuelle Queue-Fair pour Android.

Application React Native Adaptateur pour salle d'attente virtuelle

React Native

Le dépôt GitHub pour l'adaptateur de salle d'attente virtuelle Queue-Fair pour les applications React Native pour Android, iOS, MacOS et Windows.

Notifications de la file d'attente

L'adaptateur Queue-Fair permet d'envoyer facilement des notifications push aux utilisateurs qui n'utilisent pas votre application ou votre file d'attente lorsque leur tour est appelé. La place de l'utilisateur dans la file d'attente est automatiquement stockée de manière persistante par l'adaptateur dans votre application. Si l'utilisateur s'éloigne de votre application, celle-ci indique à votre serveur de notification push qu'une notification doit être envoyée, en envoyant les informations relatives à la position dans la file d'attente dans le cadre de ce message à votre serveur de notification push.

Il s'agit de la même technologie que celle utilisée pour notre application grand public WeQ4U, qui a été téléchargée près de deux millions de fois rien qu'au Royaume-Uni.

Votre serveur de notification Push Notification consulte périodiquement l'API d'état Queue-Fair pour demander la position de la file d'attente actuellement servie. Lorsque cette position est supérieure à celle de la file d'attente d'un utilisateur particulier, il est temps d'envoyer la notification à cet utilisateur. Si l'utilisateur retourne dans la file d'attente ou passe avant l'envoi de la notification, l'adaptateur en informe votre application, et celle-ci indique à votre serveur de notification que la notification n'est plus nécessaire.

À notre connaissance, nous sommes le seul fournisseur de salles d'attente virtuelles à prendre en charge cette fonctionnalité.

Ressources vidéo

Voici une vidéo de l'adaptateur pour applications natives en action, montrant que la place de l'utilisateur est sauvegardée même si l'application est complètement arrêtée, et montrant également les crochets de l'adaptateur que votre application utilise pour envoyer des notifications push.

Ressources supplémentaires

Nos adaptateurs d'applications natives sont décrits dans le guide technique. Le guide technique est disponible dans le portail Queue-Fair > Aide, ou vous pouvez nous demander une copie. Vous pouvez également trouver plus d'informations sur chacun des adaptateurs spécifiques à iOS et Android dans le fichier README.md de chaque dépôt GitHub.


Adaptateurs pour le commerce électronique

Queue-Fair peut être ajouté facilement à tout système de commerce électronique en utilisant l'adaptateur JavaScript côté client décrit ci-dessus.

Nous proposons également un code adaptateur pour travailler du côté serveur avec de nombreux serveurs de commerce électronique populaires.

Dépôts GitHub

Magento Plugin

Magento

Le dépôt GitHub pour l'adaptateur de salle d'attente virtuelle Queue-Fair pour Magento.

Adaptateur pour salle d'attente virtuelle WooCommerce/PHP

WooCommerce

Le dépôt GitHub pour l'adaptateur de salle d'attente virtuelle Queue-Fair pour WooCommerce en PHP.

Adaptateur pour salle d'attente virtuelle PrestaShop/PHP

PrestaShop

Le dépôt GitHub pour l'adaptateur de salle d'attente virtuelle Queue-Fair pour PrestaShop en PHP.

Ressources supplémentaires

Nos adaptateurs sont décrits dans le guide technique. Le guide technique est disponible dans le portail Queue-Fair > Aide, ou vous pouvez nous en demander une copie.

Nous disposons également de guides supplémentaires pour la plupart des plateformes de commerce électronique - il suffit de demander celui que vous souhaitez.


Sécurité hybride

Vous pouvez facilement combiner la flexibilité de l'adaptateur JavaScript côté client avec la couche de sécurité supplémentaire fournie par notre code côté serveur.

Queue-Fair signe chaque visiteur que nous faisons passer avec une empreinte digitale numérique qui est unique à ce visiteur. Fait unique dans le secteur, la signature comprend également un code spécifique au navigateur du visiteur, afin d'empêcher le partage des jetons d'accès.

Votre serveur web peut valider la signature à l'aide d'un secret connu uniquement de vous et de nous - et non de vos visiteurs - afin de garantir que chaque visiteur est passé équitablement par les serveurs Queue-Fair.

Ainsi, vous pouvez utiliser l'adaptateur JavaScript côté client pour envoyer et recevoir des visiteurs vers et depuis la file d'attente, et vérifier qu'ils ne sont pas altérés avant qu'ils ne passent commande avec un minimum de code côté serveur, et éviter d'introduire une dépendance sur notre système.

Des exemples de code sont inclus dans nos dépôts GitHub dans tous les principaux langages de programmation web.

Dépôts GitHub

PHP

PHP

Le dépôt GitHub pour l'adaptateur côté serveur de la salle d'attente virtuelle Queue-Fair en PHP.

Java

Java

Le dépôt GitHub pour l'adaptateur côté serveur de la salle d'attente virtuelle Queue-Fair pour Java, y compris JBoss et Tomcat.

Ruby

Ruby

Le dépôt GitHub pour l'adaptateur côté serveur de la salle d'attente virtuelle Queue-Fair en Ruby et (éventuellement) Rails.

Python

Python

Le dépôt GitHub pour l'adaptateur côté serveur de la salle d'attente virtuelle Queue-Fair en Python et (en option) Django.

.NET

.NET

Dépôt GitHub de l'adaptateur côté serveur de la salle d'attente virtuelle Queue-Fair pour .NET, ASP et C#.

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

Node.js & JavaScript

Le dépôt GitHub de l'adaptateur côté serveur de la salle d'attente virtuelle Queue-Fair pour Node.js et (en option) Express.

Ressources supplémentaires

Le modèle de sécurité hybride est entièrement décrit dans le guide technique. Le guide technique est disponible dans le portail Queue-Fair > Aide, ou vous pouvez nous en demander une copie.


Licence

Le code que nous avons publié et qui est disponible sur le dépôt GitHub Queue-Fair est protégé par la licence MIT, qui est l'une des plus permissives des licences Open Source.


Vous voulez savoir comment fonctionne le Queue-Fair ?