Ressourcen für Entwickler



Hinzufügen von Queue-Fair

Der virtuelle Wartesaal Queue-Fair lässt sich innerhalb weniger Minuten in eine Vielzahl von Web- und App-Plattformen integrieren. Verwenden Sie einfach einen unserer Adapter. Weitere Informationen darüber, wie Sie Queue-Fair am besten in Ihr bestehendes System integrieren, finden Sie im Technischen Leitfaden oder im Queue-Fair Portal > Hilfe Bereich.

Der Client-seitige Adapter

Für Websites ist die einfachste Art der Integration mit Queue-Fair das Hinzufügen des Client-Side Queue-Fair Adapter JavaScript-Tags zu Ihren Seiten. Sie können den Adapter sicher zu allen Seiten Ihrer Website hinzufügen und die Aktivierungsregeln im Queue-Fair Portal verwenden, um zu bestimmen, welche Seiten eine Warteschlange auslösen dürfen.

Da er in den Browsern Ihrer Besucher läuft, kann der Client-Side-Adapter von technisch versierten Besuchern deaktiviert werden, ist aber sehr wirksam bei der Verhinderung von Überlastungen, da nur eine sehr kleine Minderheit von Personen versuchen wird, die Warteschlange durch Manipulationen am JavaScript zu überspringen. Die meisten unserer Kunden verwenden den Client-Side-Adapter, weil er einen Absturz der Website wirksam verhindert, einfach zu installieren ist und keine Abhängigkeit zwischen unserem und Ihrem System schafft.

Sie können eine Sicherheitsebene hinzufügen, indem Sie das JavaScript-Tag durch einen serverseitigen Adapter ersetzen, oder die Flexibilität des JavaScript-Adapters mit dem auf dieser Seite beschriebenen hybriden Sicherheitsmodell kombinieren; beide Methoden sind dann sicher.

Eine einzige Codezeile

Um den Client-Side Adapter zu Ihrer Seite hinzuzufügen, fügen Sie einfach die folgende Zeile Code in die<head> Abschnitt Ihrer Seiten:

Fügen Sie unser virtuelles Wartezimmer mit dieser einzigen Codezeile in Ihre Website ein und verhindern Sie Website-Abstürze

Einige Kunden fügen das Wort defer an das Tag, wodurch das Adapter-Skript parallel zum parallel zum Parsen der Seite heruntergeladen wird und die Ausführung des Skripts erst Ausführung des Skripts im Browser des Besuchers erst dann beginnt, wenn die Seite fertig geparst ist (also typischerweise nachdem alle anderen Skripte auf Ihrer Seite beendet sind).

Das Hinzufügen des Wortes defer kann die Zeit bis zum ersten Bild um einen kleinen Bruchteil einer Sekunde verbessern verbessern, aber wenn Sie sich dafür entscheiden, bedeutet das, dass alle Besucher, die in der Warteschlange stehen sollten Besucher, die in der Warteschlange stehen sollten, sehen Ihre geschützte Seite einen Bruchteil einer Sekunde länger, bevor sie in die Warteschlange geschickt werden.

Google Tag Manager

Wir bieten auch das JavaScript Adapter Tag über Google Tag Manager an. Suchen Sie nach Queue-Fair in der Galerie der Community-Vorlagen, unter Tag hinzufügen. Bitte beachten Sie, dass einige Werbeblocker den Download der Masterdatei gtm.js von Google verhindern, wodurch alle Operationen des Google Tag Managers blockiert werden, einschließlich der Ausführung des Adapters für diese Besucher.Unser Tag

GitHub-Repositorien

Google Tag Manager

Google Tag Manager

Das GitHub-Repository für das Queue-Fair Virtual Waiting Room Google Tag Manager Client-Side Adapter Tag.

Dynamische Warteschlangenseiten

Alle gewünschten Daten können von Ihrer Website an unsere Server und die Warteschlangenseiten, die Ihre Besucher sehen, weitergeleitet werden, indem Sie das data-queue-fair-extra-Attribut verwenden, das im clientseitigen JavaScript-Tag und in der Google Tag Manager-Implementierung verfügbar ist. Bitte kontaktieren Sie den Support, wenn Sie dynamische Warteschlangenseiten für Ihr Konto aktivieren möchten.

Sie können diese Funktion nutzen, um Warteschlangenseiten im Handumdrehen anzupassen. Sie können Queue-Fair auch verwenden, um Daten, die Sie uns mit Ihren Besuchern senden, an Ihre Website zurückzugeben, wenn sie von der Warteschlange durchgelassen werden, um eine zusätzliche Sicherheitsebene zu schaffen.

Wir stellen auch eine Dynamische Warteschlangenseite API zur Verfügung, die die extra Daten verwendet, um jeden Aspekt einer Warteschlangenseite anzupassen, so dass Sie eine Warteschlange für Ihre gesamte Website erstellen und sie automatisch für verschiedene Ereignisse oder Produkte auf Ihrer Website anpassen können, ohne Änderungen an Ihren Warteschlangenseiten im Queue-Fair Portal vornehmen zu müssen.



Wordpress & WooCommerce

Wenn Sie eine Wordpress-basierte Website verwenden, wie z.B. das WooCommerce-Warenkorbsystem, können Sie den Client-Side JavasScript Adapter-Tag ganz einfach mit dem Wordpress Insert Headers & Footers Plugin hinzufügen, ohne dass Sie Ihre Themes ändern oder Wordpress-Code berühren müssen.

Laden Sie einfach das Insert Headers & Footers Plugin herunter, entpacken Sie es in Ihren /wp-content/plugins/-Ordner, aktivieren Sie das Plugin im Plugins-Menü, öffnen Sie das Plugin im Einstellungen-Menü, fügen Sie den Tag zu Scripts in Header wie gezeigt hinzu, klicken Sie unten auf Speichern, und fertig!

Das Dashboard des Queue-Fair-Portals

Client-seitiger Adapter Zusätzliche Ressourcen

Der Client-Side Adapter ist im Technischen Leitfaden ausführlich beschrieben. Das technische Handbuch ist im Bereich Queue-Fair Portal > Hilfe verfügbar, oder Sie können eine Kopie bei uns anfordern.


Server-seitige Adapter

Während der Client-Side Adapter in JavaScript in den Browsern Ihrer Besucher läuft, laufen die Queue-Fair Server-Side Adapter auf Ihrem Webserver.

Web-Server-Adapter

Das bedeutet, dass Ihr Webserver zusätzliche Sicherheitsfunktionen nutzen kann, um Personen, die nicht in die Warteschlange aufgenommen wurden, den Zugang zu verweigern. Dies bedeutet auch, dass Ihr Webserver die Last der Generierung und Bereitstellung von Seiten mit Adapter-Skript vermeidet.

Das Hinzufügen der Queue-Fair Server-Side Adapter-Bibliotheken dauert nur wenige Minuten und erfordert nur minimale Code-Änderungen zur Aktivierung und Ausführung des Adapters.

Die meisten unserer Kunden beginnen mit dem Client-seitigen JavaScript-Adapter und wechseln nur dann zum Server-seitigen Adapter, wenn ein spezieller Geschäftsbedarf besteht.

Einfach & Abgesicherter Modus

Die Queue-Fair Server-Side-Adapter können im einfachen oder sicheren Modus betrieben werden.

Im einfachen Modus werden alle Besucher an den Queue-Fair-Server geschickt, um gezählt zu werden, unabhängig davon, ob sich eine Warteschlange gebildet hat oder nicht. Wenn sich keine Warteschlange gebildet hat, werden sie sofort zu Ihrem Webserver zurückgeschickt, ohne eine Warteschlangenseite zu sehen - aber mit der Signatur, die Ihr Webserver benötigt, um sicherzustellen, dass nur Personen, die von der Warteschlange durchgelassen wurden, auf Ihre geschützten Ressourcen zugreifen können.

Im Safe Mode werden Besucher nur dann zu den Queue-Fair-Servern geschickt, wenn es eine Warteschlange gibt. Ihr Webserver konsultiert direkt unsere Warteschlangenserver, um diese Entscheidung zu treffen. Die Besucher werden auch dann sicher digital signiert, wenn keine Warteschlangenseite angezeigt wird.

Der sichere Modus wird für alltägliche Warteschlangen empfohlen. Der einfache Modus eignet sich für eine zeitlich begrenzte Veranstaltung, bei der Sie Tausende von Personen erwarten, da er die Latenzzeit aufgrund des Prüfaufrufs von Ihrem Webserver zu unseren Warteschlangen-Servern eliminiert, was bedeutet, dass Sie Personen effizienter in die Warteschlange schicken können.

GitHub-Repositorien

PHP-Adapter für virtuelle Warteräume') ?>

PHP

Das GitHub-Repository für den Queue-Fair Virtual Waiting Room Server-Side Adapter in PHP.

Java Virtual Waiting Room Adapter

Java

Das GitHub-Repository für den Queue-Fair Virtual Waiting Room Server-Side Adapter für Java, einschließlich JBoss und Tomcat.

Ruby Virtual Waiting Room Adapter

Ruby

Das GitHub-Repository für den Queue-Fair Virtual Waiting Room Server-Side Adapter in Ruby und (optional) Rails.

Python Adapter für virtuelle Warteräume

Python

Das GitHub-Repository für den Queue-Fair Virtual Waiting Room Server-Side Adapter in Python und (optional) Django.

dotNet Adapter für virtuelle Warteräume

.NET

Das GitHub Repository für den Queue-Fair Virtual Waiting Room Server-Side Adapter für .NET, ASP und C#.

Node.js & JavaScript Virtueller Warteraum Adapter

Node.js & JavaScript

Das GitHub-Repository für den Queue-Fair Virtual Waiting Room Server-Side Adapter für Node.js und (optional) Express.



Dynamische Warteschlangenseiten

Wie beim Client-Side Adapter können alle Daten, die Sie wünschen, von Ihrem Webserver an unsere Server und die Warteschlangenseiten, die Ihre Besucher sehen, weitergegeben werden, indem diese Informationen im Aufruf des Server-Side Adapters übergeben werden. Dies ermöglicht Dynamic Queue Page oder andere on-the-fly Anpassungen auf die gleiche Weise - alle Funktionen des Client-Side Adapters werden vollständig unterstützt. Bitte kontaktieren Sie den Support, wenn Sie Dynamic Queue Pages für Ihren Account aktivieren möchten.

Serverseitiger Adapter Zusätzliche Ressourcen

Unsere Server-Side-Adapter sind im Technischen Leitfaden ausführlich beschrieben. Der technische Leitfaden ist im Queue-Fair Portal > Hilfe Bereich verfügbar, oder Sie können eine Kopie bei uns anfordern. Weitere Informationen zu den einzelnen Adaptern finden Sie auch in der README.md des jeweiligen GitHub-Repositorys.


REST-APIs

Queue-Fair bietet Entwicklern Zugang zu sechs REST-API-Modulen. Sie benötigen ein Queue-Fair-Konto, um die API zu nutzen. Um den API-Zugang für Ihr Konto zu aktivieren, wenden Sie sich bitte an den Queue-Fair-Support. Unsere REST-API-Module entsprechen den Standards OpenAPI, RFC 7807 und RFC 3339.

Unser Angebot an API-Modulen ist umfassend - alles, was Sie im Portal tun können, können Sie auch mit der API tun, mit Ausnahme der Verwaltung von Portalnutzern, die aus Datenschutzgründen ausgeschlossen ist.

Jedes API-Modul ist auf api.queue-fair.net vollständig dokumentiert. Dort finden Sie auch eine Swagger-Schnittstelle für einfache Nutzung und Tests. Aus Sicherheitsgründen sind alle API-Aufrufe durch sichere TLS-Verschlüsselung geschützt und erfordern einen API-Schlüssel, der für Ihr Konto spezifisch ist.

API-Module

Berichts-API

Für Live-Berichte in Echtzeit, historische Berichte und aggregierte Warteschlangenstatistiken.

API für die Warteschlangenverwaltung

Zur programmgesteuerten Erstellung und Änderung von Warteschlangen in Echtzeit.

Kontoführungs-API

Zum Anzeigen und Aktualisieren Ihrer kontoweiten Einstellungen.

Asset-Management-API

Zur Verwaltung der Assets, die von Ihren Warteschlangenseiten verwendet werden, die von Google CDN bereitgestellt werden.

Präsentation API

Für die Änderung jedes Aspekts des HTML Ihrer Warteschlangenseiten und die Aktualisierung und Erstellung von Varianten im laufenden Betrieb.

Aktivierungs-API

Zum Konfigurieren der Aktivierungsregeln, die bestimmen, welche Seiten Ihrer Website eine Warteschlange auslösen können und welche Seite angezeigt wird.



Dynamische Warteschlangenseiten

Sie können Ihre Warteschlangenseiten auch spontan ändern, ohne die Datenbank mit Hilfe des Portals oder der Präsentations-API aktualisieren zu müssen. Kontaktieren Sie den Support für weitere Informationen und um dynamische Warteschlangenseiten für Ihr Konto zu aktivieren.

REST API Zusätzliche Ressourcen

Wie in RFC 7807 gefordert, finden Sie die Dokumentation zu Fehlermeldungen, die von unseren REST-API-Modulen zurückgegeben werden können, unter queue-fair.com/api-error


Native Apps

Queue-Fair sieht sowohl auf mobilen Browsern als auch auf Desktops und Laptops gut aus.

Sie können Queue-Fair auch direkt in Ihren nativen iOS- und Android-Apps sowie in React Native-Apps auf iOS, Android, Windows und MacOS verwenden, um ressourcenintensive Aktivitäten oder Vorgänge zu schützen.

Die Queue-Fair-App-Adapter verwenden einen WebClient, um Ihren Benutzern benutzerdefinierte Warteschlangen anzuzeigen, wenn Ihre Dienste zu stark ausgelastet sind, und bieten dabei die Flexibilität und Benutzerfreundlichkeit der Queue-Fair Portal.

Sie können Benutzer in die gleiche Warteschlange wie Ihre Website-Besucher einreihen oder eine separate Warteschlange für Ihre App-Benutzer einrichten - das bleibt Ihnen überlassen.

Genau wie bei unseren webbasierten Warteschlangen wird der Platz eines jeden Nutzers automatisch gespeichert, wenn er Ihre App verlässt.

GitHub-Repositorien

iOS, MacOS und Apple Adapter für virtuelle Warteräume

iOS & MacOS

Das GitHub-Repository für den Queue-Fair Virtual Waiting Room iOS und MacOS Adapter.

Android Adapter für virtuelle Warteräume

Android

Das GitHub-Repository für den Queue-Fair Virtual Waiting Room Adapter für Android.

React Native App Virtueller Warteraum Adapter

React Native

Das GitHub-Repository für den Queue-Fair Virtual Waiting Room Adapter für React Native Apps für Android, iOS, MacOS und Windows.

Warteschlangen-Benachrichtigungen

Der Queue-Fair Adapter macht es einfach, Push-Benachrichtigungen an Benutzer zu senden, die Ihre App oder Warteschlange nicht verwenden, wenn sie an der Reihe sind. Der Platz des Nutzers in der Warteschlange wird automatisch durch den Adapter in Ihrer App persistent gespeichert. Navigiert der Benutzer von Ihrer App weg, teilt Ihre App Ihrem Push Notification Server mit, dass eine Benachrichtigung gesendet werden soll, und sendet die gespeicherte Warteschlangenposition als Teil dieser Nachricht an Ihren Push Notification Server.

Es handelt sich um dieselbe Technologie, die wir für unsere WeQ4U-Verbraucher-App verwenden, die allein in Großbritannien rund 2 Millionen Mal heruntergeladen wurde.

Ihr Push-Benachrichtigungsserver fragt regelmäßig die Queue-Fair-Status-API ab, um die Position in der Warteschlange zu ermitteln, die gerade bedient wird. Wenn diese größer ist als die Position in der Warteschlange eines bestimmten Benutzers, ist es an der Zeit, diesem Benutzer die Benachrichtigung zu senden. Wenn der Benutzer in die Warteschlange zurückkehrt oder weitergereicht wird, bevor eine Push-Benachrichtigung gesendet wurde, benachrichtigt der Adapter Ihre Anwendung, und Ihre Anwendung teilt dem Push-Benachrichtigungsserver mit, dass die Benachrichtigung nicht mehr erforderlich ist.

Unseres Wissens nach sind wir der einzige Anbieter von virtuellen Warteräumen, der diese Funktion unterstützt.

Video-Ressourcen

Hier ist ein Video des Native App Adapters in Aktion, in dem gezeigt wird, dass der Platz des Benutzers auch dann gespeichert wird, wenn die App komplett gestoppt wird, und in dem auch die Adapter-Hooks gezeigt werden, die Ihre App zum Senden von Push-Benachrichtigungen verwendet.

Zusätzliche Ressourcen

Unsere Native App Adapters sind im Technischen Leitfaden beschrieben. Der technische Leitfaden ist im Bereich Queue-Fair Portal > Hilfe verfügbar, oder Sie können eine Kopie bei uns anfordern. Weitere Informationen zu den einzelnen Adaptern, die spezifisch für iOS und Android sind, finden Sie in der README.md des jeweiligen GitHub-Repository.


ECommerce-Adapter

Queue-Fair kann leicht zu jedem eCommerce-System hinzugefügt werden, indem der oben beschriebene Client-Side JavaScript Adapter verwendet wird.

Wir bieten auch Adapter-Code an, um auf der Server-Seite mit vielen gängigen eCommerce-Servern zu arbeiten.

GitHub-Repositorien

Magento Plugin

Magento

Das GitHub-Repository für den Queue-Fair Virtual Waiting Room Adapter für Magento.

WooCommerce/PHP Adapter für virtuelle Warteräume

WooCommerce

Das GitHub-Repository für den Queue-Fair Virtual Waiting Room Adapter für WooCommerce in PHP.

PrestaShop/PHP Adapter für virtuelle Warteräume

PrestaShop

Das GitHub Repository für den Queue-Fair Virtual Waiting Room Adapter für PrestaShop in PHP.

Zusätzliche Ressourcen

Unsere Adapter sind im Technischen Leitfaden beschrieben. Der technische Leitfaden ist im Bereich Queue-Fair Portal > Hilfe verfügbar, oder Sie können eine Kopie bei uns anfordern.

Wir haben auch zusätzliche Leitfäden für die meisten eCommerce-Plattformen verfügbar - fragen Sie einfach nach dem von Ihnen gewünschten Leitfaden.


Hybride Sicherheit

Sie können die Flexibilität des Client-seitigen JavaScript-Adapters mit der zusätzlichen Sicherheitsebene kombinieren, die unser Server-seitiger Code bietet.

Queue-Fair signiert jeden Besucher, den wir passieren, mit einem digitalen Fingerabdruck, der für diesen Besucher einzigartig ist. Einzigartig in der Branche enthält die Signatur auch einen spezifischen Code für den Browser des Besuchers, um zu verhindern, dass Zugangstoken weitergegeben werden.

Ihr Webserver kann die Signatur anhand eines Geheimnisses validieren, das nur Ihnen und uns bekannt ist - nicht aber Ihren Besuchern -, um sicherzustellen, dass jeder Besucher die Queue-Fair-Server ordnungsgemäß passiert hat.

Sie können also den Client-seitigen JavaScript-Adapter verwenden, um Besucher an die Warteschlange zu senden und von ihr zu empfangen und sie auf Manipulationen zu überprüfen, bevor sie mit minimalem Server-seitigem Code einen Auftrag erteilen, ohne dass eine Abhängigkeit von unserem System entsteht.

In unseren GitHub-Repositories finden Sie Beispielcode in allen wichtigen Web-Programmiersprachen.

GitHub-Repositorien

PHP

PHP

Das GitHub-Repository für den Queue-Fair Virtual Waiting Room Server-Side Adapter in PHP.

Java

Java

Das GitHub-Repository für den Queue-Fair Virtual Waiting Room Server-Side Adapter für Java, einschließlich JBoss und Tomcat.

Ruby

Ruby

Das GitHub-Repository für den Queue-Fair Virtual Waiting Room Server-Side Adapter in Ruby und (optional) Rails.

Python

Python

Das GitHub-Repository für den Queue-Fair Virtual Waiting Room Server-Side Adapter in Python und (optional) Django.

.NET

.NET

Das GitHub Repository für den Queue-Fair Virtual Waiting Room Server-Side Adapter für .NET, ASP und C#.

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

Node.js & JavaScript

Das GitHub-Repository für den Queue-Fair Virtual Waiting Room Server-Side Adapter für Node.js und (optional) Express.

Zusätzliche Ressourcen

Das hybride Sicherheitsmodell ist im Technischen Leitfaden ausführlich beschrieben. Der technische Leitfaden ist im Abschnitt Queue-Fair Portal > Hilfe verfügbar, oder Sie können eine Kopie bei uns anfordern.


Lizenz

Unser veröffentlichter Code, der unter The GitHub Queue-Fair Repository verfügbar ist, steht unter der MIT-Lizenz, die zu den freizügigsten Open-Source-Lizenzen gehört.


Sie möchten wissen, wie Queue-Fair funktioniert?