Zdroje pre vývojárov



Pridanie Queue-Fair

Virtuálna čakáreň Queue-Fair sa dá jednoducho pridať do rôznych webových platforiem a aplikácií v priebehu niekoľkých minút. Stačí použiť jeden z našich adaptérov. Viac informácií o najlepšom spôsobe integrácie Queue-Fair s existujúcim systémom nájdete v Technickej príručke alebo v časti Portál Queue-Fair > Pomocník. Ak hľadáte informácie o tom, ako zabrániť botom alebo ľuďom v zadávaní viacnásobných príkazov alebo ako chrániť predaj NFT pred nadmernými poplatkami za plyn, môžete si prečítať tento prehľad alebo získať podrobné informácie v časti Sprievodca zabezpečením na portáli.

Adaptér na strane klienta

V prípade webových stránok je najjednoduchším spôsobom integrácie s Queue-Fair pridanie značky JavaScript Client-Side Queue-Fair Adapter na vaše stránky. Adaptér môžete bezpečne pridať na všetky stránky na svojom webe a pomocou aktivačných pravidiel na portáli Queue-Fair určiť, ktoré stránky môžu vyhadzovať fronty.

Keďže sa spúšťa v prehliadačoch návštevníkov, adaptér na strane klienta môžu technicky zdatní návštevníci vypnúť, ale je veľmi účinný pri prevencii preťaženia, pretože len veľmi malá časť ľudí sa pokúsi preskočiť frontu manipuláciou s JavaScriptom. Väčšina našich zákazníkov používa adaptér Client-Side Adapter, pretože je účinný pri prevencii pádu webu, jednoducho sa inštaluje a nezavádza žiadnu závislosť medzi naším a vaším systémom.

Vrstvu zabezpečenia môžete pridať nahradením značky JavaScript adaptérom na strane servera alebo môžete skombinovať flexibilitu adaptéra JavaScript s hybridným modelom zabezpečenia opísaným na tejto stránke; obe metódy sú potom bezpečné.

Jeden riadok kódu

Ak chcete pridať adaptér na strane klienta na svoj web, stačí pridať nasledujúci riadok kódu do <head> sekcie vašich stránok:

Pridajte našu virtuálnu čakáreň na svoje stránky pomocou tohto jediného riadku kódu a zabráňte pádom webových stránok

Niektorí zákazníci pridávajú slovo defer k značke, čo spôsobí, že skript Adapter sa stiahne súbežne s analyzovaním stránky a spustí sa v prehliadači návštevníka až po dokončení analyzovania stránky (zvyčajne teda po dokončení všetkých ostatných skriptov na stránke).

Pridanie slova odložiť môže v niektorých prípadoch zlepšiť čas do prvého vymaľovania o malý zlomok sekundy, ale ak sa rozhodnete pre tento krok, bude to znamenať, že všetci návštevníci, ktorí by mali byť zaradení do frontu, uvidia vašu chránenú stránku o zlomok sekundy dlhšie, než budú odoslaní do frontu.

Správca značiek Google

Poskytujeme aj adaptér JavaScript Tag prostredníctvom služby Google Tag Manager. Vyhľadajte Queue-Fair v galérii šablón komunity v časti Pridať značku. Upozorňujeme, že niektoré blokovače reklám bránia stiahnutiu hlavného súboru gtm.js od spoločnosti Google, čo blokuje všetky operácie aplikácie Google Tag Manager vrátane spustenia adaptéra pre týchto návštevníkov.Náš tag Virtuálna čakáreň pre Google Tag Manager

Úložiská GitHub

Správca značiek Google

Správca značiek Google

Úložisko GitHub pre virtuálnu čakáreň Queue-Fair Značka Google Tag Manager na strane klienta.

Dynamické stránky frontu

Akékoľvek údaje, ktoré chcete, môžete odovzdať z vášho webu na naše servery a na stránky fronty, ktoré vidia vaši návštevníci, pomocou atribútu data-queue-fair-extra, ktorý je k dispozícii v značke JavaScript na strane klienta a v implementácii nástroja Google Tag Manager. Ak chcete na svojom účte povoliť dynamické stránky frontu, obráťte sa na podporu.

Pomocou tejto funkcie môžete priebežne prispôsobovať stránky frontu. Queue-Fair môžete použiť aj na odovzdanie údajov, ktoré nám posielate spolu s návštevníkmi, späť na vašu stránku, keď prechádzajú frontom, čím získate ďalšiu úroveň zabezpečenia.

Poskytujeme aj rozhranie API pre dynamické stránky fronty, ktoré využíva dodatočné údaje na prispôsobenie akéhokoľvek aspektu stránky fronty, takže môžete vytvoriť jednu frontu pre celý web a automaticky ju prispôsobiť pre rôzne udalosti alebo produkty na vašom webe bez toho, aby ste museli vykonať akékoľvek zmeny na svojich stránkach fronty na portáli Queue-Fair.



Shopify, Wordpress a WooCommerce

Ak používate stránku založenú na systéme Wordpress, ako je napríklad nákupný košík WooCommerce, môžete jednoducho pridať značku Client-Side JavasScript Adapter pomocou pluginu Wordpress Insert Headers & Footers bez toho, aby ste museli upravovať akékoľvek témy alebo sa dotýkať kódu Wordpress.

Stačí si stiahnuť plugin Insert Headers & Footers, rozbaliť ho do priečinka /wp-content/plugins/, aktivovať plugin v ponuke Plugins, otvoriť plugin v ponuke Settings, pridať značku do Scripts in Header, ako je znázornené, stlačiť Save v dolnej časti stránky a je hotovo!

Shopify je rovnako jednoduché - tu sú pokyny na pridanie Queue-Fair Client-Side JavaScript Adapter do vášho obchodu Shopify.

Prístrojový panel portálu Queue-Fair

Adaptér na strane klienta Ďalšie zdroje

Adaptér na strane klienta je podrobne opísaný v technickej príručke. Technická príručka je k dispozícii na portáli Queue-Fair > v časti Pomocník alebo si môžete vyžiadať jej kópiu od nás.


Adaptéry na strane servera

Zatiaľ čo adaptér na strane klienta beží v jazyku JavaScript v prehliadačoch návštevníkov, adaptéry na strane servera Queue-Fair bežia na vašom webovom serveri.

Adaptéry webového servera

To znamená, že váš webový server môže využívať ďalšie bezpečnostné funkcie na odmietnutie prístupu osobám, ktoré neboli zaradené do fronty. Znamená to tiež, že váš webový server sa vyhne záťaži pri generovaní a zobrazovaní stránok obsahujúcich skript Adapter.

Pridanie knižníc Queue-Fair Server-Side Adapter trvá len niekoľko minút s minimálnymi zmenami kódu na aktiváciu a spustenie Adaptéra.

Väčšina našich zákazníkov začína s adaptérom JavaScript na strane klienta a na adaptér na strane servera prechádza len v prípade špecifickej obchodnej potreby.

Jednoduchý a bezpečný režim

Adaptéry na strane servera Queue-Fair môžu pracovať v jednoduchom alebo bezpečnom režime.

V jednoduchom režime sú všetci návštevníci odoslaní na servery Queue-Fair, aby sa spočítali bez ohľadu na to, či sa vytvorila fronta. Ak sa nevytvorí fronta, sú vrátení na váš webový server ihneď, bez zobrazenia stránky s frontom - ale s podpisom, ktorý váš webový server potrebuje na zabezpečenie toho, aby k vašim chráneným zdrojom mali prístup len ľudia, ktorí prešli frontom.

V bezpečnom režime sa návštevníci odosielajú na servery Queue-Fair len vtedy, keď je vytvorená fronta. Váš webový server sa pri tomto rozhodovaní obracia priamo na naše servery Queue. Návštevníci sú stále bezpečne digitálne podpísaní bez ohľadu na to, či sa zobrazuje stránka fronty alebo nie.

Bezpečný režim sa odporúča pre každodenné fronty. Jednoduchý režim je vhodný pre časovo obmedzené udalosti, keď očakávate tisíce ľudí, pretože eliminuje oneskorenie spôsobené kontrolným volaním z vášho webového servera na naše servery fronty, čo znamená, že môžete posielať ľudí do fronty efektívnejšie.

Úložiská GitHub

Adaptér virtuálnej čakárne PHP') ?>

PHP

Úložisko GitHub pre adaptér virtuálnej čakárne Queue-Fair na strane servera v jazyku PHP.

Adaptér virtuálnej čakárne Java

Java

Repozitár GitHub pre adaptér Queue-Fair Virtual Waiting Room na strane servera pre Javu vrátane JBoss a Tomcat.

Adaptér virtuálnej čakárne Ruby

Ruby

Úložisko GitHub pre adaptér virtuálnej čakárne Queue-Fair na strane servera v jazykoch Ruby a (voliteľne) Rails.

Adaptér virtuálnej čakárne Python

Python

Repozitár GitHub pre adaptér virtuálnej čakárne Queue-Fair na strane servera v jazyku Python a (voliteľne) Django.

Adaptér virtuálnej čakárne dotNet

.NET

Úložisko GitHub pre adaptér Queue-Fair Virtual Waiting Room na strane servera pre .NET, ASP a C#.

Node.js & JavaScript Adaptér virtuálnej čakárne

Node.js & JavaScript

Repozitár GitHub pre adaptér virtuálnej čakárne Queue-Fair na strane servera pre Node.js a (voliteľne) Express.



Dynamické stránky frontu

Rovnako ako v prípade adaptéra na strane klienta, akékoľvek údaje, ktoré si želáte, môžete odovzdať z vášho webového servera na naše servery a na stránky fronty, ktoré vidia vaši návštevníci, odovzdaním týchto informácií vo volaní adaptéra na strane servera. To uľahčuje dynamické prispôsobenie stránky frontu alebo iné prispôsobenie za chodu rovnakým spôsobom - všetky funkcie adaptéra na strane klienta sú plne podporované. Ak chcete na svojom účte povoliť funkciu Dynamic Queue Pages, obráťte sa na podporu.

Adaptér na strane servera Ďalšie zdroje

Naše adaptéry na strane servera sú podrobne opísané v technickej príručke. Technická príručka je k dispozícii na portáli Queue-Fair > v časti Pomocník alebo si môžete vyžiadať jej kópiu od nás. Ďalšie informácie o každom z adaptérov nájdete aj v súbore README.md každého repozitára GitHub.


Sieťové adaptéry

Sieťové adaptéry Queue-Fair bežia v rámci vašej siete CDN alebo poskytovateľa cloudových služieb, a nie v prehliadačoch návštevníkov alebo na vašom pôvodnom serveri.

Adaptéry poskytovateľa Lambda a CDN

Poskytuje rovnaké zabezpečenie ako adaptér na strane servera a rovnakú ochranu proti zaťaženiu ako priame prepojenie.

Pridanie knižníc sieťového adaptéra Queue-Fair Network-Edge Adapter trvá len niekoľko minút s minimálnymi zmenami kódu u poskytovateľa cloudu na aktiváciu a spustenie adaptéra, ktorý je zvyčajne nasadený ako funkcia Lambda alebo Edge Worker.

Jednoduchý a bezpečný režim

Rovnako ako naše adaptéry na strane servera môžu naše sieťové adaptéry pracovať v jednoduchom alebo bezpečnom režime.

Dostupné adaptéry

Adaptér virtuálnej čakárne Amazon AWS CloudFront Network-Edge') ?>

CloudFront

Adaptér virtuálnej čakárne Amazon AWS CloudFront Network-Edge.

Adaptér virtuálnej čakárne Cloudflare Network-Edge

Cloudflare

Adaptér virtuálnej čakárne Cloudflare Network-Edge

Adaptér virtuálnej čakárne Fastly Network-Edge

Fastly

Adaptér virtuálnej čakárne Fastly Network-Edge..

Adaptér virtuálnej čakárne Akamai Network-Edge

Akamai

Adaptér virtuálnej čakárne Akamai Network-Edge.



Dynamické stránky frontu

Rovnako ako v prípade adaptéra na strane klienta, akékoľvek údaje, ktoré si želáte, môžete odovzdať z vášho webu na naše servery a na stránky frontu, ktoré vidia vaši návštevníci, odovzdaním týchto informácií vo volaní adaptéra. To uľahčuje dynamické prispôsobenie stránky frontu alebo iné prispôsobenie za chodu rovnakým spôsobom - všetky funkcie adaptéra na strane klienta sú plne podporované. Ak chcete na svojom účte povoliť funkciu Dynamické stránky frontu, obráťte sa na podporu.

Sieťový adaptér Ďalšie zdroje

Naše sieťové adaptéry sú podrobne opísané v technickej príručke. Technická príručka je k dispozícii na portáli Queue-Fair > v časti Pomocník alebo si môžete vyžiadať jej kópiu od nás. Ďalšie informácie o každom z adaptérov nájdete aj v súbore README.md každého úložiska GitHub.


Rozhrania API REST

Queue-Fair poskytuje vývojárom prístup k šiestim modulom REST API. Na používanie rozhrania API budete potrebovať účet Queue-Fair. Ak chcete povoliť prístup k API pre svoje konto, obráťte sa na podporu Queue-Fair. Naše moduly REST API sú v súlade so štandardmi OpenAPI, RFC 7807 a RFC 3339.

Náš balík modulov API je komplexný - všetko, čo môžete robiť na portáli, môžete robiť aj pomocou API, okrem správy používateľov portálu, ktorá je vylúčená z dôvodu ochrany osobných údajov.

Každý modul API je plne zdokumentovaný na stránke api.queue-fair.net, kde nájdete aj rozhranie Swagger na jednoduché používanie a testovanie. Z dôvodu bezpečnosti sú všetky volania API chránené bezpečným šifrovaním TLS a vyžadujú si kľúč API, ktorý je špecifický pre váš účet.

Moduly API

Rozhranie API pre podávanie správ

Pre reporty v reálnom čase, historické reporty a súhrnné štatistiky frontu.

Rozhranie API pre správu frontu

Na programové vytváranie a úpravu front v reálnom čase.

Rozhranie API pre správu účtov

Na zobrazenie a aktualizáciu nastavení celého konta.

Rozhranie API pre správu aktív

Na správu aktív používaných na stránkach fronty obsluhovaných službou Google CDN.

Rozhranie API prezentácie

Na zmenu akéhokoľvek aspektu HTML stránok frontu a na aktualizáciu a vytváranie variantov za chodu.

Aktivačné rozhranie API

Na konfiguráciu aktivačných pravidiel, ktoré určujú, ktoré stránky na vašom webe môžu spustiť frontu a ktorá stránka sa zobrazí.



Dynamické stránky frontu

Svoje stránky fronty môžete upravovať aj za behu bez toho, aby ste museli aktualizovať databázu pomocou rozhrania API portálu alebo prezentácie - pre ďalšie podrobnosti a povolenie dynamických stránok fronty vo svojom konte kontaktujte podporu.

REST API Ďalšie zdroje

V súlade s požiadavkami RFC 7807 nájdete dokumentáciu o chybových hláseniach, ktoré môžu byť vrátené našimi modulmi REST API, na adrese queue-fair.com/api-error


Natívne aplikácie

Queue-Fair vyzerá skvele v mobilných prehliadačoch, ako aj na stolových počítačoch a notebookoch.

Queue-Fair môžete používať aj priamo vo svojich natívnych aplikáciách pre iOS a Android a tiež v aplikáciách React Native v systémoch iOS, Android, Windows a MacOS na ochranu činností alebo operácií náročných na zdroje.

Adaptéry aplikácií Queue-Fair využívajú webového klienta na zobrazenie vlastných zobrazení fronty pre vašich používateľov, keď sú vaše služby príliš obsadené, s flexibilitou a jednoduchosťou používania Queue-Fair Portal.

Používateľov môžete zaradiť do rovnakého frontu ako návštevníkov webovej lokality alebo môžete vytvoriť samostatný front pre používateľov aplikácie - je to na vás.

Rovnako ako naše webové fronty sa miesto každého používateľa automaticky uloží, aj keď odíde z aplikácie.

Úložiská GitHub

Adaptér virtuálnej čakárne pre iOS, MacOS a Apple

iOS & MacOS

Úložisko GitHub pre adaptér virtuálnej čakárne Queue-Fair pre iOS a MacOS.

Adaptér virtuálnej čakárne pre Android

Android

Repozitár GitHub pre adaptér virtuálnej čakárne Queue-Fair pre Android.

Adaptér virtuálnej čakárne aplikácie React Native

React Native

Repozitár GitHub pre adaptér virtuálnej čakárne Queue-Fair pre aplikácie React Native pre Android, iOS, MacOS a Windows.

Upozornenia na fronty

Adaptér Queue-Fair uľahčuje odosielanie oznámení Push používateľom, ktorí nepoužívajú vašu aplikáciu alebo frontu, keď na nich príde rad. Miesto používateľa vo fronte je automaticky trvalo uložené adaptérom vo vašej aplikácii. Ak používateľ odíde z vašej aplikácie, vaša aplikácia oznámi vášmu serveru Push Notification, že sa má odoslať oznámenie, pričom uloženú informáciu o pozícii vo fronte odošle ako súčasť tejto správy vášmu serveru Push Notification.

Ide o rovnakú technológiu, akú používame v našej spotrebiteľskej aplikácii WeQ4U, ktorú si len v Spojenom kráľovstve stiahlo približne 2 milióny používateľov.

Váš server Push Notification pravidelne konzultuje rozhranie Queue-Fair Status API, aby zistil aktuálne obslúženú pozíciu vo fronte. Keď je táto hodnota väčšia ako pozícia vo fronte konkrétneho používateľa, je čas poslať tomuto používateľovi oznámenie. Ak sa používateľ vráti do frontu alebo je Passed pred odoslaním oznámenia Push, adaptér to oznámi vašej aplikácii a vaša aplikácia oznámi serveru Push Notification, že oznámenie už nie je potrebné.

Podľa našich informácií sme jediným poskytovateľom virtuálnej čakárne, ktorý túto funkciu podporuje.

Video zdroje

Tu je video s natívnym adaptérom aplikácie v akcii, ktoré ukazuje, že miesto používateľa je uložené aj v prípade, že je aplikácia úplne zastavená, a tiež ukazuje háčiky adaptéra, ktoré vaša aplikácia používa na odosielanie oznámení Push.

Ďalšie zdroje

Naše natívne adaptéry aplikácií sú opísané v technickej príručke. Technická príručka je k dispozícii na portáli Queue-Fair > v časti Pomocník alebo si môžete vyžiadať jej kópiu od nás. Ďalšie informácie o každom z adaptérov, ktoré sú špecifické pre systémy iOS a Android, nájdete aj v súbore README.md každého repozitára GitHub.


Adaptéry ECommerce

Queue-Fair možno jednoducho pridať do akéhokoľvek systému elektronického obchodovania pomocou vyššie opísaného adaptéra JavaScript na strane klienta.

Ponúkame aj kód adaptéra na prácu na strane servera s mnohými populárnymi servermi elektronického obchodu.

Úložiská GitHub

Magento Plugin

Magento

Repozitár GitHub pre adaptér virtuálnej čakárne Queue-Fair pre Magento.

Adaptér virtuálnej čakárne WooCommerce/PHP

WooCommerce

Repozitár GitHub pre adaptér virtuálnej čakárne Queue-Fair pre WooCommerce v PHP.

Adaptér virtuálnej čakárne PrestaShop/PHP

PrestaShop

Repozitár GitHub pre adaptér virtuálnej čakárne Queue-Fair pre PrestaShop v PHP.

Ďalšie zdroje

Naše adaptéry sú opísané v technickej príručke. Technická príručka je k dispozícii na portáli Queue-Fair > v časti Pomocník alebo si môžete vyžiadať jej kópiu od nás.

Máme k dispozícii aj doplnkové príručky pre väčšinu platforiem elektronického obchodu - stačí požiadať o tú, ktorú chcete.


Hybridné zabezpečenie

Flexibilitu adaptéra JavaScript na strane klienta môžete ľahko kombinovať s dodatočnou vrstvou zabezpečenia, ktorú poskytuje náš kód na strane servera.

Spoločnosť Queue-Fair označí každého návštevníka, ktorého prejdeme, digitálnym odtlačkom prsta, ktorý je pre daného návštevníka jedinečný. Jedinečne v tomto odvetví podpis obsahuje aj kód špecifický pre prehliadač návštevníka, aby sa zabránilo zdieľaniu prístupových tokenov.

Váš webový server môže overiť podpis pomocou tajomstva, ktoré poznáte len vy a my - nie vaši návštevníci - aby sa zabezpečilo, že každý návštevník prešiel servermi Queue-Fair spravodlivo.

Takže môžete použiť adaptér JavaScript na strane klienta na odosielanie a prijímanie návštevníkov do a z fronty a kontrolovať, či nedošlo k manipulácii pred ich objednaním s minimálnym kódom na strane servera, a vyhnúť sa zavedeniu závislosti na našom systéme.

V našich repozitároch GitHub sú uvedené príklady kódu vo všetkých hlavných webových programovacích jazykoch.

Úložiská GitHub

PHP

PHP

Úložisko GitHub pre adaptér virtuálnej čakárne Queue-Fair na strane servera v jazyku PHP.

Java

Java

Repozitár GitHub pre adaptér Queue-Fair Virtual Waiting Room na strane servera pre Javu vrátane JBoss a Tomcat.

Ruby

Ruby

Repozitár GitHub pre adaptér virtuálnej čakárne Queue-Fair na strane servera v jazykoch Ruby a (voliteľne) Rails.

Python

Python

Repozitár GitHub pre adaptér virtuálnej čakárne Queue-Fair na strane servera v jazyku Python a (voliteľne) Django.

.NET

.NET

Úložisko GitHub pre adaptér Queue-Fair Virtual Waiting Room na strane servera pre .NET, ASP a C#.

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

Node.js & JavaScript

Repozitár GitHub pre adaptér virtuálnej čakárne Queue-Fair na strane servera pre Node.js a (voliteľne) Express.

Ďalšie zdroje

Hybridný bezpečnostný model je podrobne opísaný v Technickej príručke. Technická príručka je k dispozícii na portáli Queue-Fair > v časti Pomocník alebo si môžete vyžiadať jej kópiu od nás.


Licencia

Náš zverejnený kód dostupný v repozitári GitHub Queue-Fair je licencovaný pod licenciou MIT, ktorá patrí k najprísnejším licenciám otvoreného softvéru.


Chcete vedieť, ako funguje Queue-Fair?