INTEGRITY Dokumentace

Widgety Turnstile

Widget Turnstile určuje, jak se Turnstile na vaší stránce chová. Každý widget má režim, popisek, sitekey, a tajný klíč. Widgetů si můžete vytvořit více, každý s jiným nastavením.

Turnstile běží pod doménou challenges.cloudflare.com. Vaše aplikace se bude připojovat k tomuto originu. Pokud váš web používá Content Security Policy, musíte připojení k této doméně povolit.

Součásti widgetu

Každý widget má vlastní jedinečnou dvojici sitekey a secret key a vlastní možnosti konfigurace.

Komponenta Popis
Sitekey Veřejný klíč, kterým se widget Turnstile na webu vyvolá.
Tajný klíč Privátní klíč pro ověření tokenu na straně serveru.
Konfigurace Režim, názvy hostitelů, nastavení vzhledu a další možnosti.

Režimy widgetu

Dostupné režimy widgetů Turnstile jsou Managed, Non-Interactive, a Invisible.

Režim widgetu Popis Případ použití
Managed (doporučeno) Podle míry rizika návštěvníka automaticky volí mezi neinteraktivní výzvou a výzvou se zaškrtávacím políčkem. Žádné obrázky ani text k rozluštění. Jednoduché nastavení s adaptivním zabezpečením. Vyvažuje ochranu a pohodlí uživatelů.
Non-Interactive Zobrazí viditelný widget s načítacím indikátorem. Výzvy proběhnou, aniž by návštěvník musel cokoli udělat. Minimalizuje zátěž pro návštěvníka a přitom dává najevo, že ověřování probíhá.
Invisible Výzvy probíhají zcela na pozadí, bez viditelného widgetu a bez indikátorů načítání. Maximální vizuální čistota, žádné viditelné prvky ověření.

Režim Managed plně spravuje Cloudflare. Vhodnou akci volí automaticky podle signálů ze strany klienta a podle míry rizika. Na základě informací od návštěvníka pak Cloudflare rozhodne, zda se má použít interaktivní výzva.

Turnstile si vyžádá interakci jen tehdy, když je k ověření, že jde o člověka, potřeba další kontrola. V takovém případě návštěvník pouze zaškrtne políčko. Nebude luštit žádné obrázky ani text.

Režim Managed je ideální pro ty, kdo chtějí jednoduché nastavení a nepotřebují chování widgetu dolaďovat.

Režim Non-Interactive

Návštěvník uvidí widget s načítacím indikátorem, dokud v jeho prohlížeči běží výzvy. Na rozdíl od režimu Managed se po něm interakce s widgetem nikdy nevyžaduje a widget ho k ní ani nevyzývá.

Režim Non-Interactive se hodí tam, kde je na prvním místě pohodlí návštěvníků a kde nechcete web zatěžovat žádnou interakcí s Turnstile.

Režim Invisible

Režim Invisible je podobný režimu Non-Interactive: návštěvník s widgetem Turnstile nikdy neinteraguje. Neuvidí ani samotný widget, ani žádný náznak toho, že na pozadí probíhá neviditelná výzva prohlížeče.

Režim Invisible je vhodný pro ty, kdo chtějí na svém webu upřednostnit zážitek návštěvníka a vzhled stránky.


Přizpůsobení widgetu

Velikosti

Widgety lze nasadit ve velikosti normal, flexible nebo compact.

Viz Konfigurace widgetů s podrobnými možnostmi konfigurace a ukázkami kódu.

Vzhled a motivy

Widgety Turnstile podporují několik režimů vzhledu a motivů, aby odpovídaly designu vašeho webu.

Viz Konfigurace widgetů s podrobnostmi k implementaci.


Stavy widgetu

flowchart LR
accTitle: Normal widget operation states
accDescr: This diagram details a Turnstile widget's normal operation states.
    A[<b>Loading</b><br /><small>Widget is processing the challenge.</small> ] --> B[<b>Interaction*</b><br /><small>Visitor needs to check the box. <br />*Managed mode only.</small>]
    B --> C[<b>Success</b><br /><small>The Challenge was completed successfully.</small>]

Chybové stavy

Typ
Popis
Neznámá chyba Tento stav widgetu se zobrazí, když během výzvy dojde k neznámé chybě. Návštěvník se může řídit pokyny k řešení potíží přímo ve widgetu, nebo stránku znovu načíst a výzvu zopakovat.
Vypršel časový limit interakce Návštěvníkovi se zobrazí zaškrtávací políčko, ale delší dobu s ním nijak nepracuje. Výzvu je nutné vydat znovu načtením stránky nebo widgetu.
Vypršel časový limit ověření Pokud ověření proběhlo, ale nenásledovala žádná další akce, výsledek výzvy přestane po čase platit. Příklad: widget Turnstile je na přihlašovací stránce a proběhl úspěšně, návštěvník se ale dlouho nepřihlásil. Výzvu je pak nutné vydat znovu, tedy načíst stránku nebo widget.
Zastaralý nebo nepodporovaný prohlížeč Tento stav widgetu uvidí návštěvníci se zastaralými nebo nepodporovanými prohlížeči. Viz Podporované prohlížeče s dalšími informacemi o podporovaných prohlížečích.