Vous consultez la documentation Apigee Edge.
Accédez à la
documentation**Apigee X**. info
Vous pouvez configurer Apigee Sense pour qu'il vous envoie une notification contenant une liste des requêtes API détectées qui peuvent être indésirables. Une fois les notifications configurées, Apigee Sense envoie un rapport toutes les cinq minutes à l'URI de webhook que vous spécifiez.
À l'aide de l'URI de webhook, Apigee Sense envoie une chaîne au format JSON (vous aurez besoin d'un code qui analyse la chaîne au format JSON). L'exemple de rapport suivant a été mis en forme de chaîne au format JSON pour des raisons de 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 de vos API :
- L'organisation et l'environnement Apigee dans lesquels les requêtes signalées ont été collectées.
- L'horodatage du rapport.
- L'ID du message de rapport.
- Le nombre d'adresses IP effectuant des requêtes qui peuvent être indésirables.
Un tableau des données client pour les adresses IP effectuant des 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 Horodatage de la dernière requête du client. ipIsp FAI du client effectuant des requêtes. ipCountry Pays d'origine des requêtes du client. botReason Règles de détection d'Apigee Sense auxquelles les requêtes de cette adresse IP sont conformes. callCount Nombre de requêtes provenant de cette adresse IP. topUrl URL la plus courante demandée par l'IP du client. Il s'agit de l'API demandée par le client. ipCity Ville à partir de laquelle la requête a été reçue.
Pour configurer les notifications, procédez comme suit :
- Ouvrez la nouvelle interface Edge.
- Dans la nouvelle interface Edge, cliquez sur le menu Analyze (Analyser), puis sur Sense.
- Cliquez sur le menu Settings (Paramètres).
Sur la page Settings (Paramètres), saisissez des valeurs pour configurer les notifications :
Paramètre Description Notification Cliquez pour activer ou désactiver cette notification. URI URI qu'Apigee Sense doit utiliser 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 la clé qu'Apigee Sense doit utiliser pour s'authentifier auprès de votre système. Utilisez une clé API pour améliorer la sécurité. Valeur de la clé API Facultatif. Valeur de la clé qu'Apigee Sense doit utiliser pour s'authentifier auprès de votre système. Utilisez une clé API pour améliorer la sécurité. Nombre maximal d'adresses IP Nombre maximal (de 1 à 300) d'adresses IP de clients à inclure dans le rapport. Apigee Sense inclut les adresses IP par ordre de nombre de requêtes suspectes, de la plus grande à la plus petite, jusqu'au nombre d'adresses IP que vous spécifiez ici.