Como receber notificações do Sense

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

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

Usando o URI de webhook, o Apigee Sense enviará uma string no formato JSON. Você precisará de um código que analise a string para JSON. O exemplo breve a seguir 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 informadas foram coletadas.
• O carimbo de data/hora do relatório.
• O ID da mensagem do relatório.
• O número de endereços IP que fazem solicitações que podem ser 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 faz solicitações.
  ipCountry	País de origem das solicitações do cliente.
  botReason	As regras de detecção do Apigee Sense às quais as solicitações desse endereço IP estavam em conformidade.
  callCount	Número de solicitações desse endereço IP.
  topUrl	O URL mais comum solicitado pelo IP do cliente. Essa é a API solicitada pelo cliente.
  ipCity	Cidade de onde a solicitação foi recebida.

Para configurar notificações, siga estas etapas:

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

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

   Configuração	Descrição
   Notificação	Clique para ativar ou desativar essa notificação.
   URI	O URI que você quer que o Apigee Sense use ao enviar notificações. Normalmente, esse é um sistema de monitoramento que aceita webhooks recebidos. Os relatórios do Apigee Sense serão enviados para esse URI.
   Nome da chave de API	Opcional. Nome da chave que o Apigee Sense precisa usar ao fazer a autenticação com seu sistema. Use uma chave de API para melhorar a segurança.
   Valor da chave de API	Opcional. Valor da chave que o Apigee Sense precisa usar ao fazer a autenticação 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 número de solicitações, até o número de IPs especificado aqui.