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

Cette page décrit les méthodes de l'API JavaScript reCAPTCHA Enterprise, ainsi que leurs paramètres de configuration, qui vous permettent d'afficher les pages Web avec une clé de site de type "case à cocher".

API JavaScript

Le tableau suivant répertorie les méthodes de l'API JavaScript reCAPTCHA Enterprise.

Méthode Description
grecaptcha.enterprise.render(
Conteneur,
Paramètres
)

Affiche le conteneur en tant que widget reCAPTCHA et renvoie l'ID du widget que vous venez de créer.

conteneur

Élément HTML pour le rendu du widget reCAPTCHA. Spécifiez l'ID du conteneur (chaîne) ou l'élément DOM lui-même.

paramètres

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

grecaptcha.enterprise.reset(
opt_widget_id
)

Réinitialise le widget reCAPTCHA.

opt_widget_id

ID facultatif du widget, défini par défaut sur le premier widget créé s'il n'est pas spécifié.
grecaptcha.enterprise.getResponse
opt_widget_id
)

Récupère la réponse du widget reCAPTCHA.

opt_widget_id

ID facultatif du widget, défini par défaut sur le premier widget créé s'il n'est pas spécifié.

Configuration

Paramètres de ressource JavaScript (enterprise.js)

Le tableau suivant répertorie les paramètres de la ressource JavaScript (enterprise.js) que vous pouvez utiliser pour afficher automatiquement un widget ou explicitement sur une page Web.

Paramètre Valeur Description
Lors du chargement Facultatif. Nom de votre fonction de rappel à exécuter une fois toutes les dépendances chargées.
Rendu

contenu explicite

Lors du chargement

Facultatif. Indique si le widget doit être affiché explicitement. La valeur par défaut est "onload", qui affiche le widget dans le premier tag g-recaptcha qu'il trouve.

Pour plus d'informations sur l'utilisation de ces paramètres, consultez les exemples de la section Afficher le widget reCAPTCHA sur l'interface.

hl Consultez les codes de langue. Facultatif. Force l'affichage du widget dans une langue spécifique. Si aucune valeur n'est spécifiée, détecte automatiquement la langue de l'utilisateur.

Attributs de la balise g-recaptcha et paramètres grecaptcha.enterprise.render

Le tableau suivant répertorie les attributs de tag g-recaptcha et les paramètres grecaptcha.enterprise.render() correspondants.

Attribut de la balise g-recaptcha Paramètre grecaptcha.enterprise.render Valeur Par défaut Description
data-sitekey Clé du site Clé reCAPTCHA.
data-action action Facultatif. Chaîne décrivant l'action actuelle. Actuellement non compatible.
data-theme thème dark light light Facultatif. Thème de couleur du widget.
Taille des données size compact normal Normal Facultatif. Taille du widget.
data-tabindex tabIndex 0 Facultatif. Tabindex du widget et du challenge. Si d'autres éléments de votre page utilisent l'index de onglets, il doit être défini de façon à faciliter la navigation de l'utilisateur.
data-callback rappel Facultatif. Nom de votre fonction de rappel, exécutée lorsque l'utilisateur envoie une réponse positive. Le jeton g-recaptcha-response est transmis à votre rappel.
data-expired-callback expired-callback Facultatif. Nom de votre fonction de rappel, exécuté lorsque la réponse reCAPTCHA expire et que l'utilisateur doit la revalider.
data-error-callback error-callback Facultatif. Nom de votre fonction de rappel, exécutée lorsque reCAPTCHA rencontre une erreur (généralement la connectivité réseau) et ne peut pas continuer tant que la connectivité n'est pas rétablie. Si vous spécifiez une fonction ici, vous êtes tenu d'informer l'utilisateur qu'il doit réessayer.