Cómo recibir notificaciones de Sense

Estás viendo la documentación de Apigee Edge.
Ve a la documentación de Apigee X.
info

Puedes configurar Apigee Sense para que te notifique con una lista de solicitudes de API detectadas que podrían ser no deseadas. Una vez que hayas configurado las notificaciones, Apigee Sense enviará un informe cada 5 minutos a un URI de webhook que especifiques.

Con el URI delwebhook, Apigee Sense enviará una cadena en formato JSON (necesitarás código que analice la cadena en JSON). El siguiente ejemplo breve de un informe se convirtió de formato de cadena a JSON para facilitar la lectura:

{
    "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"
            }
        ]
    }
}

El informe captura la siguiente información sobre posibles ataques no deseados a tus APIs:

  • La organización y el entorno de Apigee en los que se recopilaron las solicitudes informadas
  • La marca de tiempo del informe.
  • Es el ID del mensaje del informe.
  • Es la cantidad de direcciones IP que realizan solicitudes que podrían no ser deseadas.
  • Es un array de los datos del cliente para las direcciones IP que realizan solicitudes potencialmente no deseadas (como bots). Para cada cliente, el informe incluye lo siguiente:

    Característica del cliente Descripción
    ipAddress Dirección IP del cliente.
    botDetectedLast Marca de tiempo de la solicitud más reciente del cliente.
    ipIsp ISP del cliente que realiza solicitudes.
    ipCountry Es el país donde se originaron las solicitudes del cliente.
    botReason Las reglas de detección de Apigee Sense a las que se ajustaron las solicitudes de esta dirección IP
    callCount Cantidad de solicitudes de esta dirección IP.
    topUrl La URL más común que solicitó la IP del cliente. Esta es la API que solicitó el cliente.
    ipCity Es la ciudad desde la que se recibió la solicitud.

Para configurar las notificaciones, haz lo siguiente:

  1. Abre la Nueva experiencia de Edge.
  2. En la nueva experiencia de Edge, haz clic en el menú Analizar y, luego, en Sensor.
  3. Haz clic en el menú Configuración.
  4. En la página Configuración, ingresa los valores para configurar las notificaciones:

    Configuración Descripción
    Notificación Haz clic para habilitar o inhabilitar esta notificación.
    URI Es el URI que deseas que Apigee Sense use cuando envíe notificaciones. Por lo general, es un sistema de supervisión que acepta webhooks entrantes. Los informes de Apigee Sense se enviarán a este URI.
    Nombre de la clave de API Opcional. Es el nombre de clave que Apigee Sense debe usar cuando se autentica con tu sistema. Usa una clave de API para mejorar la seguridad.
    Valor de la clave de API Opcional. Es el valor clave que Apigee Sense debe usar cuando se autentica con tu sistema. Usa una clave de API para mejorar la seguridad.
    Cantidad máxima de IP Es la cantidad máxima (de 1 a 300) de direcciones IP de cliente que se incluirán en el informe. Apigee Sense incluirá las direcciones IP en orden de cantidad de solicitudes sospechosas, de la mayor a la menor, hasta la cantidad de IPs que especifiques aquí.