Recevoir des notifications de Sense

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X.
info

Vous pouvez configurer Apigee Sense pour qu'il vous envoie une liste des requêtes d'API détectées qui pourraient être indésirables. Une fois les notifications configurées, Apigee Sense envoie un rapport toutes les cinq minutes à un URI de webhook que vous spécifiez.

À l'aide de l'URI du webhook, Apigee Sense envoie une chaîne au format JSON (vous aurez besoin d'un code qui analyse la chaîne au format JSON). Pour plus de lisibilité, le bref exemple de rapport suivant a été converti de chaîne au format JSON:

{
    "text": {
        "metadata": {
            "org": "my-org",
            "env": "prod",
            "reportTimestamp": "2018-10-09T17:25:12Z",
            "messageId": "1539105912220"
        },
        "totalNumberOfBots": 1,
        "bots": [
            {
                "ipAddress": "11.111.111.11",
                "botDetectedLast": "2018-10-0917:04:48Z",
                "ipIsp": "Their ISP",
                "ipCountry": "United States",
                "botReason": [
                    "Flooder",
                    "Content Robber"
                ],
                "callCount": "274529",
                "topUrl": "/v1/my/url",
                "ipCity": "Los Angeles"
            }
        ]
    }
}

Le rapport contient les informations suivantes sur les attaques indésirables potentielles sur vos API:

  • Organisation et environnement Apigee dans lesquels les requêtes signalées ont été collectées.
  • Code temporel du rapport.
  • ID du message de rapport.
  • Nombre d'adresses IP à l'origine de requêtes potentiellement indésirables.
  • Tableau des données client pour les adresses IP à l'origine de requêtes potentiellement indésirables (telles que des bots). Pour chaque client, le rapport inclut les éléments suivants:

    Caractéristique du client Description
    ipAddress Adresse IP du client.
    botDetectedLast Code temporel de la dernière requête du client.
    ipIsp FAI du client à l'origine des requêtes.
    ipCountry Pays d'où proviennent les requêtes du client.
    botReason Règles de détection Apigee Sense auxquelles les requêtes provenant de cette adresse IP étaient conformes.
    callCount Nombre de requêtes provenant de cette adresse IP.
    topUrl URL la plus courante demandée par l'adresse IP du client. Il s'agit de l'API demandée par le client.
    ipCity Ville d'où provient la requête.

Pour configurer les notifications :

  1. Ouvrez la nouvelle expérience Edge.
  2. Dans la nouvelle interface Edge, cliquez sur le menu Analyser, puis sur Sensation.
  3. Cliquez sur le menu Paramètres.
  4. Sur la page Settings (Paramètres), saisissez les valeurs permettant de configurer les notifications:

    Paramètre Description
    Notification Cliquez pour activer ou désactiver cette notification.
    URI URI que vous souhaitez qu'Apigee Sense utilise pour envoyer des notifications. Il s'agit généralement d'un système de surveillance qui accepte les webhooks entrants. Les rapports d'Apigee Sense seront envoyés à cet URI.
    Nom de la clé API Facultatif. Nom de clé que Apigee Sense doit utiliser lors de l'authentification avec votre système. Utilisez une clé API pour renforcer la sécurité.
    Valeur de la clé API Facultatif. Valeur de clé que Apigee Sense doit utiliser lors de l'authentification avec votre système. Utilisez une clé API pour renforcer la sécurité.
    Nombre maximal d'adresses IP Nombre maximal (de 1 à 300) d'adresses IP client à inclure dans le rapport. Apigee Sense inclura les adresses IP par ordre de nombre de requêtes suspectes, du plus grand nombre de requêtes au plus petit, jusqu'au nombre d'adresses IP que vous spécifiez ici.