Riferimento API JavaScript per reCAPTCHA Enterprise

In questa pagina vengono descritti i metodi dell'API JavaScript Enterprise di reCAPTCHA e i relativi parametri di configurazione che puoi usare per visualizzare le pagine web con una chiave del sito.

API JavaScript

La tabella seguente elenca i metodi dell'API JavaScript Enterprise di reCAPTCHA.

Metodo Descrizione
grecaptcha.enterprise.render(
container,
parameters
)

Visualizza il container come widget reCAPTCHA e restituisce l'ID del widget appena creato.

contenitore

L'elemento HTML per eseguire il rendering del widget reCAPTCHA. Specifica l'ID del contenitore (stringa) o l'elemento DOM stesso.

parametri

Un oggetto contenente parametri come coppie chiave=valore, ad esempio {"sitekey": "your_site_key", "theme": "light"}.

grecaptcha.enterprise.reset(
opt_widget_id
)

Reimposta il widget reCAPTCHA.

opt_widget_id

ID widget facoltativo, il valore predefinito è il primo widget creato se non specificato.
grecaptcha.enterprise.execute (
opt_widget_id
)

Richiama in modo programmatico la verifica reCAPTCHA Enterprise.

opt_widget_id

ID widget facoltativo: il valore predefinito è il primo widget creato se non è specificato.
grecaptcha.enterprise.execute (
site_key,
{action: 'action_name'}
)

Richiama in modo programmatico la verifica reCAPTCHA Enterprise per le chiavi sito basate sul punteggio.

chiave_sito

Specifica la chiave di sito reCAPTCHA da proteggere.

azione

Specifica il nome dell'azione associato all'elemento protetto.

Per ulteriori informazioni sull'utilizzo di questo metodo, consulta la sezione Integrare la chiave di sito basata sul punteggio con il frontend.

grecaptcha.enterprise.ready ( )

Esegue la funzione quando viene caricata la libreria reCAPTCHA.

Per ulteriori informazioni sull'utilizzo di questo metodo, consulta la sezione Integrare la chiave di sito basata sul punteggio con il frontend.

grecaptcha.enterprise.getResponse (
opt_widget_id
)

Visualizza la risposta per il widget reCAPTCHA.

opt_widget_id

ID widget facoltativo: il valore predefinito è il primo widget creato se non è specificato.

Configurazione

Parametri delle risorse JavaScript (enterprise.js)

La tabella riportata di seguito elenca i parametri della risorsa JavaScript (enterprise.js) che puoi utilizzare per visualizzare un widget in modo automatico o esplicito su una pagina web.

Parametro Valore Descrizione
onload (Facoltativo) Il nome della funzione di callback da eseguire dopo che sono state caricate tutte le dipendenze.
render

esplicito

onload

(Facoltativo) Indica se eseguire il rendering esplicito del widget. Il valore predefinito è Onload, che esegue il rendering del widget nel primo tag g-recaptcha trovato.

Per maggiori informazioni sull'utilizzo di questi parametri, vedi gli esempi in Rendering del widget reCAPTCHA sul frontend.

hl Vedi i codici lingua. (Facoltativo) Forza il rendering del widget in una lingua specifica. Rileva automaticamente la lingua dell'utente se non specificata.

Attributi dei tag g-recaptcha e parametri di grecaptcha.enterprise.render

La seguente tabella elenca gli attributi dei tag g-recaptcha e i parametri grecaptcha.enterprise.render() corrispondenti.

Attributo tag g-recaptcha Parametro grecaptcha.enterprise.render Valore predefinita Descrizione
data-sitekey sitekey Chiave reCAPTCHA.
data-action action (Facoltativo) Stringa che descrive l'azione corrente. Non supportato.
data-theme theme luce scura luce (Facoltativo) Il tema a colori del widget.
data-size size compatto normale normale (Facoltativo) Le dimensioni del widget.
data-tabindex tabindex 0 (Facoltativo) L'indice della scheda del widget e della verifica. Se altri elementi della pagina utilizzano il tasto Tabindex, deve essere impostato in modo da rendere la navigazione utente più semplice.
data-callback callback (Facoltativo) Il nome della funzione di callback, eseguita quando l'utente invia una risposta riuscita. Il token g-recaptcha-response viene passato al tuo callback.
data-expired-callback expired-callback (Facoltativo) Il nome della funzione di callback, eseguita alla scadenza della risposta reCAPTCHA e che l'utente deve ripetere la verifica.
data-error-callback error-callback (Facoltativo) Il nome della funzione di callback, eseguito quando reCAPTCHA rileva un errore (di solito connettività di rete) e non può continuare finché la connettività non viene ripristinata. Se specifichi una funzione qui, sei responsabile di informare l'utente che deve riprovare.