Utiliser l'API Evaluate

Cette page explique comment utiliser l'API Evaluate pour permettre à vos applications clientes d'évaluer le caractère malveillant d'une URL. Cette API renvoie un score de confiance qui indique le caractère malveillant d'une URL en fonction de listes de blocage, de modèles de machine learning et de règles heuristiques. Si vous souhaitez obtenir un résultat binaire au lieu d'un score de confiance, utilisez l'API Lookup.

Remarque : Toutes les URL envoyées à l'API Evaluate peuvent faire l'objet d'un traitement supplémentaire, y compris d'une exploration.

Avant de commencer

Contactez notre équipe commerciale ou votre ingénieur client pour accéder à cette fonctionnalité.

Évaluation des URL

Pour évaluer une URL, envoyez une requête HTTP POST à la méthode evaluateUri. Tenez compte des considérations suivantes lors de l'évaluation des URL :

  • L'API Evaluate accepte une URL par requête. Si vous souhaitez vérifier plusieurs URL, envoyez une requête distincte pour chacune d'elles.
  • L'URL doit être valide et ne doit pas nécessairement être canonique. Pour en savoir plus, consultez la norme RFC 2396.
  • L'API Evaluate est compatible avec trois threatTypes : SOCIAL_ENGINEERING, MALWARE et UNWANTED_SOFTWARE.
  • Obsolète. Le champ allow_scan permettait de déterminer si Web Risk était autorisé à analyser l'URL fournie. Il n'est désormais plus possible de désactiver cette fonctionnalité dans l'API Evaluate. Consultez les API Lookup et Update pour découvrir les options sans exploration.
  • La réponse HTTP POST renvoie un score de confiance pour le type de menace spécifié. Ce score représente le niveau de confiance indiquant le niveau de risque de l'URL spécifiée.

Requête API

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

URL : URL qui doit être évaluée.

Méthode HTTP et URL :

POST https://webrisk.googleapis.com/v1eap1:evaluateUri?key=API_KEY

Corps JSON de la requête : 

{
  "uri": "URL",
  "threatTypes": ["SOCIAL_ENGINEERING", "MALWARE", "UNWANTED_SOFTWARE"]
}

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 "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://webrisk.googleapis.com/v1eap1:evaluateUri?key=API_KEY"

PowerShell

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

$headers = @{  }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://webrisk.googleapis.com/v1eap1:evaluateUri?key=API_KEY" | Select-Object -Expand Content

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

{
  "scores": [
    {
      "threatType": "MALWARE",
      "confidenceLevel": "EXTREMELY_HIGH"
    },
    {
      "threatType": "SOCIAL_ENGINEERING",
      "confidenceLevel": "SAFE"
    },
    {
      "threatType": "UNWANTED_SOFTWARE",
      "confidenceLevel": "SAFE"
    }
  ]
}