Resurser för utvecklare



Tillägg av Queue-Fair

Det virtuella väntrummet QFXNNPQ kan enkelt läggas till i en mängd olika webb- och app-plattformar på några minuter. Använd bara en av våra adaptrar. Du kan hitta mer information om det bästa sättet att integrera Queue-Fair med ditt befintliga system i den tekniska guiden eller i avsnittet Queue-Fair Portal > Hjälp i Queue-Fair Portal > Hjälp. Om du letar efter information om hur du hindrar robotar eller människor från att göra flera order eller hur du skyddar din NFT-försäljning från för höga gasavgifter kan du läsa den här översikten eller få mer information i avsnittet Säkerhetsguide i portalen.

Adapter på klientsidan

För webbplatser är det enklaste sättet att integrera Queue-Fair att lägga till JavaScript-tagget Client-Side Queue-Fair Adapter på dina sidor. Du kan säkert lägga till adaptern på alla sidor på din webbplats och använda aktiveringsreglerna i Queue-Fair-portalen för att avgöra vilka sidor som kan skapa en kö.

Eftersom den körs i besökarnas webbläsare kan Client-Side Adapter inaktiveras av tekniskt kunniga besökare, men den är mycket effektiv när det gäller att förhindra överbelastning, eftersom endast en mycket liten minoritet av människor försöker hoppa över kön genom att manipulera JavaScript. De flesta av våra kunder använder Client-Side Adapter eftersom den är effektiv när det gäller att förhindra att webbplatsen kraschar, är enkel att installera och inte medför något beroende mellan vårt och ert system.

Du kan lägga till ett säkerhetslager genom att ersätta JavaScript-taggen med en Server-Side Adapter, eller kombinera flexibiliteten hos JavaScript-adaptern med den hybrida säkerhetsmodell som beskrivs på den här sidan; båda metoderna är då säkra.

En enda kodlinje

För att lägga till klientsidans adapter på din webbplats lägger du bara till följande enda kodrad i <head> avsnittet på dina sidor:

Lägg till vårt virtuella väntrum på din webbplats med en enda kodrad och förhindra att webbplatsen kraschar.

Vissa kunder lägger till ordet defer till taggen, vilket gör att Adapters skript laddas ner parallellt med att sidan analyseras och att skriptet inte börjar köras i besökarens webbläsare förrän sidan är klar med analysen (alltså vanligtvis efter att alla andra skript på din sida har avslutats).

Att lägga till ordet " defer " kan i vissa fall förbättra Time to First Paint med en bråkdel av en sekund, men om du väljer att göra detta innebär det att besökare som borde stå i kö kommer att se din skyddade sida i en bråkdel av en sekund längre innan de skickas till kön.

Google Tag Manager

Vi tillhandahåller också JavaScript Adapter Tag via Google Tag Manager. Sök efter Queue-Fair i Community Templates Gallery, under Add Tag. Observera att vissa annonsblockerare förhindrar nedladdningen av master gtm.js från Google, vilket blockerar all verksamhet i Google Tag Manager, inklusive körning av adaptern för dessa besökare.Vår tagg för virtuellt väntrum för Google Tag Manager

GitHub-arkiv

Google Tag Manager

Google Tag Manager

GitHub-förrådet för Queue-Fair Virtual Waiting Room Google Tag Manager Client-Side Adapter Tag.

Dynamiska kö-sidor

Alla data du vill kan skickas från din webbplats till våra servrar och till de kösidor som dina besökare ser genom att använda attributet data-queue-fair-extra som finns tillgängligt i klientsidans JavaScript-tagg och i Google Tag Manager-implementationen. Kontakta supporten om du vill aktivera dynamiska kösidor på ditt konto.

Du kan använda den här funktionen för att anpassa kö-sidor i farten. Du kan också använda Queue-Fair för att skicka data som du skickar till oss med dina besökare tillbaka till din webbplats när de passerar kön, vilket ger ytterligare säkerhet.

Vi tillhandahåller också ett API för dynamiska kösidor som använder de extra uppgifterna för att anpassa alla aspekter av en kösida, så att du kan skapa en kö för hela din webbplats och anpassa den automatiskt för olika händelser eller produkter på din webbplats, utan att behöva göra några ändringar i dina kösidor i Queue-Fair-portalen.



Shopify, Wordpress och WooCommerce

Om du använder en Wordpress-baserad webbplats, t.ex. varukorgssystemet WooCommerce, kan du enkelt lägga till JavasScript-adaptertaggens klientsida med hjälp av Wordpress Insert Headers & Footers Plugin, utan att behöva ändra dina teman eller röra någon Wordpress-kod.

Ladda bara ner Insert Headers & Footers Plugin, packa upp den till din /wp-content/plugins/-mapp, aktivera pluginet i Plugins-menyn, öppna pluginet från Inställningar-menyn, lägg till taggen till Scripts i Header som visas, klicka på Save längst ner på sidan och du är klar!

Shopify är lika enkelt - här finns instruktioner för hur du lägger till Queue-Fair Client-Side JavaScript Adapter i din Shopify-butik.

Queue-Fair-portalens instrumentpanel

Klientsidans adapter Ytterligare resurser

Klientsidans adapter beskrivs fullständigt i den tekniska handboken. Den tekniska handboken finns tillgänglig i Queue-Fair Portal > Hjälp-sektionen, eller så kan du begära ett exemplar från oss.


Adaptrar på serversidan

Medan klientsidans adapter körs i JavaScript i besökarnas webbläsare körs Queue-Fair:s serversidans adaptrar på din webbserver.

Adaptrar för webbserver

Detta innebär att din webbserver kan utnyttja ytterligare säkerhetsfunktioner för att neka åtkomst till personer som inte har ställts i kö. Det innebär också att webbservern slipper belastningen från att generera och servera sidor som innehåller Adapter-skript.

Att lägga till biblioteken för Queue-Fair Server-Side Adapter tar bara några minuter med minimala kodändringar för att aktivera och köra adaptern.

De flesta av våra kunder börjar med Client-Side JavaScript Adapter och går över till Server-Side Adapter endast när det finns ett specifikt affärsbehov.

Enkelt och säkert läge

Queue-Fair Server-Side Adapters kan fungera i enkelt eller säkert läge.

I det enkla läget skickas alla besökare till Queue-Fair-servrarna för att räknas, oavsett om en kö har bildats eller inte. När det inte finns någon kö skickas besökarna tillbaka till din webbserver direkt, utan att se en kö-sida - men med den signatur som din webbserver behöver för att se till att endast personer som har passerat kön kan få tillgång till dina skyddade resurser.

I säkert läge skickas besökare endast till Queue-Fair-servrarna när det finns en kö. Din webbserver kontaktar våra köservrar direkt för att avgöra detta. Besökarna är fortfarande säkert digitalt signerade oavsett om en kö-sida visas eller inte.

Säkert läge rekommenderas för dagliga köer. Enkelt läge är lämpligt för ett tidsbestämt evenemang när du väntar tusentals personer, eftersom det eliminerar latenstiden på grund av kontrollsamtalet från din webbserver till våra köservrar, vilket innebär att du kan skicka personer till kön på ett effektivare sätt.

GitHub-arkiv

PHP-adapter för virtuellt väntrum') ?>

PHP

GitHub-förrådet för Queue-Fair Virtual Waiting Room Server-Side Adapter i PHP.

Adapter för virtuellt väntrum i Java

Java

GitHub-förrådet för Queue-Fair Virtual Waiting Room Server-Side Adapter för Java, inklusive JBoss och Tomcat.

Ruby Adapter för virtuellt väntrum

Ruby

GitHub-förrådet för Queue-Fair Virtual Waiting Room Server-Side Adapter i Ruby och (eventuellt) Rails.

Python-adapter för virtuellt väntrum

Python

GitHub-arkiv för Queue-Fair Virtual Waiting Room Server-Side Adapter i Python och (eventuellt) Django.

dotNet Adapter för virtuellt väntrum

.NET

GitHub-förrådet för Queue-Fair Virtual Waiting Room Server-Side Adapter för .NET, ASP och C#.

Node.js & JavaScript Adapter för virtuellt väntrum

Node.js & JavaScript

GitHub-arkiv för Queue-Fair Virtual Waiting Room Server-Side Adapter för Node.js och (eventuellt) Express.



Dynamiska kö-sidor

Precis som med klientsidans adapter kan alla data du vill skickas från din webbserver till våra servrar och de kösidor som dina besökare ser genom att skicka informationen i anropet till den serverbaserade adaptern. Detta underlättar dynamisk kösida eller annan anpassning i farten på samma sätt - alla funktioner i Client-Side Adapter stöds fullt ut. Kontakta supporten om du vill aktivera Dynamic Queue Pages på ditt konto.

Server-Side Adapter Ytterligare resurser

Våra serverbaserade adaptrar beskrivs utförligt i den tekniska guiden. Den tekniska handboken finns tillgänglig i Queue-Fair Portal > Hjälp-sektionen, eller så kan du begära ett exemplar från oss. Du kan också hitta mer information om varje adapter i README.md för varje GitHub-förvaringsutrymme.


Adaptrar för nätverkskanter

Queue-Fair Network-Edge Adapters körs i din CDN- eller molntjänstleverantörs ramverk, snarare än i besökarnas webbläsare eller på din ursprungsserver.

Adaptrar för Lambda- och CDN-leverantörer

Detta ger samma säkerhet som Server-Side Adapter och samma belastningsskydd som Direct Link.

Att lägga till biblioteken för Queue-Fair Network-Edge Adapter tar bara några minuter med minimala kodändringar hos din molnleverantör för att aktivera och köra adaptern, som normalt distribueras som en Lambda-funktion eller Edge Worker.

Enkelt och säkert läge

Precis som våra serverbaserade adaptrar kan våra nätverkskantadaptrar fungera i enkelt eller säkert läge.

Tillgängliga adaptrar

Amazon AWS CloudFront Network-Edge Adapter för virtuellt väntrum') ?>

CloudFront

Amazon AWS CloudFront Network-Edge Virtual Waiting Room Adapter.

Cloudflare Network-Edge Adapter för virtuellt väntrum

Cloudflare

Cloudflare Network-Edge Adapter för virtuellt väntrum

Fastly Network-Edge Adapter för virtuella väntrum

Fastly

Fastly Network-Edge Virtual Waiting Room Adapter..

Akamai Network-Edge Adapter för virtuellt väntrum

Akamai

Akamai Network-Edge Adapter för virtuellt väntrum.



Dynamiska kö-sidor

Precis som med klientsidans adapter kan alla data du vill skickas från din webbplats till våra servrar och de kösidor som dina besökare ser genom att skicka informationen i adapteranropet. Detta underlättar dynamisk kösida eller annan anpassning i farten på samma sätt - alla funktioner i Client-Side Adapter stöds fullt ut. Kontakta supporten om du vill aktivera dynamiska kösidor på ditt konto.

Nätverkskantadapter Ytterligare resurser

Våra nätverksadaptrar beskrivs utförligt i den tekniska guiden. Den tekniska guiden finns tillgänglig i Queue-Fair Portal > Hjälp-sektionen, eller så kan du begära ett exemplar från oss. Du kan också hitta mer information om varje adapter i README.md för varje GitHub-repository.


REST-API:er

Queue-Fair ger utvecklare tillgång till sex REST API-moduler. Du behöver ett Queue-Fair-konto för att använda API:et. Kontakta Queue-Fair Support för att aktivera API-åtkomst för ditt konto. Våra REST API-moduler överensstämmer med standarderna OpenAPI, RFC 7807 och RFC 3339.

Vårt utbud av API-moduler är omfattande - allt du kan göra i portalen kan du också göra med API:et, förutom att hantera portalanvändare, vilket är uteslutet av integritetsskäl.

Varje API-modul är fullständigt dokumenterad på api.queue-fair.net, där du också hittar ett Swagger-gränssnitt för att underlätta användning och testning. För säkerhets skull skyddas alla API-samtal av säker TLS-kryptering och kräver en API-nyckel som är specifik för ditt konto.

API-moduler

API för rapportering

För direktrapporter i realtid, historiska rapporter och aggregerad köstatistik.

API för köhantering

För att skapa och ändra köer programmatiskt i realtid.

API för kontohantering

För att visa och uppdatera dina kontoinställningar.

API för tillgångsförvaltning

För att hantera de tillgångar som används av dina kösidor som serveras av Google CDN.

API för presentationer

För att ändra alla aspekter av HTML-sidorna i din kö och för att uppdatera och skapa varianter i farten.

API för aktivering

För att konfigurera aktiveringsreglerna som bestämmer vilka sidor på webbplatsen som kan utlösa en kö och vilken sida som visas.



Dynamiska kö-sidor

Du kan också ändra dina kösidor i farten utan att behöva uppdatera databasen med hjälp av portal- eller presentations-API:n. Kontakta supporten för mer information och för att aktivera dynamiska kösidor på ditt konto.

REST API Ytterligare resurser

I enlighet med RFC 7807 kan du hitta dokumentation om felmeddelanden som kan returneras av våra REST API-moduler på queue-fair.com/api-error.


Inhemska appar

Queue-Fair ser bra ut på mobila webbläsare såväl som på stationära och bärbara datorer.

Du kan också använda Queue-Fair direkt i dina iOS- och Android-appar och React Native-appar på iOS, Android, Windows och MacOS för att skydda resurskrävande aktiviteter eller verksamheter.

Queue-Fair App Adapters använder en WebClient för att visa anpassade köbilder för användarna när tjänsterna är för upptagna, med den flexibilitet och användarvänlighet som finns i Queue-Fair Portal.

Du kan ställa användare i samma kö som besökare på din webbplats eller skapa en separat kö för appanvändare - det är upp till dig.

Precis som i våra webbaserade köer sparas varje användares plats automatiskt om de navigerar bort från appen.

GitHub-arkiv

iOS, MacOS och Apple Virtual Waiting Room Adapter

iOS & MacOS

GitHub-förrådet för Queue-Fair Virtual Waiting Room iOS- och MacOS-adaptern.

Android-adapter för virtuellt väntrum

Android

GitHub-arkiv för Queue-Fair Virtual Waiting Room Adapter för Android.

React Native-app virtuellt väntrum Adapter

React Native

GitHub-förrådet för Queue-Fair-adaptern för virtuellt väntrum för React Native-appar för Android, iOS, MacOS och Windows.

Meddelanden om köer

Queue-Fair-adaptern gör det enkelt att skicka push-notiser till användare som inte använder din app eller kö när det är deras tur. Användarens plats i kön lagras automatiskt och permanent av adaptern i din app. Om användaren navigerar bort från din app talar din app om för din Push Notification-server att ett meddelande ska skickas och skickar den lagrade informationen om köpositionen som en del av meddelandet till din Push Notification-server.

Det är samma teknik som vi använder för vår konsumentapp WeQ4U, som har laddats ner cirka 2 miljoner gånger bara i Storbritannien.

Din Push Notification-server konsulterar Queue-Fair Status API regelbundet för att fråga efter den köposition som för närvarande betjänas. När detta är större än en viss användares köposition är det dags att skicka meddelandet till den användaren. Om användaren återvänder till kön eller passerar innan ett push-notismeddelande har skickats, meddelar adaptern din app och din app meddelar din push-notiseringsserver att meddelandet inte längre behövs.

Såvitt vi vet är vi den enda leverantören av virtuella väntrum som stöder den här funktionen.

Videoresurser

Här är en video med Native App Adapter i aktion som visar att användarens plats sparas även om appen stoppas helt och hållet, och som även visar de Adapterkrokar som din app använder för att skicka push-notiser.

Ytterligare resurser

Våra Native App Adapters beskrivs i den tekniska guiden. Den tekniska guiden finns tillgänglig i Queue-Fair Portal > Hjälp, eller så kan du begära ett exemplar från oss. Du kan också hitta mer information om varje adapter som är specifik för iOS och Android i README.md i varje GitHub-förvaringsutrymme.


Adaptrar för e-handel

Queue-Fair kan enkelt läggas till i alla e-handelssystem med hjälp av den klientsidiga JavaScript-adapter som beskrivs ovan.

Vi erbjuder också Adapterkod för att fungera på serversidan med många populära e-handelsservrar.

GitHub-arkiv

Magento Plugin

Magento

GitHub-förrådet för Queue-Fair Virtual Waiting Room Adapter för Magento.

WooCommerce/PHP virtuellt väntrum Adapter

WooCommerce

GitHub-förrådet för Queue-Fair Virtual Waiting Room Adapter för WooCommerce i PHP.

PrestaShop/PHP virtuellt väntrum Adapter

PrestaShop

GitHub-förrådet för Queue-Fair Virtual Waiting Room Adapter för PrestaShop i PHP.

Ytterligare resurser

Våra adaptrar beskrivs i den tekniska guiden. Den tekniska handboken finns i Queue-Fair Portal > Hjälp-sektionen, eller så kan du begära ett exemplar från oss.

Vi har också kompletterande guider för de flesta e-handelsplattformar - fråga bara efter den du vill ha.


Hybridsäkerhet

Du kan enkelt kombinera flexibiliteten hos klientsidans JavaScript-adapter med det extra säkerhetslager som vår serverkod erbjuder.

Queue-Fair signerar varje besökare som vi passerar med ett digitalt fingeravtryck som är unikt för den besökaren. Signaturen innehåller också en kod som är specifik för besökarens webbläsare, vilket är unikt i branschen, för att förhindra att åtkomsttoken delas.

Din webbserver kan validera signaturen med hjälp av en hemlighet som endast du och vi känner till - inte dina besökare - för att säkerställa att varje besökare har passerat Queue-Fair-servrarna på ett rättvist sätt.

Du kan alltså använda JavaScript-adaptern på klientsidan för att skicka och ta emot besökare till och från kön och kontrollera om de har manipulerats innan de beställer med minimal kod på serversidan och undvika att införa ett beroende av vårt system.

I våra GitHub-repositories finns exempelkoder i alla större webbprogrammeringsspråk.

GitHub-arkiv

PHP

PHP

GitHub-förrådet för Queue-Fair Virtual Waiting Room Server-Side Adapter i PHP.

Java

Java

GitHub-förrådet för Queue-Fair Virtual Waiting Room Server-Side Adapter för Java, inklusive JBoss och Tomcat.

Ruby

Ruby

GitHub-förrådet för Queue-Fair Virtual Waiting Room Server-Side Adapter i Ruby och (eventuellt) Rails.

Python

Python

GitHub-arkiv för Queue-Fair Virtual Waiting Room Server-Side Adapter i Python och (eventuellt) Django.

.NET

.NET

GitHub-förrådet för Queue-Fair Virtual Waiting Room Server-Side Adapter för .NET, ASP och C#.

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

Node.js & JavaScript

GitHub-arkiv för Queue-Fair Virtual Waiting Room Server-Side Adapter för Node.js och (eventuellt) Express.

Ytterligare resurser

Den hybrida säkerhetsmodellen beskrivs utförligt i den tekniska guiden. Den tekniska guiden finns tillgänglig i Queue-Fair-portalen > avsnittet Hjälp, eller så kan du begära ett exemplar från oss.


Licens

Vår publicerade kod som finns tillgänglig på GitHub Queue-Fair Repository är licensierad enligt MIT-licensen, som är bland de mest tillåtande licenserna för öppen källkod.


Vill du veta hur Queue-Fair fungerar?