Créer des clés reCAPTCHA

Cette page explique comment créer des clés reCAPTCHA, appelées clés de site, pour vérifier les interactions des utilisateurs sur vos pages Web et vos applications mobiles.

Les clés de site reCAPTCHA représentent la façon dont reCAPTCHA Enterprise est configuré pour un site ou une application. La configuration inclut des options importantes telles que l'affichage ou non des tests CAPTCHA. Les clés de site reCAPTCHA sont différentes des clés API.

Avant de commencer

  1. Choisissez la meilleure méthode pour configurer reCAPTCHA Enterprise dans votre environnement et terminez la configuration.

  2. Choisissez le type de clé approprié.

  3. Les clés de site reCAPTCHA pour applications mobiles (clés mobiles) sont accessibles après un examen de sécurité. Contactez notre équipe commerciale pour activer cette fonctionnalité sur votre site.

Créer une clé de site

Vous pouvez créer un nombre illimité de clés reCAPTCHA pour un projet. Il est préférable de créer une clé reCAPTCHA par site Web ou application mobile.

Créez des clés de site distinctes pour les environnements de préproduction et de production. Sinon, vous risquez de interroger l'analyse des risques reCAPTCHA avec les données de votre environnement de test.

Le moyen le plus simple de créer une clé de site est de passer par Cloud Console. Vous pouvez également utiliser l'API reCAPTCHA Enterprise ou l'outil de ligne de commande gcloud.

Console

  1. Dans Cloud Console, accédez à la page reCAPTCHA Enterprise.

    Accéder à reCAPTCHA Enterprise

  2. Vérifiez que le nom de votre projet apparaît dans le sélecteur de ressources en haut de la page.

    Si le nom de votre projet ne s'affiche pas, cliquez sur le sélecteur de ressources, puis sélectionnez votre projet.

  3. Cliquez sur Créer une clé.

  4. Dans le champ Nom à afficher, saisissez un nom à afficher pour la clé.
  5. Créez une clé pour un site Web ou une plate-forme mobile. Pour obtenir des instructions, développez la section correspondant à votre plate-forme.

    Créer des clés pour les sites Web

    Vous pouvez créer des cases à cocher et des clés de site basées sur le score pour les sites Web.

    1. Dans le menu déroulant Sélectionner le type de plate-forme, sélectionnez Site Web.

      La section Liste de domaines s'affiche.

    2. Saisissez le nom de domaine de votre site Web:

      1. Dans la section Liste de domaines, cliquez sur Ajouter un domaine.

      2. Dans le champ Domaine, saisissez le nom de votre domaine.
      3. Facultatif: Pour ajouter un domaine, cliquez sur Ajouter un domaine, puis saisissez le nom d'un autre domaine dans le champ Domaine. Vous pouvez ajouter jusqu'à 250 domaines.

        Pour les sites Web, la clé de site reCAPTCHA est propre aux domaines et aux sous-domaines de premier niveau que vous spécifiez. Vous pouvez spécifier plusieurs domaines si vous diffusez votre site Web à partir de plusieurs domaines de premier niveau. Par exemple, examplepetstore.com est votre domaine et subdomain.examplepetstore.com et another-subdomain.examplepetstore.com sont des sous-domaines.

    3. Pour protéger la clé de site reCAPTCHA pour votre domaine et vos sous-domaines, assurez-vous que l'option Valider les domaines est sélectionnée.

      Si vous ne sélectionnez pas cette option, cela présente un risque de sécurité, car votre clé reCAPTCHA est accessible et utilisée par tout le monde, car votre site ne dispose d'aucune restriction.

    4. Dans le menu déroulant Type d'intégration, sélectionnez le type de clé approprié.

    5. Selon le type d'intégration que vous avez sélectionné, effectuez l'action appropriée :
      • Si vous avez sélectionné l'option Score, sans défi visible pour vos utilisateurs (recommandé), vous pouvez éventuellement autoriser cette clé à fonctionner avec les pages AMP (Accelerated Mobile Pages).
      • Si vous avez sélectionné l'option Case à cocher "Je ne suis pas un robot") avec attribution de scores, sélectionnez l'option Question d'authentification appropriée.

        L'option "Sécurité du défi" permet de contrôler la probabilité pour qu'un utilisateur soit invité à choisir une image secondaire selon une catégorie identifiée (par exemple, sélectionnez les images avec une moto ou escalier). ).

        Si vous souhaitez garantir la meilleure protection antifraude, sélectionnez Mise en œuvre plus difficile (sécurité renforcée contre les bots).

        Si vous sélectionnez La plus difficile d'authentification, les utilisateurs sont moins susceptibles d'être invités à choisir la question d'authentification visuelle.

    6. Cliquez sur Créer une clé.

    La nouvelle clé est répertoriée sur la page Clés reCAPTCHA.

    Créer des clés pour les applications mobiles

    Vous ne pouvez créer que des clés de site basées sur le score pour les applications mobiles.

    1. Dans leChoisir le type de plate-forme dans le menu déroulant, sélectionnezapplication Android ouApplication iOS .
    2. Selon la plate-forme sélectionnée, saisissez les packages Android ou les ID de groupe iOS.

      Si vous avez sélectionné Application Android, procédez comme suit:

      1. Dans la section Android package list (Liste des packages Android), cliquez sur Add Android package (Ajouter un package Android).
      2. Dans le champ Package Android, saisissez le nom de votre package Android.

      3. Facultatif: Pour ajouter un package supplémentaire, cliquez sur Ajouter un package Android et saisissez le nom d'un autre package Android dans le champ Package Android.

      Si vous avez sélectionné l'application iOS, procédez comme suit:

      1. Dans la section Liste des ID de groupe iOS, cliquez sur Ajouter un ID de groupe iOS.
      2. Dans le champ ID de groupe, saisissez le nom de votre ID de groupe iOS.

      3. Facultatif: Pour ajouter un ID de groupe supplémentaire, cliquez sur Add iOS bundle ID (Ajouter un ID de groupe iOS), puis saisissez le nom de votre ID de groupe iOS dans le champ Bundle ID (ID du groupe iOS).

      Pour les applications mobiles, la clé de site reCAPTCHA est unique aux noms de package spécifiés (par exemple, com.google.recaptcha.test).

    3. Cliquez sur Créer une clé.

    La nouvelle clé est répertoriée sur la page Clés reCAPTCHA.

API REST et ligne de commande

Pour obtenir des informations de référence sur les types de clés et les types d'intégration, consultez les pages Clé et Type d'intégration.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • PROJECT_ID : ID de votre projet Google Cloud.
  • DISPLAY_NAME: nom à afficher pour la clé
  • DOMAINS (pour les sites Web uniquement): domaines ou sous-domaines de sites Web autorisés à utiliser la clé. Spécifiez plusieurs domaines sous forme de liste en les séparant par une virgule.
  • TYPE_OF_INTEGRATION (pour les sites Web uniquement): SCORE ou CHECKBOX.
  • PACKAGE_NAMES (pour les applications Android uniquement): noms de package Android des applications autorisées à utiliser la clé Spécifiez plusieurs noms de package sous forme de liste en les séparant par une virgule.
  • BUNDLE_IDs (pour les applications iOS uniquement): identifiants de groupe iOS des applications autorisées à utiliser la clé. Spécifiez plusieurs ID de groupe sous forme de liste en les séparant par une virgule.

Méthode HTTP et URL :

POST https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys

Corps JSON de la requête :


To create keys for websites:

{
  "displayName": "DISPLAY_NAME",
  "webSettings": {
    "allowedDomains": "DOMAINS",
    "integrationType": "TYPE_OF_INTEGRATION"
  }
}

To create keys for Android apps:

{
  "displayName": "DISPLAY_NAME",
  "androidSettings": {
  "allowedPackageNames":"PACKAGE_NAMES"
  }
}

To create keys for iOS apps:

{
  "displayName": "DISPLAY_NAME",
  "iosSettings": {
   "allowedBundleIds":"BUNDLE_IDs"

  }
}

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

curl -X POST \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys

PowerShell

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante :

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
-Method POST `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON de ce type :

{
  "name": "projects/project-id/keys/6Ldqgs0UAAAAAIn4k7YxEB-LwEh5S9-Gv6IIWB8m",
  "displayName": "DISPLAY_NAME",
  "webSettings": {
    "allowAllDomains": false,
    "allowedDomains": [
      DOMAINS
    ],
    "allowAmpTraffic": false,
    "integrationType": "SCORE",
    "challengeSecurityPreference": "CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED"
  }
}

gcloud

Exécutez la commande gcloud alpha recaptcha keys create comme indiqué dans les exemples suivants:

  • Pour créer des clés pour des sites Web, utilisez la commande suivante:

    gcloud alpha recaptcha keys create \
      --web \
      --display-name=DISPLAY_NAME  \
      --integration-type=INTEGRATION_TYPE \
      --domains=DOMAINS
    

    Indiquez les valeurs suivantes :

    • DISPLAY_NAME: nom de la clé Généralement, un nom de site.
    • INTEGRATION_TYPE: type d'intégration, SCORE ou CHECKBOX.
    • DOMAINS: domaines ou sous-domaines de sites Web autorisés à utiliser la clé. Spécifiez plusieurs domaines sous forme de liste en les séparant par une virgule.

  • Pour créer des clés pour les applications Android, utilisez la commande suivante:

    gcloud alpha recaptcha keys create \
      --android --package-names=PACKAGE_NAMES \
      --display-name=DISPLAY_NAME
    

    Indiquez les valeurs suivantes :

    • DISPLAY_NAME: nom de la clé Généralement, un nom d'application.
    • PACKAGE_NAMES: noms de package Android des applications autorisées à utiliser la clé Spécifiez plusieurs noms de package sous forme de liste en les séparant par une virgule.
  • Pour créer une clé pour les applications iOS, utilisez la commande suivante:

    gcloud alpha recaptcha keys create \
      --ios --bundle-ids=BUNDLE_IDS \
      --display-name=DISPLAY_NAME
    

    Indiquez les valeurs suivantes :

    • DISPLAY_NAME: nom de la clé Généralement, un nom d'application.
    • BUNDLE_IDS: ID de groupe iOS des applications autorisées à utiliser la clé. Spécifiez plusieurs ID de groupe sous forme de liste en les séparant par une virgule.

L'exemple suivant montre le résultat de la création d'une clé à l'aide de la commande gcloud alpha recaptcha keys create.

  Created [6Ld3howaAAAAAFYDMsLz2nWFXhsnmBjdrBra5_Bq].

Étape suivante