Documentation de référence sur l'API JavaScript pour reCAPTCHA

Cette page décrit les méthodes de l'API JavaScript reCAPTCHA et les paramètres de configuration que vous pouvez utiliser pour afficher les pages Web avec une clé reCAPTCHA (clé de site).

Méthodes de l'API JavaScript reCAPTCHA

Cette section décrit la syntaxe et les paramètres des méthodes de l'API JavaScript reCAPTCHA.

grecaptcha.enterprise.render

Affiche le conteneur sous la forme d'un widget reCAPTCHA et renvoie l'ID du widget nouvellement créé.

Syntaxe

grecaptcha.enterprise.render(container: string | HTMLelement, parameters: Object): number

Paramètres de la méthode

Paramètre Description
container Élément HTML permettant d'afficher le widget reCAPTCHA. Indiquez l'ID du conteneur (chaîne) ou l'élément DOM proprement dit.
parameters

Objet contenant des paramètres sous forme de paires clé/valeur, par exemple : {"sitekey": "your_site_key", "action": "login", "theme": "dark"}.

Pour en savoir plus sur chaque paramètre configurable, consultez la section Attributs et paramètres.

Valeur renvoyée

Renvoie l'ID du widget nouvellement créé.

grecaptcha.enterprise.reset

Réinitialise le widget reCAPTCHA.

Syntaxe

grecaptcha.enterprise.reset(widget_id: number): void

Paramètres

Paramètre Description
widget_id Facultatif. ID du widget renvoyé par grecaptcha.enterprise.render(). Si ce champ n'est pas spécifié, l'ID du premier widget créé est utilisé par défaut.

Valeur renvoyée

Ne renvoie aucune valeur.

grecaptcha.enterprise.execute

Il appelle de manière automatisée la validation de reCAPTCHA.

Syntaxe

grecaptcha.enterprise.execute(widget_id: number): Promise<string>
 
grecaptcha.enterprise.execute(sitekey: string,