Resurse pentru dezvoltatori



Adăugarea Queue-Fair

Sala de așteptare virtuală Queue-Fair este ușor de adăugat la o mare varietate de platforme web și aplicații în câteva minute. Trebuie doar să utilizați unul dintre adaptoarele noastre. Puteți găsi mai multe informații despre cea mai bună modalitate de a integra Queue-Fair cu sistemul dvs. existent în Ghidul tehnic sau în secțiunea Queue-Fair Portal > Ajutor.

Adaptorul din partea clientului

Pentru site-urile web, cel mai simplu mod de integrare cu Queue-Fair este de a adăuga tag-ul Client-Side Queue-Fair Adapter JavaScript în paginile dvs. Puteți adăuga în siguranță adaptorul la toate paginile de pe site-ul dvs. și puteți utiliza regulile de activare din portalul Queue-Fair pentru a determina ce pagini pot genera o coadă de așteptare.

Deoarece rulează în browserele vizitatorilor, adaptorul de partea clientului poate fi dezactivat de către vizitatorii cu abilități tehnice, dar este foarte eficient în prevenirea supraîncărcării, deoarece doar o minoritate foarte mică de persoane va încerca să sară peste coada de așteptare modificând JavaScript. Cei mai mulți dintre clienții noștri folosesc Client-Side Adapter pentru că este eficient în prevenirea blocării site-ului, este simplu de instalat și nu introduce nicio dependență între sistemul nostru și al dumneavoastră.

Puteți adăuga un nivel de securitate înlocuind eticheta JavaScript cu un adaptor de partea serverului sau puteți combina flexibilitatea adaptorului JavaScript cu modelul de securitate hibrid descris pe această pagină; ambele metode sunt sigure.

O singură linie de cod

Pentru a adăuga adaptorul pentru partea de client la site-ul dvs., adăugați următoarea linie de cod la fișierul <head> secțiune a paginilor dvs.:

Adăugați sala de așteptare virtuală la site-ul dvs. cu această singură linie de cod și preveniți blocarea site-ului web.

Unii clienți adaugă cuvântul defer la etichetă, ceea ce face ca scriptul Adapter să fie descărcat în paralel cu analiza paginii și, de asemenea, să înceapă executarea scriptului în browserul vizitatorului numai după ce pagina a terminat analiza (deci, de obicei, după ce orice alt script de pe pagina dvs. a fost terminat).

Adăugarea cuvântului " amânare" poate îmbunătăți Timpul până la prima pictură cu o mică fracțiune de secundă în unele cazuri, dar dacă alegeți să faceți acest lucru, înseamnă că orice vizitator care ar trebui să fie pus în coadă va vedea pagina dvs. protejată pentru o fracțiune de secundă mai mult înainte de a fi trimis în coadă.

Google Tag Manager

De asemenea, punem la dispoziție JavaScript Adapter Tag prin intermediul Google Tag Manager. Căutați Queue-Fair în Galeria de șabloane comunitare, la rubrica Adaugă etichetă. Vă rugăm să rețineți că unele blocante de reclame împiedică descărcarea masterului gtm.js de la Google, ceea ce blochează toate operațiunile Google Tag Manager, inclusiv rularea adaptorului pentru acei vizitatori.Eticheta noastră Virtual Waiting Room pentru Google Tag Manager

Depozite GitHub

Google Tag Manager

Google Tag Manager

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Google Tag Manager Client-Side Adapter Tag.

Pagini de coadă dinamice

Orice date pe care le doriți pot fi transmise de pe site-ul dvs. către serverele noastre și către paginile de coadă pe care le văd vizitatorii dvs., utilizând atributul data-queue-fair-extra, disponibil în eticheta JavaScript de pe partea clientului și în implementarea Google Tag Manager. Vă rugăm să contactați serviciul de asistență dacă doriți să activați Dynamic Queue Pages în contul dvs.

Puteți utiliza această funcție pentru a personaliza din mers paginile de coadă. De asemenea, puteți utiliza Queue-Fair pentru a transmite datele pe care ni le trimiteți împreună cu vizitatorii dvs. înapoi pe site-ul dvs. pe măsură ce aceștia sunt trecuți prin coadă, pentru un nivel suplimentar de securitate.

De asemenea, furnizăm un API dinamic pentru paginile de coadă care utilizează datele suplimentare pentru a personaliza orice aspect al unei pagini de coadă, astfel încât puteți crea o coadă pentru întregul site și o puteți personaliza automat pentru diferite evenimente sau produse de pe site, fără a fi nevoie să faceți modificări ale paginilor de coadă în portalul Queue-Fair

.



Wordpress & WooCommerce

Dacă folosiți un site bazat pe Wordpress, cum ar fi sistemul de coș de cumpărături WooCommerce, puteți adăuga cu ușurință tag-ul Client-Side JavasScript Adapter folosind Plugin-ul Wordpress Insert Headers & Footers, fără a fi nevoie să modificați vreunul dintre temele dvs. sau să atingeți vreun cod Wordpress.

Doar descărcați Plugin-ul Insert Headers & Footers, dezarhivați-l în folderul /wp-content/plugins/, activați plugin-ul în meniul Plugins, deschideți plugin-ul din meniul Settings, adăugați tag-ul la Scripts in Header așa cum se arată, apăsați Save în partea de jos a paginii și ați terminat!

Tabloul de bord al portalului Queue-Fair

Adaptor de partea clientului Resurse suplimentare

Adaptorul pentru partea client este descris pe larg în Ghidul tehnic. Ghidul tehnic este disponibil în portalul Queue-Fair > secțiunea Ajutor sau puteți solicita o copie de la noi.


Adaptoare de partea serverului

În timp ce adaptorul de partea clientului rulează în JavaScript în browserele vizitatorilor dumneavoastră, adaptoarele de partea serverului Queue-Fair rulează pe serverul dumneavoastră web.

Adaptoare pentru servere web

Acest lucru înseamnă că serverul dvs. web poate profita de caracteristicile de securitate suplimentare pentru a refuza accesul persoanelor care nu au fost puse în coadă. De asemenea, acest lucru înseamnă că serverul dvs. web evită sarcina generării și servirii paginilor care conțin scriptul Adapter.

Adăugarea bibliotecilor Queue-Fair Server-Side Adapter durează doar câteva minute, cu modificări minime ale codului pentru a activa și rula adaptorul.

Majoritatea clienților noștri încep cu adaptorul JavaScript pentru client și trec la adaptorul pentru server doar atunci când există o nevoie specifică de afaceri.

Mod simplu și sigur

Adaptoarele Queue-Fair pentru server pot funcționa în modul simplu sau în modul sigur.

În modul simplu, toți vizitatorii sunt trimiși la serverele Queue-Fair pentru a fi numărați, indiferent dacă s-a format sau nu o coadă de așteptare. Atunci când nu există o coadă, aceștia sunt returnați direct la serverul dvs. web, fără a vedea o pagină de coadă - dar cu semnătura de care serverul dvs. web are nevoie pentru a se asigura că numai persoanele care au fost trecute de coadă pot accesa resursele dvs. protejate.

În modul sigur, vizitatorii sunt trimiși la serverele Queue-Fair numai atunci când există o coadă de așteptare. Serverul dvs. web consultă direct serverele noastre de coadă de așteptare pentru a face această determinare. Vizitatorii sunt în continuare semnate digital în siguranță, indiferent dacă este afișată sau nu o pagină de așteptare.

Safe Mode este recomandat pentru cozile de zi cu zi. Modul simplu este adecvat pentru un eveniment cronometrat, când așteptați mii de persoane, deoarece elimină latența datorată apelului de verificare de la serverul dvs. web la serverele noastre de coadă, ceea ce înseamnă că puteți trimite persoane la coadă mai eficient.

Depozite GitHub

Adaptor pentru sala de așteptare virtuală PHP') ?>

PHP

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Server-Side Adapter în PHP.

Adaptor pentru sala de așteptare virtuală Java

Java

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Server-Side Adapter pentru Java, inclusiv JBoss și Tomcat.

Adaptor pentru sala de așteptare virtuală Ruby

Ruby

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Server-Side Adapter în Ruby și (opțional) Rails.

Adaptor pentru sala de așteptare virtuală Python

Python

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Server-Side Adapter în Python și (opțional) Django.

Adaptor pentru sala de așteptare virtuală dotNet

.NET

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Server-Side Adapter pentru .NET, ASP și C#.

Node.js & JavaScript Adaptor pentru sala de așteptare virtuală Node.js & JavaScript

Node.js & JavaScript

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Server-Side Adapter pentru Node.js și (opțional) Express.



Pagini de coadă dinamice

La fel ca în cazul adaptorului pentru partea de client, orice date pe care le doriți pot fi transmise de la serverul dvs. web la serverele noastre și la paginile de așteptare pe care le văd vizitatorii dvs. prin transmiterea acestor informații în apelul adaptorului pentru partea de server. Acest lucru facilitează personalizarea dinamică a paginilor de așteptare sau alte personalizări din mers în același mod - toate caracteristicile adaptorului de partea clientului sunt pe deplin acceptate. Vă rugăm să contactați serviciul de asistență dacă doriți să activați Dynamic Queue Pages în contul dumneavoastră.

Adaptor de partea serverului Resurse suplimentare

Adaptoarele noastre pentru partea de server sunt descrise pe larg în Ghidul tehnic. Ghidul tehnic este disponibil în portalul Queue-Fair > secțiunea Ajutor sau puteți solicita o copie de la noi. De asemenea, puteți găsi mai multe informații despre fiecare dintre adaptoare în fișierul README.md al fiecărui depozit GitHub.


API-uri REST

Queue-Fair oferă dezvoltatorilor acces la șase module API REST. Aveți nevoie de un cont Queue-Fair pentru a utiliza API. Pentru a activa accesul la API pentru contul dvs., vă rugăm să contactați Queue-Fair Support. Modulele noastre REST API sunt conforme cu standardele OpenAPI, RFC 7807 și RFC 3339.

Suita noastră de module API este cuprinzătoare - tot ceea ce puteți face în portal, puteți face și cu API, cu excepția gestionării utilizatorilor portalului, care este exclusă din motive de confidențialitate.

Fiecare modul API este complet documentat la api.queue-fair.net, unde veți găsi, de asemenea, o interfață Swagger pentru a facilita utilizarea și testarea. Pentru securitate, toate apelurile API sunt protejate prin criptare securizată TLS și necesită o cheie API specifică contului dvs.

Module API

API de raportare

Pentru rapoarte în direct, în timp real, rapoarte istorice și statistici agregate privind cozile de așteptare.

API de gestionare a cozilor de așteptare

Pentru a crea și modifica programatic cozile de așteptare în timp real.

API de gestionare a conturilor

Pentru vizualizarea și actualizarea setărilor pentru întregul cont.

API de gestionare a activelor

Pentru gestionarea activelor utilizate de paginile de coadă servite de Google CDN.

API de prezentare

Pentru a modifica orice aspect al codului HTML al paginilor de așteptare și pentru actualizarea și crearea de variante din mers.

API de activare

Pentru configurarea Regulilor de activare care determină ce pagini de pe site-ul dvs. pot declanșa o coadă și ce pagină este afișată.



Pagini de coadă dinamice

De asemenea, puteți modifica paginile de coadă din mers, fără a fi nevoie să actualizați baza de date, utilizând Portalul sau API-ul de prezentare - Contactați serviciul de asistență pentru mai multe detalii și pentru a activa paginile de coadă dinamice în contul dumneavoastră.

REST API Resurse suplimentare

Conform cerințelor RFC 7807, puteți găsi documentația despre mesajele de eroare care pot fi returnate de modulele noastre REST API la queue-fair.com/api-error.


Aplicații native

Queue-Fair arată foarte bine atât pe browserele mobile, cât și pe desktopuri și laptopuri.

De asemenea, puteți utiliza Queue-Fair direct în aplicațiile native pentru iOS și Android, precum și în aplicațiile React Native pe iOS, Android, Windows și MacOS, pentru a proteja activitățile sau operațiunile care necesită multe resurse.

Adaptoarele Queue-Fair App Adapters utilizează un client Web pentru a afișa utilizatorilor dvs. afișaje personalizate ale cozilor de așteptare atunci când serviciile dvs. sunt prea ocupate, cu flexibilitatea și ușurința de utilizare a aplicației Queue-Fair. Queue-Fair Portal.

Puteți să puneți utilizatorii în aceeași coadă ca și vizitatorii site-ului dvs. web sau să creați o coadă separată pentru utilizatorii aplicației dvs. - depinde de dvs.

La fel ca și în cazul cozilor de așteptare bazate pe web, locul fiecărui utilizator este salvat automat și în cazul în care acesta părăsește aplicația.

Depozite GitHub

Adaptor pentru sala de așteptare virtuală iOS, MacOS și Apple

iOS & MacOS

Depozitul GitHub pentru adaptorul pentru sala de așteptare virtuală Queue-Fair pentru iOS și MacOS.

Adaptor pentru sala de așteptare virtuală Android

Android

Depozitul GitHub pentru adaptorul pentru sala de așteptare virtuală Queue-Fair pentru Android.

React Native App React Native Adaptor pentru sala de așteptare virtuală

React Native

Depozitul GitHub pentru adaptorul pentru sala de așteptare virtuală Queue-Fair pentru aplicațiile React Native pentru Android, iOS, MacOS și Windows.

Notificări de coadă

Adaptorul Queue-Fair facilitează trimiterea de notificări push către utilizatorii care nu utilizează aplicația sau coada de așteptare atunci când li se solicită rândul. Locul utilizatorului în coada de așteptare este stocat automat și persistent de către adaptor în aplicația dvs. În cazul în care utilizatorul navighează în afara aplicației dvs., aplicația dvs. îi spune serverului dvs. de notificări Push că trebuie trimisă o notificare, trimițând informațiile privind poziția stocată în coadă ca parte a mesajului către serverul dvs. de notificări Push.

Este aceeași tehnologie pe care o folosim pentru aplicația WeQ4U pentru consumatori, care a fost descărcată în jur de 2 milioane de ori numai în Marea Britanie.

Serverul dvs. de notificări push consultă periodic Queue-Fair Status API pentru a interoga poziția cozii de așteptare care este servită în prezent. Atunci când aceasta este mai mare decât poziția în coadă a unui anumit utilizator, este momentul să trimiteți notificarea acelui utilizator. Dacă utilizatorul revine în coadă sau este trecut înainte de a fi trimisă o notificare Push, adaptorul notifică aplicația dvs., iar aplicația dvs. îi spune serverului de notificare Push că notificarea nu mai este necesară.

Din câte știm noi, suntem singurul furnizor de săli de așteptare virtuale care acceptă această funcție.

Resurse video

Iată un videoclip cu adaptorul pentru aplicații native în acțiune, care arată că locul utilizatorului este salvat chiar dacă aplicația este complet oprită și, de asemenea, arată cârligele adaptorului pe care aplicația dvs. le utilizează pentru a trimite notificări push.

Resurse suplimentare

Adaptoarele noastre native pentru aplicații sunt descrise în Ghidul tehnic. Ghidul tehnic este disponibil în portalul Queue-Fair > secțiunea Ajutor, sau puteți solicita o copie de la noi. De asemenea, puteți găsi mai multe informații despre fiecare dintre adaptoare, specifice pentru iOS și Android, în README.md din fiecare depozit GitHub.


Adaptoare ECommerce

Queue-Fair poate fi adăugat cu ușurință la orice sistem de comerț electronic folosind adaptorul JavaScript pe partea clientului descris mai sus.

Oferim, de asemenea, cod adaptor pentru a lucra pe partea de server cu multe servere populare de comerț electronic.

Depozite GitHub

Magento Plugin

Magento

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Adapter pentru Magento.

WooCommerce/PHP Adaptor pentru sala de așteptare virtuală WooCommerce/PHP

WooCommerce

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Adapter pentru WooCommerce în PHP.

PrestaShop/PHP Adaptor pentru sala de așteptare virtuală PrestaShop/PHP

PrestaShop

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Adapter pentru PrestaShop în PHP.

Resurse suplimentare

Adaptoarele noastre sunt descrise în Ghidul tehnic. Ghidul tehnic este disponibil în portalul Queue-Fair > secțiunea Ajutor, sau puteți solicita o copie de la noi.

Avem, de asemenea, ghiduri suplimentare disponibile pentru majoritatea platformelor de comerț electronic - cereți-le doar pe cele pe care le doriți.


Securitate hibridă

Puteți combina cu ușurință flexibilitatea adaptorului JavaScript din partea clientului cu stratul suplimentar de securitate oferit de codul nostru din partea serverului.

Queue-Fair semnează fiecare vizitator pe care îl trecem cu o amprentă digitală care este unică pentru acel vizitator. În mod unic în industrie, semnătura include, de asemenea, un cod specific browserului vizitatorului, pentru a preveni partajarea token-urilor de acces.

Serverul dvs. web poate valida semnătura folosind un secret cunoscut doar de dvs. și de noi - nu și de vizitatorii dvs. - pentru a se asigura că fiecare vizitator a trecut în mod corect prin serverele Queue-Fair.

Astfel, puteți utiliza adaptorul JavaScript din partea clientului pentru a trimite și a primi vizitatori în și din coadă și pentru a verifica dacă au fost manipulați înainte de a comanda, cu un cod minim de cod din partea serverului, evitând introducerea unei dependențe de sistemul nostru.

Exemple de cod sunt incluse în depozitele noastre GitHub în toate limbajele de programare web importante.

Depozite GitHub

PHP

PHP

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Server-Side Adapter în PHP.

Java

Java

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Server-Side Adapter pentru Java, inclusiv JBoss și Tomcat.

Ruby

Ruby

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Server-Side Adapter în Ruby și (opțional) Rails.

Python

Python

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Server-Side Adapter în Python și (opțional) Django.

.NET

.NET

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Server-Side Adapter pentru .NET, ASP și C#.

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

Node.js & JavaScript

Depozitul GitHub pentru Queue-Fair Virtual Waiting Room Server-Side Adapter pentru Node.js și (opțional) Express.

Resurse suplimentare

Modelul de securitate hibrid este descris pe larg în Ghidul tehnic. Ghidul tehnic este disponibil în portalul Queue-Fair > secțiunea Ajutor, sau puteți solicita o copie de la noi.


Licență

Codul nostru publicat, disponibil la GitHub Queue-Fair Repository, este licențiat sub licența MIT, care este una dintre cele mai permisive licențe Open Source.


Doriți să știți cum funcționează Queue-Fair?