JavaScript API

JavaScript API definira štiri funkcije, s katerimi lahko manipuliramo delovanje in prikaz hCaptche. Pogosto jih uporabimo v kombinaciji z drugimi oblikami konfiguracije, o čemer lahko več izveste v prejšnjih dveh poglavjih. Za vse funkcije je značilno, da jih kličemo nad hcaptcha objektom.

hcaptcha.izbranaFunkcija();

render()

Funkcija render(container, params) generira hCaptcho znotraj vsebnika, ki smo ga definirali v HTML. Sprejme dva parametra:

container predstavlja ID vsebnika

params je objekt z večimi parametri. Gre za iste atribute, ki smo jih spoznali v prejšnjem poglavju o konfiguriranju vsebnika, le da jih zapišemo brez data- predpone. Primer:

{“sitekey“: “10000000-ffff-ffff-ffff-000000000001”, “theme“: “dark”}

Funkcija vrne tudi unikaten ID generirane hCaptche. Ta ID se uporablja predvsem pri ostalih funkcijah, ki jih ponuja JavaScript API.

Spodaj lahko vidimo primer, kjer kombiniramo konfiguracijo uvoza skript in funkcijo render(). Pri uvozu skripte smo dodali onload in render, ki poskrbita, da se hCaptcha avtomatsko ne prikaže in da po uvozu skript pokliče funkcija testFunkcija(). Za lažji prikaz delovanja funkcije render(), je bil dodan tudi tri sekundni zamik.

reset()

Funkcija reset(widgetID) omogoča ponastavitev hCaptche preko njej dodeljenega ID-ja. widgetID je opcijski parameter in v kolikor ni podan, se ponastavi prva generirana CAPTCHA na strani.

getResponse()

Funkcija getResponse(widgetID) vrne geslo rešene hCaptche, ki bi ga sicer pridobili preko h-captcha-response iz POST zahteve. widgetID je opcijski parameter in v kolikor ni podan, se uporabi prva generirana CAPTCHA na strani.

execute()

Funkcija execute(widgetID) sproži izvajanje celotnega procesa hCaptche – najprej se glede na trenutne podatke preveri, če je obiskovalec človek ali ne. V kolikor trenutni podatki niso zadostni, se pokaže še izziv s fotografijami. Najpogosteje se uporabi v povezavi z nevidno (angl. invisible) CAPTCHA-o, o čemer lahko izveste več v naslednjem poglavju. Tam najdete tudi primer uporabe funkcije execute()

widgetID je opcijski parameter in v kolikor ni podan, se uporabi prva generirana CAPTCHA na strani.