Zdroje pro vývojáře



Přidání Queue-Fair

Virtuální čekárnu Queue-Fair lze snadno přidat do nejrůznějších webových platforem a aplikací během několika minut. Stačí použít jeden z našich adaptérů. Další informace o nejlepším způsobu integrace Queue-Fair s vaším stávajícím systémem najdete v Technické příručce nebo v části Portál Queue-Fair > Nápověda. Pokud hledáte informace o tom, jak zabránit botům nebo lidem v provádění vícenásobných příkazů nebo jak chránit své prodeje NFT před nadměrnými poplatky za plyn, můžete si přečíst tento přehled nebo získat podrobné informace v části Průvodce zabezpečením na portálu.

Adaptér na straně klienta

Pro webové stránky je nejjednodušším způsobem integrace s Queue-Fair přidání značky JavaScript adaptéru Queue-Fair na straně klienta na vaše stránky. Adaptér můžete bez obav přidat na všechny stránky svého webu a pomocí aktivačních pravidel na portálu Queue-Fair určit, které stránky mohou vyhodit frontu.

Protože je spuštěn v prohlížečích návštěvníků, mohou technicky zdatní návštěvníci adaptér na straně klienta vypnout, ale je velmi účinný při prevenci přetížení, protože jen velmi malá část lidí se pokusí frontu přeskočit manipulací s JavaScriptem. Většina našich zákazníků používá Client-Side Adapter, protože je účinný při prevenci pádu webu, snadno se instaluje a nezavádí žádnou závislost mezi naším a vaším systémem.

Vrstvu zabezpečení můžete přidat nahrazením značky JavaScript adaptérem na straně serveru nebo kombinací flexibility adaptéru JavaScript s hybridním modelem zabezpečení popsaným na této stránce; obě metody jsou pak bezpečné.

Jeden řádek kódu

Chcete-li na svůj web přidat adaptér na straně klienta, stačí přidat následující řádek kódu do pole <head> sekce vašich stránek:

Přidejte naši virtuální čekárnu na své stránky pomocí tohoto jediného řádku kódu a předejděte pádům webových stránek.

Někteří zákazníci přidávají slovo defer ke značce, což způsobí, že se skript adaptéru stáhne souběžně s analyzováním stránky a také to, že se skript začne v prohlížeči návštěvníka provádět až po dokončení analyzování stránky (typicky tedy po dokončení ostatních skriptů na stránce).

Přidání slova defer může v některých případech zlepšit čas do prvního vybarvení o malý zlomek sekundy, ale pokud se pro to rozhodnete, bude to znamenat, že návštěvníci, kteří by měli být zařazeni do fronty, uvidí vaši chráněnou stránku o zlomek sekundy déle, než budou odesláni do fronty.

Správce značek Google

Prostřednictvím Google Tag Manageru poskytujeme také adaptér JavaScript Tag. Vyhledejte Queue-Fair v galerii šablon komunity v části Přidat značku. Upozorňujeme, že některé blokátory reklam brání stažení hlavního souboru gtm.js od společnosti Google, což blokuje všechny operace nástroje Google Tag Manager, včetně spuštění adaptéru pro tyto návštěvníky.Náš tag Virtuální čekárna pro Google Tag Manager

Úložiště GitHub

Správce značek Google

Správce značek Google

Úložiště GitHub pro značku Queue-Fair Virtual Waiting Room Google Tag Manager Client-Side Adapter Tag.

Dynamické stránky fronty

Pomocí atributu data-queue-fair-extra, který je k dispozici v klientském tagu JavaScript a v implementaci Google Tag Manager, lze z vašeho webu předat na naše servery a na stránky fronty, které se návštěvníkům zobrazí, jakákoli data, která si přejete. Pokud chcete na svém účtu povolit dynamické stránky fronty, kontaktujte prosím podporu.

Tuto funkci můžete použít k průběžnému přizpůsobení stránek fronty. Pomocí Queue-Fair můžete také předávat data, která nám posíláte s návštěvníky, zpět na vaše stránky, když procházejí frontou, a získat tak další úroveň zabezpečení.

Poskytujeme také rozhraní API pro dynamické stránky fronty, které využívá dodatečné údaje k přizpůsobení jakéhokoli aspektu stránky fronty, takže můžete vytvořit jednu frontu pro celý web a automaticky ji přizpůsobovat různým událostem nebo produktům na webu, aniž byste museli provádět jakékoli změny na svých stránkách fronty na portálu Queue-Fair.



Shopify, Wordpress a WooCommerce

Pokud používáte stránky založené na systému Wordpress, jako je například nákupní košík WooCommerce, můžete snadno přidat značku Client-Side JavasScript Adapter pomocí pluginu Wordpress Insert Headers & Footers, aniž byste museli upravovat některý z motivů nebo zasahovat do kódu Wordpress.

Stačí stáhnout plugin Insert Headers & Footers, rozbalit jej do složky /wp-content/plugins/, aktivovat plugin v nabídce Plugins, otevřít plugin v nabídce Settings, přidat značku do Scripts in Header (Skripty v záhlaví ), jak je uvedeno na obrázku, stisknout Save (Uložit) v dolní části stránky a je hotovo!

Shopify je stejně snadné - zde jsou pokyny pro přidání Queue-Fair Client-Side JavaScript Adapter do vašeho obchodu Shopify.

Přístrojový panel portálu Queue-Fair

Adaptér na straně klienta Další zdroje

Adaptér na straně klienta je podrobně popsán v Technické příručce. Technická příručka je k dispozici na portálu Queue-Fair > v části Nápověda nebo si můžete vyžádat její kopii u nás.


Adaptéry na straně serveru

Zatímco adaptér na straně klienta běží v prohlížeči návštěvníků v jazyce JavaScript, adaptéry Queue-Fair na straně serveru běží na vašem webovém serveru.

Adaptéry webového serveru

To znamená, že váš webový server může využívat další funkce zabezpečení a odepřít přístup osobám, které nebyly zařazeny do fronty. To také znamená, že se váš webový server vyhne zátěži spojené s generováním a zobrazováním stránek obsahujících skript Adapter.

Přidání knihoven Queue-Fair Server-Side Adapter zabere jen několik minut s minimálními změnami kódu pro aktivaci a spuštění Adaptéru.

Většina našich zákazníků začíná s adaptérem JavaScript na straně klienta a přechází na adaptér na straně serveru pouze v případě specifické obchodní potřeby.

Jednoduchý a bezpečný režim

Adaptéry na straně serveru Queue-Fair mohou pracovat v jednoduchém nebo bezpečném režimu.

V jednoduchém režimu jsou všichni návštěvníci odesláni na servery Queue-Fair, kde se započítají, bez ohledu na to, zda se vytvořila fronta. Pokud fronta neexistuje, jsou vráceni na váš webový server rovnou, aniž by se jim zobrazila stránka s frontou - ale s podpisem, který váš webový server potřebuje, aby zajistil, že k vašim chráněným prostředkům budou mít přístup pouze lidé, kteří prošli frontou.

V nouzovém režimu jsou návštěvníci odesíláni na servery Queue-Fair pouze v případě, že je k dispozici fronta. Váš webový server konzultuje toto určení přímo s našimi servery fronty. Návštěvníci jsou stále bezpečně digitálně podepisováni bez ohledu na to, zda se zobrazuje stránka fronty.

Nouzový režim se doporučuje pro každodenní fronty. Jednoduchý režim je vhodný pro časově omezené události, kdy očekáváte tisíce lidí, protože eliminuje zpoždění způsobené kontrolním voláním z vašeho webového serveru na naše servery fronty, což znamená, že můžete posílat lidi do fronty efektivněji.

Úložiště GitHub

Adaptér virtuální čekárny PHP') ?>

PHP

Úložiště GitHub pro virtuální čekárnu Queue-Fair na straně serveru v jazyce PHP.

Adaptér virtuální čekárny Java

Java

Úložiště GitHub pro adaptér Queue-Fair Virtual Waiting Room na straně serveru pro Javu, včetně JBoss a Tomcat.

Adaptér virtuální čekárny Ruby

Ruby

Úložiště GitHub pro virtuální čekárnu Queue-Fair na straně serveru v jazyce Ruby a (volitelně) Rails.

Adaptér virtuální čekárny Python

Python

Úložiště GitHub pro adaptér virtuální čekárny Queue-Fair na straně serveru v jazyce Python a (volitelně) Django.

Adaptér virtuální čekárny dotNet

.NET

Úložiště GitHub pro virtuální čekárnu Queue-Fair na straně serveru pro .NET, ASP a C#.

Adaptér virtuální čekárny Node.js a JavaScript

Node.js & JavaScript

Úložiště GitHub pro adaptér virtuální čekárny Queue-Fair na straně serveru pro Node.js a (volitelně) Express.



Dynamické stránky fronty

Stejně jako v případě adaptéru na straně klienta lze předáním těchto informací ve volání adaptéru na straně serveru předat libovolná data z vašeho webového serveru našim serverům a stránkám fronty, které se zobrazují návštěvníkům. To usnadňuje dynamické přizpůsobení stránky fronty nebo jiné přizpůsobení za běhu stejným způsobem - všechny funkce adaptéru na straně klienta jsou plně podporovány. Pokud chcete na svém účtu povolit dynamické stránky fronty, kontaktujte prosím podporu.

Další zdroje adaptéru na straně serveru

Naše adaptéry na straně serveru jsou podrobně popsány v technické příručce. Technická příručka je k dispozici na portálu Queue-Fair > v části Nápověda nebo si můžete vyžádat její kopii u nás. Další informace o jednotlivých adaptérech najdete také v souboru README.md každého úložiště GitHub.


Adaptéry na okraji sítě

Adaptéry Queue-Fair Network-Edge běží v rámci CDN nebo poskytovatele cloudových služeb, nikoli v prohlížečích návštěvníků nebo na vašem původním serveru.

Adaptéry poskytovatele Lambda a CDN

To poskytuje stejné zabezpečení jako adaptér na straně serveru a stejnou ochranu proti zatížení jako přímé propojení.

Přidání knihoven síťového adaptéru Queue-Fair Network-Edge Adapter zabere jen několik minut s minimálními změnami kódu u poskytovatele cloudu, aby bylo možné adaptér aktivovat a spustit, což je obvykle nasazeno jako funkce Lambda nebo Edge Worker.

Jednoduchý a bezpečný režim

Stejně jako naše adaptéry na straně serveru mohou naše síťové adaptéry pracovat v jednoduchém nebo bezpečném režimu.

Dostupné adaptéry

Adaptér virtuální čekárny Amazon AWS CloudFront Network-Edge') ?>

CloudFront

Adaptér virtuální čekárny Amazon AWS CloudFront Network-Edge.

Adaptér virtuální čekárny Cloudflare Network-Edge

Cloudflare

Adaptér virtuální čekárny Cloudflare Network-Edge

Adaptér virtuální čekárny Fastly Network-Edge

Fastly

Adaptér virtuální čekárny Fastly Network-Edge..

Adaptér virtuální čekárny Akamai Network-Edge

Akamai

Adaptér virtuální čekárny Akamai Network-Edge.



Dynamické stránky fronty

Stejně jako u adaptéru na straně klienta lze předáním těchto informací ve volání adaptéru předat z vašeho webu na naše servery a na stránky fronty, které se zobrazují návštěvníkům, jakákoli data, která si přejete. To usnadňuje dynamické přizpůsobení stránky fronty nebo jiné přizpůsobení za běhu stejným způsobem - všechny funkce adaptéru na straně klienta jsou plně podporovány. Pokud chcete ve svém účtu povolit funkci Dynamické stránky fronty, kontaktujte prosím podporu.

Adaptér na okraji sítě Další zdroje

Naše síťové adaptéry jsou podrobně popsány v technické příručce. Technická příručka je k dispozici na portálu Queue-Fair > v části Nápověda nebo si můžete vyžádat její kopii u nás. Další informace o jednotlivých adaptérech najdete také v souboru README.md každého z repozitářů GitHub.


Rozhraní API REST

Queue-Fair poskytuje vývojářům přístup k šesti modulům REST API. K používání rozhraní API potřebujete účet Queue-Fair. Chcete-li povolit přístup k rozhraní API pro svůj účet, obraťte se na podporu Queue-Fair. Naše moduly REST API odpovídají standardům OpenAPI, RFC 7807 a RFC 3339.

Naše sada modulů API je komplexní - vše, co můžete dělat v portálu, můžete dělat také pomocí rozhraní API, s výjimkou správy uživatelů portálu, která je z důvodu ochrany osobních údajů vyloučena.

Každý modul API je plně zdokumentován na adrese api.queue-fair.net, kde najdete také rozhraní Swagger pro snadné používání a testování. Z důvodu bezpečnosti jsou všechna volání API chráněna bezpečným šifrováním TLS a vyžadují klíč API, který je specifický pro váš účet.

Moduly API

Rozhraní API pro podávání zpráv

Pro živé reporty v reálném čase, historické reporty a souhrnné statistiky front.

Rozhraní API pro správu front

K programovému vytváření a úpravám front v reálném čase.

Rozhraní API pro správu účtů

Slouží k prohlížení a aktualizaci nastavení celého účtu.

Rozhraní API pro správu aktiv

Pro správu prostředků používaných stránkami fronty obsluhovanými službou Google CDN.

Rozhraní API pro prezentace

Slouží ke změně jakéhokoli aspektu HTML stránek fronty a k aktualizaci a vytváření variant za běhu.

Aktivační rozhraní API

Pro konfiguraci aktivačních pravidel, která určují, které stránky na webu mohou spustit frontu a která stránka se zobrazí.



Dynamické stránky fronty

Stránky fronty můžete také upravovat za běhu, aniž byste museli aktualizovat databázi pomocí rozhraní API portálu nebo prezentace - pro další podrobnosti a povolení dynamických stránek fronty na svém účtu kontaktujte podporu.

Další zdroje rozhraní REST API

V souladu s požadavkem RFC 7807 najdete dokumentaci o chybových hlášeních, která mohou být vrácena našimi moduly REST API, na adrese queue-fair.com/api-error.


Nativní aplikace

Queue-Fair vypadá skvěle v mobilních prohlížečích i na stolních počítačích a noteboocích.

Queue-Fair můžete používat také přímo ve svých nativních aplikacích pro iOS a Android a také v aplikacích React Native pro iOS, Android, Windows a MacOS, abyste ochránili činnosti nebo operace náročné na zdroje.

Adaptéry aplikací Queue-Fair využívají webového klienta k zobrazení vlastního zobrazení fronty uživatelům, když jsou vaše služby příliš vytížené, s flexibilitou a snadným použitím Queue-Fair Portal.

Uživatele můžete zařadit do stejné fronty jako návštěvníky webu nebo pro uživatele aplikace vytvořit samostatnou frontu - záleží jen na vás.

Stejně jako naše webové fronty se místo každého uživatele automaticky uloží, i když z aplikace odejde.

Úložiště GitHub

Adaptér virtuální čekárny pro iOS, MacOS a Apple

iOS & MacOS

Úložiště GitHub pro adaptér virtuální čekárny Queue-Fair pro iOS a MacOS.

Adaptér virtuální čekárny pro systém Android

Android

Úložiště GitHub pro adaptér virtuální čekárny Queue-Fair pro Android.

Adaptér virtuální čekárny pro aplikace React Native

React Native

Úložiště GitHub pro adaptér virtuální čekárny Queue-Fair pro aplikace React Native pro Android, iOS, MacOS a Windows.

Oznámení fronty

Adaptér Queue-Fair usnadňuje odesílání oznámení Push uživatelům, kteří nepoužívají vaši aplikaci nebo frontu, když na ně přijde řada. Místo uživatele ve frontě je automaticky trvale uloženo adaptérem ve vaší aplikaci. Pokud uživatel odejde z vaší aplikace, vaše aplikace sdělí vašemu serveru Push Notification, že má být odesláno oznámení, a odešle uloženou informaci o pozici ve frontě jako součást této zprávy na váš server Push Notification.

Jedná se o stejnou technologii, kterou používáme pro naši spotřebitelskou aplikaci WeQ4U, kterou si jen ve Velké Británii stáhly přibližně 2 miliony uživatelů.

Váš server Push Notification pravidelně konzultuje rozhraní API Queue-Fair Status a dotazuje se na pozici ve frontě, která je aktuálně obsluhována. Pokud je tato hodnota větší než pozice ve frontě konkrétního uživatele, je čas odeslat tomuto uživateli oznámení. Pokud se uživatel vrátí do fronty nebo je Passed před odesláním oznámení Push, adaptér to oznámí vaší aplikaci a vaše aplikace sdělí serveru Push Notification, že oznámení již není potřeba.

Pokud je nám známo, jsme jediným poskytovatelem virtuální čekárny, který tuto funkci podporuje.

Video zdroje

Zde je video s adaptérem nativní aplikace v akci, které ukazuje, že místo uživatele je uloženo, i když je aplikace zcela zastavena, a také ukazuje háčky adaptéru, které aplikace používá k odesílání oznámení Push.

Další zdroje

Naše nativní adaptéry aplikací jsou popsány v technické příručce. Technická příručka je k dispozici na portálu Queue-Fair > v sekci Nápověda nebo si můžete vyžádat její kopii od nás. Další informace o každém z adaptérů, které jsou specifické pro systémy iOS a Android, najdete také v souboru README.md každého úložiště GitHub.


Adaptéry ECommerce

Queue-Fair lze snadno přidat do jakéhokoli systému elektronického obchodování pomocí výše popsaného adaptéru JavaScript na straně klienta.

Nabízíme také adaptéry pro práci na straně serveru s mnoha populárními servery pro elektronické obchodování.

Úložiště GitHub

Magento Plugin

Magento

Úložiště GitHub pro adaptér virtuální čekárny Queue-Fair pro Magento.

Adaptér virtuální čekárny WooCommerce/PHP

WooCommerce

Repozitář GitHub pro adaptér virtuální čekárny Queue-Fair pro WooCommerce v PHP.

Adaptér virtuální čekárny PrestaShop/PHP

PrestaShop

Repozitář GitHub pro adaptér virtuální čekárny Queue-Fair pro PrestaShop v PHP.

Další zdroje

Naše adaptéry jsou popsány v technické příručce. Technická příručka je k dispozici na portálu Queue-Fair > v sekci Nápověda nebo si můžete vyžádat její kopii u nás.

K dispozici máme také doplňkové průvodce pro většinu platforem elektronického obchodování - stačí požádat o ten, který chcete.


Hybridní zabezpečení

Můžete snadno kombinovat flexibilitu adaptéru JavaScript na straně klienta s dodatečnou vrstvou zabezpečení, kterou poskytuje náš kód na straně serveru.

Queue-Fair označí každého návštěvníka, kterého propustíme, digitálním otiskem prstu, který je pro daného návštěvníka jedinečný. Tento podpis, který je v tomto odvětví jedinečný, obsahuje také kód specifický pro prohlížeč návštěvníka, aby se zabránilo sdílení přístupových tokenů.

Váš webový server může ověřit podpis pomocí tajemství, které znáte pouze vy a my - nikoli vaši návštěvníci - a zajistit tak, že každý návštěvník prošel servery Queue-Fair spravedlivě.

Pomocí adaptéru JavaScript na straně klienta tak můžete odesílat a přijímat návštěvníky do fronty a z fronty a kontrolovat, zda nedošlo k manipulaci s objednávkou, s minimálním množstvím kódu na straně serveru a vyhnout se závislosti na našem systému.

V našich repozitářích GitHub jsou k dispozici příklady kódu ve všech hlavních webových programovacích jazycích.

Úložiště GitHub

PHP

PHP

Úložiště GitHub pro virtuální čekárnu Queue-Fair na straně serveru v jazyce PHP.

Java

Java

Úložiště GitHub pro adaptér Queue-Fair Virtual Waiting Room na straně serveru pro Javu, včetně JBoss a Tomcat.

Ruby

Ruby

Úložiště GitHub pro virtuální čekárnu Queue-Fair na straně serveru v jazyce Ruby a (volitelně) Rails.

Python

Python

Úložiště GitHub pro adaptér virtuální čekárny Queue-Fair na straně serveru v jazyce Python a (volitelně) Django.

.NET

.NET

Úložiště GitHub pro virtuální čekárnu Queue-Fair na straně serveru pro .NET, ASP a C#.

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

Node.js & JavaScript

Úložiště GitHub pro adaptér virtuální čekárny Queue-Fair na straně serveru pro Node.js a (volitelně) Express.

Další zdroje

Hybridní bezpečnostní model je podrobně popsán v Technické příručce. Technická příručka je k dispozici na portálu Queue-Fair > v části Nápověda nebo si můžete vyžádat její kopii u nás.


Licence

Náš zveřejněný kód dostupný v repozitáři Queue-Fair na GitHubu je licencován pod licencí MIT, která patří mezi nejpřísnější licence otevřeného softwaru.


Chcete vědět, jak Queue-Fair funguje?