Como receber notificações do Sense

Esta é a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

É possível configurar o Apigee Sense para receber uma lista de solicitações de API detectadas que podem ser indesejadas. Depois que você configurar as notificações, o Apigee Sense enviará um relatório a cada cinco minutos para um URI do webhook especificado.

Usando o URI do webhook, o Apigee Sense vai enviar uma string em formato JSON. Você vai precisar de um código que analise a string para JSON. Este breve exemplo de um relatório foi formatado de string para JSON para facilitar a leitura:

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

O relatório captura as seguintes informações sobre possíveis ataques indesejados às suas APIs:

  • A organização e o ambiente da Apigee em que as solicitações foram coletadas.
  • O carimbo de data/hora do relatório.
  • ID da mensagem do relatório.
  • O número de endereços IP que fazem solicitações indesejadas.

  • Uma matriz dos dados do cliente para os endereços IP que fazem solicitações potencialmente indesejadas (como bots). Para cada cliente, o relatório inclui:

    Característica do cliente Descrição
    ipAddress Endereço IP do cliente.
    botDetectedLast Carimbo de data/hora da solicitação mais recente do cliente.
    ipIsp ISP do cliente que está fazendo solicitações.
    ipCountry País de origem das solicitações do cliente.
    botReason As regras de detecção do Apigee Sense para as quais as solicitações desse endereço IP foram conformedadas.
    callCount Número de solicitações deste endereço IP.
    topUrl O URL mais comum solicitado pelo IP do cliente. Essa é a API solicitada pelo cliente.
    ipCity Cidade em que a solicitação foi recebida.

Para configurar notificações

  1. Abra a nova experiência do Edge.
  2. Na experiência do New Edge, clique no menu Analisar e em Sense.
  3. Clique no menu Configurações.

  4. Na página Configurações, digite valores para configurar as notificações:

    Configuração Descrição
    Notificação Clique para ativar ou desativar a notificação.
    URI O URI que você quer que o Apigee Sense use ao enviar notificações. Normalmente, é um sistema de monitoramento que aceita webhooks de entrada. Os relatórios do Apigee Sense serão enviados para este URI.
    Nome da chave de API Opcional. Nome da chave que o Apigee Sense precisa usar ao se autenticar com seu sistema. Use uma chave de API para melhorar a segurança.
    Valor da chave de API Opcional. Chave-valor que o Apigee Sense deve usar ao autenticar com seu sistema. Use uma chave de API para melhorar a segurança.
    Número máximo de IPs Número máximo (de 1 a 300) de endereços IP do cliente a serem incluídos no relatório. O Apigee Sense vai incluir endereços IP na ordem do número de solicitações suspeitas, do maior para o menor, até o número de IPs especificado aqui.