Recevoir des notifications de Sense

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X.
en savoir plus

Vous pouvez configurer Apigee Sense pour recevoir une liste des requêtes API détectées qui pourraient être indésirables. Une fois que vous avez configuré les notifications, Apigee Sense envoie un rapport toutes les 5 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). Le court exemple suivant de rapport a été formaté de chaîne en JSON pour une meilleure lisibilité:

{
    "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 capture les informations suivantes sur les éventuelles attaques indésirables ciblant vos API:

  • Organisation et environnement Apigee dans lesquels les requêtes signalées ont été collectées.
  • Code temporel du rapport.
  • ID du message du rapport.
  • Nombre d'adresses IP effectuant des requêtes potentiellement indésirables.
  • Tableau des données client pour les adresses IP effectuant des requêtes potentiellement indésirables (comme des bots). Pour chaque client, le rapport comprend les informations suivantes:

    Caractéristiques du client Description
    ipAddress Adresse IP du client.
    botDetectedLast Horodatage de la requête la plus récente du client.
    ipIsp FAI du client qui effectue les 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 client. Il s'agit de l'API demandée par le client.
    ipCity Ville à partir de laquelle la requête a été reçue.

Configurer les notifications

  1. Ouvrez l'expérience New Edge.
  2. Dans l'expérience New Edge, cliquez sur le menu Analyze (Analyser), puis cliquez sur Sense.
  3. Cliquez sur le menu Paramètres.
  4. Sur la page Paramètres, saisissez des valeurs pour configurer les notifications:

    Paramètre Description
    Notification Cliquez pour activer ou désactiver cette notification.
    URI URI que vous souhaitez qu'Apigee Sense utilise lors de l'envoi de 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é qu'Apigee Sense doit utiliser lors de l'authentification auprès de votre système. Utiliser une clé API pour renforcer la sécurité
    Valeur de la clé API Facultatif. Clé-valeur qu'Apigee Sense doit utiliser lors de l'authentification auprès de votre système. Utiliser 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 inclut les adresses IP par ordre de nombre de requêtes suspectes, du nombre de requêtes au moins élevé jusqu'au nombre d'adresses IP que vous spécifiez ici.