Questa pagina descrive i metodi dell'API reCAPTCHA Enterprise JavaScript e i relativi parametri di configurazione che puoi utilizzare per eseguire il rendering delle pagine web con una chiave reCAPTCHA (chiave del sito).
Metodi dell'API reCAPTCHA Enterprise per JavaScript
Questa sezione descrive la sintassi e i parametri dei metodi dell'API reCAPTCHA Enterprise JavaScript.
grecaptcha.enterprise.render
Esegue il rendering del container come widget reCAPTCHA e restituisce l'ID del widget appena creato.
Sintassi
grecaptcha.enterprise.render(container: string | HTMLelement, parameters: Object): number
Parametri del metodo
Parametro | Descrizione |
---|---|
container | L'elemento HTML per il rendering del widget reCAPTCHA. Specifica l'ID del contenitore (stringa) o l'elemento DOM stesso. |
parameters |
Un oggetto che contiene parametri come coppie chiave=valore, ad esempio
Consulta Attributi e parametri per informazioni dettagliate su ciascun parametro configurabile. |
Valore restituito
Restituisce l'ID del widget appena creato.
grecaptcha.enterprise.reset
Reimposta il widget reCAPTCHA.
Sintassi
grecaptcha.enterprise.reset(widget_id: number): void
Parametri
Parametro | Descrizione |
---|---|
widget_id | Facoltativo. ID widget restituito da grecaptcha.enterprise.render() . Se non specificato, il valore predefinito corrisponde all'ID del primo widget creato.
|
Valore restituito
Non restituisce un valore.
grecaptcha.enterprise.execute
Richiama in modo programmatico la verifica reCAPTCHA Enterprise.
Sintassi
grecaptcha.enterprise.execute(widget_id: number): Promise<string>
grecaptcha.enterprise.execute(sitekey: string, action: Object): Promise<string>
Parametri
Parametro | Descrizione |
---|---|
widget_id | Facoltativo. ID widget restituito da grecaptcha.enterprise.render() .
Se non specificato, il valore predefinito corrisponde all'ID del primo widget creato. |
sitekey |
Specifica la chiave di sito reCAPTCHA da proteggere. |
action | Un oggetto con una singola coppia chiave=valore, in cui il valore della chiave action specifica il nome dell'azione associato all'elemento protetto.
Ad esempio: |
Valore restituito
In caso di esito positivo, restituisce un oggetto Promise contenente il token.
grecaptcha.enterprise.ready
Esegue la funzione al caricamento della libreria JavaScript di reCAPTCHA Enterprise.
Sintassi
grecaptcha.enterprise.ready(callback: function): void
Parametri
Parametro | Descrizione |
---|---|
callback | La funzione da chiamare al termine del caricamento della libreria reCAPTCHA. |
Valore restituito
Non restituisce un valore.
grecaptcha.enterprise.getResponse
Recupera la risposta per il widget reCAPTCHA.
Sintassi
grecaptcha.enterprise.getResponse(widget_id: number): string
Parametri
Parametro | Descrizione |
---|---|
widget_id | Facoltativo. ID widget restituito da grecaptcha.enterprise.render() . Se non specificato, per impostazione predefinita viene utilizzato l'ID del primo widget creato.
|
Valore restituito
Recupera la risposta del widget reCAPTCHA. Può essere una stringa con il token creato da grecaptcha.enterprise.execute()
o una stringa vuota se il token non è ancora stato creato.
Configurazione
Questa sezione descrive i parametri delle risorse JavaScript, i parametri utilizzati da grecaptcha.enterprise.render()
e gli attributi del widget g-recaptcha
.
Parametri delle risorse JavaScript (enterprise.js)
La seguente tabella elenca i parametri della risorsa JavaScript (enterprise.js
) che devi includere quando utilizzi reCAPTCHA Enterprise.
Per ulteriori informazioni sull'utilizzo di questi parametri, consulta gli esempi nella pagina Rendering del widget reCAPTCHA sul frontend.
Parametro | Valore | Descrizione |
---|---|---|
onload |
callback | Facoltativo. Il nome della funzione di callback da eseguire dopo il caricamento di tutte le dipendenze. |
render
|
onload |
Valore predefinito facoltativo. Visualizza il widget nel primo tag |
explicit
|
Facoltativo. Non esegue il rendering automatico del widget. Devi chiamare
|
|
siteKey |
Se utilizzato con chiavi di sito basate sul punteggio, questo parametro non è facoltativo. Il valore siteKey specifica la chiave di sito basata sul punteggio associata. |
|
hl |
Consulta i codici lingua. | Facoltativo. Forza il rendering del widget in una lingua specifica. Rileva automaticamente la lingua dell'utente, se non specificata. |
Attributi del tag g-recaptcha e parametri grecaptcha.enterprise.render()
La seguente tabella elenca gli attributi del tag g-recaptcha
e i parametri grecaptcha.enterprise.render()
corrispondenti.
Attributo tag g-recaptcha |
Parametro grecaptcha.enterprise.render() |
Valori consentiti | Predefinito | Descrizione |
---|---|---|---|---|
data-sitekey |
sitekey |
Chiave reCAPTCHA. | ||
data-badge |
badge |
bottomright , bottomleft , inline
|
bottomright |
Facoltativo. Riposiziona il badge reCAPTCHA. inline ti consente di posizionarlo con il CSS. |
data-action |
action |
Facoltativo. Stringa che descrive l'azione corrente. | ||
data-theme |
theme |
dark |
light |
Facoltativo. Il tema a colori del widget. |
data-size |
size |
compact , normal |
normal |
Facoltativo. Le dimensioni del widget. |
data-tabindex |
tabindex |
Numero intero | 0 | Facoltativo. Il tabindex del widget e la verifica. Se altri elementi della pagina utilizzano Tabindex, questo deve essere impostato per semplificare la navigazione dell'utente. |
data-callback |
callback |
Stringa | N/A | Facoltativo. Il nome della funzione di callback, eseguita quando l'utente invia una risposta riuscita. Il token g-recaptcha-response viene trasmesso al tuo callback. |
data-expired-callback |
expired-callback |
Stringa | N/A | Facoltativo. Il nome della funzione di callback, eseguita quando la risposta reCAPTCHA scade e l'utente deve verificare di nuovo. |
data-error-callback |
error-callback |
Stringa | N/A | Facoltativo. Il nome della funzione di callback, eseguita quando reCAPTCHA rileva un errore (di solito la connettività di rete) e non può continuare finché la connettività non viene ripristinata. Se specifichi una funzione qui, è tua responsabilità informare l'utente che deve riprovare. |