Cómo recibir notificaciones de Sense

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X.
Información

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

Con el URI del webhook, Apigee Sense enviará una cadena en formato JSON (necesitarás un código que analice la cadena a JSON). El siguiente ejemplo breve de un informe tiene el 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 donde se recopilaron las solicitudes informadas.
  • La marca de tiempo del informe
  • ID del mensaje de denuncia.
  • La cantidad de direcciones IP que realizan solicitudes que pueden ser no deseadas.
  • Es un array de los datos de cliente para las direcciones IP que realizan solicitudes potencialmente no deseadas (como los 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 Es el ISP del cliente que realiza solicitudes.
    ipCountry País donde se originaron las solicitudes del cliente.
    botReason Las reglas de detección de Apigee Sense a las que se conformaron las solicitudes de esta dirección IP.
    callCount Cantidad de solicitudes de esta dirección IP.
    topUrl La URL más común solicitada por la IP de cliente. Esta es la API que solicita el cliente.
    ipCity Ciudad desde la que se recibió la solicitud.

Cómo configurar las notificaciones

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

    Parámetro de configuración Descripción
    Notificación Haz clic para habilitar o inhabilitar esta notificación.
    URI El URI que quieres que use Apigee Sense cuando envíes 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. El nombre clave que debe usar Apigee Sense durante la autenticación con tu sistema. Usa una clave de API para mejorar la seguridad.
    Valor de la clave de API Opcional. Valor clave que debe usar Apigee Sense durante la autenticación con tu sistema Usa una clave de API para mejorar la seguridad.
    Cantidad máxima de IP Cantidad máxima (de 1 a 300) de direcciones IP de cliente que se deben incluir en el informe. Apigee Sense incluirá las direcciones IP en orden de cantidad de solicitudes sospechosas, desde la mayor cantidad hasta la menor, hasta la cantidad de IP que especifiques aquí.