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 et les paramètres de configuration que vous pouvez utiliser pour afficher les pages Web avec une clé de site de case à cocher.

API JavaScript

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

Méthode Description
grecaptcha.enterprise.render(
container,
parameters
)

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

conteneur

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

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 de widget facultatif. Par défaut, en l'absence de valeur spécifiée, il s'agit du premier widget créé.
grecaptcha.enterprise.execute (
opt_widget_id
)

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

opt_widget_id

ID de widget facultatif. Par défaut, en l'absence de valeur spécifiée, il s'agit du premier widget créé.

Pour en savoir plus sur l'utilisation de cette méthode, consultez la section Intégrer la clé de site basée sur des scores avec l'interface.

grecaptcha.enterprise.ready ( )

Exécute votre fonction lors du chargement de la bibliothèque reCAPTCHA.

Pour en savoir plus sur l'utilisation de cette méthode, consultez la section Intégrer la clé de site basée sur des scores avec l'interface.

grecaptcha.enterprise.getResponse (
opt_widget_id
)

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

opt_widget_id

ID de widget facultatif. Par défaut, en l'absence de valeur spécifiée, il s'agit du premier widget créé.

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 ou explicitement un widget sur une page Web.

Paramètre Valeur Description
onload Facultatif. Nom de la fonction de rappel à exécuter une fois que toutes les dépendances sont chargées.
render

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 trouvé.

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 Voir 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 tag g-recaptcha Paramètre grecaptcha.enterprise.render Valeur Par défaut Description
data-sitekey sitekey Clé reCAPTCHA.
data-action action Facultatif. Chaîne décrivant l'action actuelle. Incompatible
data-theme theme dark light light Facultatif. Thème de couleur du widget.
data-size 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 des tabindex, il doit être défini pour faciliter la navigation de l'utilisateur.
data-callback callback Facultatif. Nom de votre fonction de rappel exécutée lorsque l'utilisateur envoie une réponse réussie. Le jeton g-recaptcha-response est transmis à votre rappel.
data-expired-callback expired-callback Facultatif. Nom de votre fonction de rappel exécutée lorsque la réponse reCAPTCHA expire et que l'utilisateur doit à nouveau effectuer la validation.
data-error-callback error-callback Facultatif. Nom de votre fonction de rappel exécutée lorsque reCAPTCHA rencontre une erreur (généralement un problème de connectivité réseau) et ne peut pas poursuivre tant que la connectivité n'est pas rétablie. Si vous spécifiez ici une fonction, il vous incombe d'indiquer à l'utilisateur qu'il doit réessayer.