Zasoby dla programistów



Dodanie Queue-Fair

Wirtualną poczekalnię Queue-Fair można łatwo dodać do wielu różnych platform internetowych i aplikacji w ciągu kilku minut. Wystarczy użyć jednego z naszych adapterów. Więcej informacji na temat najlepszego sposobu integracji Queue-Fair z istniejącym systemem można znaleźć w Przewodniku technicznym lub w sekcji Queue-Fair Portal > Pomoc.

Adapter po stronie klienta

W przypadku stron internetowych najprostszym sposobem integracji z Queue-Fair jest dodanie do stron znacznika JavaScript Client-Side Queue-Fair Adapter. Adapter można bezpiecznie dodać do wszystkich stron w witrynie, a za pomocą reguł aktywacji w portalu Q FXNPQ określić, które strony mogą rzucać kolejką.

Ponieważ działa on w przeglądarkach odwiedzających, Client-Side Adapter może zostać wyłączony przez technicznie uzdolnionych użytkowników, ale jest bardzo skuteczny w zapobieganiu przeciążeniom, ponieważ tylko niewielka mniejszość osób będzie próbowała ominąć kolejkę, manipulując przy JavaScript. Większość naszych klientów korzysta z Adaptera Client-Side, ponieważ skutecznie zapobiega on zawieszaniu się witryny, jest prosty w instalacji i nie wprowadza żadnych zależności między naszym i Twoim systemem.

Można dodać warstwę zabezpieczeń, zastępując znacznik JavaScript adapterem po stronie serwera, lub połączyć elastyczność adaptera JavaScript z hybrydowym modelem zabezpieczeń opisanym na tej stronie; obie metody są wtedy bezpieczne.

Pojedyncza linijka kodu

Aby dodać Adapter Client-Side do witryny, wystarczy dodać następujący wiersz kodu do strony <head> sekcji stron:

Dodaj naszą wirtualną poczekalnię do swojej witryny za pomocą tej jednej linijki kodu i zapobiegaj awariom witryny.

Niektórzy klienci dodają słowo defer do znacznika, co spowoduje, że skrypt adaptera będzie pobierany równolegle z przetwarzaniem strony, a także rozpocznie wykonywanie skryptu w przeglądarce odwiedzającego dopiero po zakończeniu przetwarzania strony (czyli zazwyczaj po zakończeniu wykonywania innych skryptów na stronie).

Dodanie słowa defer może w niektórych przypadkach poprawić Time to First Paint o niewielki ułamek sekundy, ale jeśli się na to zdecydujesz, będzie to oznaczać, że odwiedzający, którzy powinni być umieszczeni w kolejce, będą widzieć Twoją chronioną stronę przez ułamek sekundy dłużej, zanim zostaną odesłani do kolejki.

Google Tag Manager

Udostępniamy również znacznik adaptera JavaScript za pośrednictwem menedżera tagów Google. Poszukaj Queue-Fair w Galerii Szablonów Społecznościowych, w sekcji Dodaj znacznik. Należy pamiętać, że niektóre blokery reklam uniemożliwiają pobranie z Google pliku głównego gtm.js, co blokuje wszystkie operacje wykonywane przez Menedżera tagów Google, w tym uruchomienie adaptera dla tych użytkowników.Nasz tag Wirtualna poczekalnia dla Google Tag Manager

Repozytoria GitHub

Google Tag Manager

Google Tag Manager

Repozytorium GitHub dla znacznika Queue-Fair Virtual Waiting Room Google Tag Manager Client-Side Adapter Tag.

Dynamiczne strony kolejki

Wszelkie dane, które chcesz, mogą być przekazywane z Twojej witryny do naszych serwerów i do stron kolejki, które widzą Twoi goście, za pomocą atrybutu data-queue-fair-extra, który jest dostępny w znaczniku JavaScript po stronie klienta i implementacji Google Tag Manager. Jeśli chcesz włączyć dynamiczne strony kolejkowe na swoim koncie, skontaktuj się z pomocą techniczną.

Za pomocą tej funkcji można na bieżąco dostosowywać strony kolejki. Można także użyć Queue-Fair do przekazywania danych, które użytkownik wysyła do nas wraz z odwiedzającymi, z powrotem na swoją witrynę, gdy są oni przepuszczani przez kolejkę, co zapewnia dodatkową warstwę bezpieczeństwa.

Udostępniamy także interfejs API dynamicznej strony kolejki, który wykorzystuje dodatkowe dane do dostosowania dowolnego aspektu strony kolejki. Dzięki temu można utworzyć jedną kolejkę dla całej witryny i automatycznie dostosowywać ją do różnych wydarzeń lub produktów w witrynie, bez konieczności wprowadzania jakichkolwiek zmian na stronie kolejki w portalu Queue-Fair

.



Wordpress i WooCommerce

Jeśli korzystasz z witryny opartej na Wordpress, takiej jak system koszyka na zakupy WooCommerce, możesz łatwo dodać znacznik Client-Side JavasScript Adapter za pomocą wtyczki Wordpress Insert Headers & Footers Plugin, bez konieczności modyfikowania jakichkolwiek motywów lub dotykania kodu Wordpress.

Wystarczy pobrać wtyczkę Insert Headers & Footers Plugin, rozpakować ją do folderu /wp-content/plugins/, aktywować wtyczkę w menu Plugins, otworzyć wtyczkę w menu Settings, dodać tag do Scripts in Header, jak pokazano na rysunku, kliknąć Save na dole strony i gotowe!

Tablica rozdzielcza portalu Queue-Fair

Adapter po stronie klienta Dodatkowe zasoby

Adapter Client-Side Adapter jest w pełni opisany w Przewodniku technicznym. Przewodnik techniczny jest dostępny w sekcji Pomoc w portalu Queue-Fair lub można zamówić jego kopię w naszej firmie.


Adaptery po stronie serwera

Podczas gdy adapter po stronie klienta działa w przeglądarce internetowej w języku JavaScript, adaptery Queue-Fair po stronie serwera działają na serwerze internetowym.

Adaptery serwera WWW

Oznacza to, że serwer WWW może korzystać z dodatkowych funkcji bezpieczeństwa, aby odmówić dostępu osobom, które nie zostały umieszczone w kolejce. Oznacza to także, że Twój serwer WWW nie będzie obciążony generowaniem i obsługą stron zawierających skrypt Adaptera.

Dodanie bibliotek Queue-Fair Server-Side Adapter zajmuje tylko kilka minut i wymaga minimalnych zmian w kodzie, aby aktywować i uruchomić adapter.

Większość naszych klientów zaczyna od adaptera JavaScript po stronie klienta i przechodzi na adapter po stronie serwera tylko wtedy, gdy istnieje konkretna potrzeba biznesowa.

Tryb prosty i bezpieczny

Adaptery po stronie serwera Queue-Fair mogą pracować w trybie prostym lub bezpiecznym.

W trybie prostym wszyscy odwiedzający są wysyłani do serwerów Queue-Fair w celu zliczenia, niezależnie od tego, czy utworzyła się kolejka, czy nie. Jeśli nie ma kolejki, odwiedzający są natychmiast odsyłani do serwera WWW, bez wyświetlania strony kolejki - ale z podpisem, którego serwer WWW potrzebuje, aby zapewnić, że tylko osoby przepuszczone przez kolejkę mają dostęp do chronionych zasobów.

W trybie bezpiecznym odwiedzający są wysyłani do serwerów Queue-Fair tylko wtedy, gdy istnieje kolejka. Serwer WWW użytkownika konsultuje się bezpośrednio z naszymi serwerami kolejkowymi w celu podjęcia tej decyzji. Odwiedzający są nadal bezpiecznie podpisywani cyfrowo, niezależnie od tego, czy wyświetlana jest strona kolejki, czy nie.

Tryb bezpieczny jest zalecany do codziennej obsługi kolejek. Tryb prosty jest odpowiedni w przypadku wydarzeń czasowych, gdy spodziewasz się tysięcy osób, ponieważ eliminuje opóźnienia spowodowane sprawdzaniem połączeń z Twojego serwera WWW do naszych serwerów kolejkowych, co oznacza, że możesz sprawniej wysyłać ludzi do kolejki.

Repozytoria GitHub

Adapter wirtualnej poczekalni PHP') ?>

PHP

Repozytorium GitHub dla adaptera Queue-Fair Virtual Waiting Room Server-Side Adapter w PHP.

Adapter wirtualnej poczekalni Java

Java

Repozytorium GitHub dla adaptera Queue-Fair Virtual Waiting Room Server-Side Adapter dla środowiska Java, w tym JBoss i Tomcat.

Adapter wirtualnej poczekalni Ruby

Ruby

Repozytorium GitHub dla adaptera Queue-Fair Virtual Waiting Room Server-Side Adapter w Ruby i (opcjonalnie) Rails.

Adapter wirtualnej poczekalni w Pythonie

Python

Repozytorium GitHub dla adaptera Queue-Fair Virtual Waiting Room Server-Side Adapter w Pythonie i (opcjonalnie) Django.

Adapter wirtualnej poczekalni dotNet

.NET

Repozytorium GitHub dla adaptera Queue-Fair Virtual Waiting Room Server-Side Adapter dla .NET, ASP i C#.

Adapter wirtualnej poczekalni Node.js i JavaScript

Node.js & JavaScript

Repozytorium GitHub dla adaptera Queue-Fair Virtual Waiting Room Server-Side Adapter dla Node.js i (opcjonalnie) Express.



Dynamiczne strony kolejki

Podobnie jak w przypadku adaptera Client-Side Adapter, dowolne dane mogą być przekazywane z serwera WWW do naszych serwerów i stron kolejki, które widzą odwiedzający, poprzez przekazanie tych informacji w wywołaniu Server-Side Adapter. Umożliwia to dynamiczne dostosowywanie stron kolejki lub innych elementów w locie w ten sam sposób - wszystkie funkcje adaptera Client-Side Adapter są w pełni obsługiwane. Jeśli chcesz włączyć dynamiczne strony kolejkowe na swoim koncie, skontaktuj się z działem pomocy technicznej.

Adapter po stronie serwera Dodatkowe zasoby

Nasze adaptery po stronie serwera są w pełni opisane w Przewodniku technicznym. Przewodnik techniczny jest dostępny w sekcji Pomoc portalu Queue-Fair lub można poprosić nas o jego kopię. Więcej informacji o każdym z adapterów można również znaleźć w pliku README.md w każdym repozytorium GitHub.


Interfejsy API REST

Queue-Fair zapewnia programistom dostęp do sześciu modułów REST API. Do korzystania z interfejsu API potrzebne jest konto Queue-Fair. Aby umożliwić dostęp do API dla swojego konta, skontaktuj się z działem pomocy technicznej QFXNPQ. Nasze moduły REST API są zgodne z normami OpenAPI, RFC 7807 i RFC 3339.

Nasz pakiet modułów API jest wszechstronny - wszystko, co można zrobić w portalu, można również zrobić za pomocą interfejsu API, z wyjątkiem zarządzania użytkownikami portalu, które jest wyłączone ze względu na ochronę prywatności.

Każdy moduł API jest w pełni udokumentowany na stronie api.queue-fair.net, gdzie znajdziesz także interfejs Swagger ułatwiający korzystanie i testowanie. Dla bezpieczeństwa wszystkie wywołania API są chronione bezpiecznym szyfrowaniem TLS i wymagają podania klucza API właściwego dla twojego konta.

Moduły API

API do raportowania

Raporty na żywo, raporty w czasie rzeczywistym, raporty historyczne i zbiorcze statystyki kolejek.

Interfejs API zarządzania kolejkami

Służy do programowego tworzenia i modyfikowania kolejek w czasie rzeczywistym.

Interfejs API do zarządzania kontami

Umożliwia przeglądanie i aktualizowanie ustawień całego konta.

Interfejs API do zarządzania aktywami

Do zarządzania zasobami używanymi przez strony kolejki obsługiwane przez Google CDN.

Interfejs API prezentacji

Umożliwia zmianę dowolnego aspektu HTML stron kolejki oraz aktualizację i tworzenie wariantów na bieżąco.

API aktywacji

Służy do konfigurowania reguł aktywacji, które określają, które strony witryny mogą wywołać kolejkę oraz która strona jest wyświetlana.



Dynamiczne strony kolejki

Strony kolejek można również modyfikować na bieżąco bez konieczności aktualizowania bazy danych za pomocą interfejsu API portalu lub prezentacji - aby uzyskać więcej informacji i włączyć dynamiczne strony kolejek na swoim koncie, skontaktuj się z pomocą technicz ną.

Dodatkowe zasoby interfejsu API REST

Zgodnie z wymogami RFC 7807, dokumentację dotyczącą komunikatów o błędach, które mogą być zwracane przez nasze moduły REST API, można znaleźć na stronie queue-fair.com/api-error


Aplikacje natywne

Queue-Fair wygląda świetnie zarówno na przeglądarkach mobilnych, jak i na komputerach stacjonarnych i laptopach.

Queue-Fair można również używać bezpośrednio w natywnych aplikacjach na systemy iOS i Android, a także w aplikacjach React Native na systemy iOS, Android, Windows i MacOS, aby chronić działania lub operacje wymagające dużej ilości zasobów.

Queue-Fair App Adapters wykorzystują WebClient do wyświetlania użytkownikom niestandardowych ekranów kolejek, gdy usługi są zbyt obciążone, przy zachowaniu elastyczności i łatwości użycia Queue-Fair Portal.

Możesz ustawić użytkowników w tej samej kolejce, co odwiedzających witrynę, lub utworzyć osobną kolejkę dla użytkowników aplikacji - wszystko zależy od Ciebie.

Podobnie jak w przypadku naszych kolejek internetowych, miejsce każdego użytkownika jest automatycznie zapisywane, jeśli opuści on aplikację.

Repozytoria GitHub

Adapter wirtualnej poczekalni iOS, MacOS i Apple

iOS & MacOS

Repozytorium GitHub dla programu Queue-Fair Virtual Waiting Room Adapter dla systemów iOS i MacOS.

Adapter wirtualnej poczekalni dla systemu Android

Android

Repozytorium GitHub dla adaptera wirtualnej poczekalni Queue-Fair dla systemu Android.

Aplikacja React Native Adapter do wirtualnej poczekalni

React Native

Repozytorium GitHub dla adaptera wirtualnej poczekalni Queue-Fair dla aplikacji React Native dla systemów Android, iOS, MacOS i Windows.

Powiadomienia o kolejkach

Adapter Queue-Fair ułatwia wysyłanie powiadomień Push do użytkowników, którzy nie korzystają z Twojej aplikacji lub kolejki, gdy zostanie wywołana ich kolejka. Miejsce użytkownika w kolejce jest automatycznie trwale zapisywane przez adapter w Twojej aplikacji. Jeśli użytkownik odejdzie od aplikacji, aplikacja powiadomi serwer powiadomień Push o konieczności wysłania powiadomienia, wysyłając zapisaną informację o pozycji w kolejce jako część tej wiadomości do serwera powiadomień Push.

Jest to ta sama technologia, którą wykorzystujemy w naszej aplikacji konsumenckiej WeQ4U, która w samej Wielkiej Brytanii została pobrana około 2 milionów razy.

Twój serwer powiadomień Push co jakiś czas korzysta z interfejsu API Queue-Fair Status, aby uzyskać informacje o pozycji w kolejce aktualnie obsługiwanych użytkowników. Jeśli jest ona większa niż pozycja w kolejce danego użytkownika, nadszedł czas, aby wysłać mu powiadomienie. Jeśli użytkownik powróci do kolejki lub zostanie pominięty przed wysłaniem powiadomienia Push, adapter powiadomi o tym aplikację użytkownika, a aplikacja poinformuje serwer powiadomień Push, że powiadomienie nie jest już potrzebne.

Według naszej wiedzy jesteśmy jedynym dostawcą wirtualnej poczekalni, który obsługuje tę funkcję.

Materiały wideo

Oto film przedstawiający działanie adaptera aplikacji natywnej, pokazujący, że miejsce użytkownika jest zachowywane nawet po całkowitym zatrzymaniu aplikacji, a także pokazujący haki adaptera używane przez aplikację do wysyłania powiadomień push.

Dodatkowe zasoby

Nasze Native App Adapters są opisane w Przewodniku technicznym. Przewodnik techniczny jest dostępny w Portalu Queue-Fair > sekcja Pomoc, można też poprosić o jego kopię u nas. Więcej informacji na temat każdego z adapterów dla systemów iOS i Android można znaleźć w pliku README.md w każdym repozytorium GitHub.


Adaptery handlu elektronicznego

Queue-Fair można łatwo dodać do dowolnego systemu eCommerce za pomocą opisanego powyżej adaptera Client-Side JavaScript.

Oferujemy również kod adaptera do pracy po stronie serwera z wieloma popularnymi serwerami e-commerce.

Repozytoria GitHub

Magento Plugin

Magento

Repozytorium GitHub dla adaptera wirtualnej poczekalni Queue-Fair dla Magento.

Adapter wirtualnej poczekalni WooCommerce/PHP

WooCommerce

Repozytorium GitHub dla adaptera wirtualnej poczekalni Queue-Fair dla WooCommerce w PHP.

Adapter wirtualnej poczekalni PrestaShop/PHP

PrestaShop

Repozytorium GitHub dla Adaptera wirtualnej poczekalni Queue-Fair dla PrestaShop w PHP.

Dodatkowe zasoby

Nasze adaptery są opisane w Przewodniku technicznym. Przewodnik techniczny jest dostępny w portalu Queue-Fair > sekcja Pomoc lub można zamówić jego kopię u nas.

Mamy również dodatkowe przewodniki dostępne dla większości platform handlu elektronicznego - wystarczy zapytać o ten, który chcesz.


Bezpieczeństwo hybrydowe

Można łatwo połączyć elastyczność adaptera JavaScript po stronie klienta z dodatkową warstwą zabezpieczeń zapewnianą przez nasz kod po stronie serwera.

Queue-Fair podpisuje każdego gościa, którego przepuszczamy, cyfrowym odciskiem palca, który jest unikalny dla danego gościa. Wyjątkowo w branży podpis zawiera również kod specyficzny dla przeglądarki odwiedzającego, aby zapobiec udostępnianiu tokenów dostępu.

Serwer WWW użytkownika może potwierdzić podpis przy użyciu sekretu znanego tylko jemu i nam - a nie odwiedzającym - aby mieć pewność, że każdy odwiedzający został uczciwie przepuszczony przez serwery Queue-Fair.

Można więc użyć adaptera JavaScript po stronie klienta do wysyłania i odbierania gości do i z kolejki oraz sprawdzania, czy nie są manipulowani, zanim złożą zamówienie, przy minimalnym kodzie po stronie serwera i bez wprowadzania zależności od naszego systemu.

W naszych repozytoriach GitHub znajduje się przykładowy kod w każdym głównym języku programowania internetowego.

Repozytoria GitHub

PHP

PHP

Repozytorium GitHub dla adaptera Queue-Fair Virtual Waiting Room Server-Side Adapter w PHP.

Java

Java

Repozytorium GitHub dla adaptera Queue-Fair Virtual Waiting Room Server-Side Adapter dla środowiska Java, w tym JBoss i Tomcat.

Ruby

Ruby

Repozytorium GitHub dla adaptera Queue-Fair Virtual Waiting Room Server-Side Adapter w języku Ruby i (opcjonalnie) Rails.

Python

Python

Repozytorium GitHub dla adaptera Queue-Fair Virtual Waiting Room Server-Side Adapter w Pythonie i (opcjonalnie) Django.

.NET

.NET

Repozytorium GitHub dla adaptera Queue-Fair Virtual Waiting Room Server-Side Adapter dla .NET, ASP i C#.

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

Node.js & JavaScript

Repozytorium GitHub dla adaptera Queue-Fair Virtual Waiting Room Server-Side Adapter dla Node.js i (opcjonalnie) Express.

Dodatkowe zasoby

Hybrydowy model zabezpieczeń jest w pełni opisany w Przewodniku technicznym. Przewodnik techniczny jest dostępny w Portalu Queue-Fair > sekcja Pomoc lub można zamówić jego kopię u nas.


Licencja

Nasz opublikowany kod dostępny w Repozytorium Queue-Fair na GitHubie jest objęty licencją MIT, która jest jedną z najbardziej liberalnych licencji Open Source.


Chcesz wiedzieć, jak działa Queue-Fair?