Obter eventos de Audit com filtragem

Neste trecho de código, você vê como obter uma lista de eventos de Audit com filtragem.

Parâmetros

É possível filtrar a lista de objetos de evento retornada usando parâmetros de consulta. Os parâmetros que podem ser especificados estão indicados na tabela a seguir:

Parâmetro de consulta	Descrição
`event_type`	O tipo do evento de Audit, por exemplo: `APP_CREATE`, `NUMBER_ASSIGN`, e assim por diante. Você pode especificar uma lista delimitada por vírgulas de tipos de eventos aqui.
`search_text`	String de pesquisa compatível com JSON. Procure um texto específico em um evento de Audit.
`date_from`	Recuperar eventos de Audit a partir desta data (no formato ISO-8601).
`date_to`	Recuperar eventos de Audit até esta data (no formato ISO-8601).
`page`	Numeração de páginas a partir da página 1.
`size`	Número de elementos por página (entre 1 e 100; valor padrão: 30).

Exemplo

Você precisará garantir que os seguintes valores substituíveis sejam definidos no código de exemplo, utilizando qualquer método que lhe seja conveniente:

Chave	Descrição
`VONAGE_API_KEY`	Your Vonage API key (see it on your dashboard).
`VONAGE_API_SECRET`	Your Vonage API secret (also available on your dashboard).
`SEARCH_TEXT`	Some JSON compatible text to search for. For example, "number".
`DATE_FROM`	Audit events starting from this ISO-8601 datetime value. For example, "2018-07-01".
`DATE_TO`	Audit events up to this ISO-8601 datetime value. For example, "2018-08-01".

No exemplo a seguir, o Criar um aplicativo e Inicialize suas dependências Os procedimentos são opcionais.

Pré-requisitos

Um aplicativo da Vonage contém a configuração necessária para o seu projeto. Você pode criar um aplicativo usando o CLI da Vonage (veja abaixo) ou pelo painel de controle. Para saber mais sobre os aplicativos, acesse consulte nosso guia de conceitos da Vonage.

Instale a CLI

npm install -g nexmo-cli

Criar um aplicativo

Depois de instalar a CLI, você poderá usá-la para criar um aplicativo Vonage. Execute o comando a seguir e anote o ID do aplicativo que for retornado. Esse é o valor que deve ser usado em NEXMO_APPLICATION_ID no exemplo abaixo. Isso também criará o arquivo private.key no diretório atual, que você precisará na etapa Inicialize suas dependências

O Vonage precisa se conectar ao seu computador local para acessar o answer_url. Recomendamos usar o ngrok para fazer isso. Certifique-se de substituir demo.ngrok.io nos exemplos abaixo pelo seu próprio URL do ngrok.

nexmo app:create "Get Events with filtering" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

Crie um arquivo chamado ` get-events-with-filtering.sh ` e insira o seguinte código:

source "../config.sh"

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao arquivo ` get-events-with-filtering.sh`:

curl "https://api.nexmo.com/beta/audit/events?search_text=$SEARCH_TEXT&date_from=$DATE_FROM&date_to=$DATE_TO" \
     -u "$VONAGE_API_KEY:$VONAGE_API_SECRET"

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

./get-events-with-filtering.sh

Pré-requisitos

Instale a CLI

npm install -g nexmo-cli

Criar um aplicativo

nexmo app:create "Get Events with filtering" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

npm install @vonage/audit

Crie um arquivo chamado ` get-events-with-filtering.js ` e insira o seguinte código:

const { Audit } = require('@vonage/audit');

const auditClient = new Audit({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET,
});

Ver código-fonte completo

Escreva o código

Adicione o seguinte ao arquivo ` get-events-with-filtering.js`:

const run = async () => {
  const filter = {
    dateFrom: DATE_FROM,
    dateTo: DATE_TO,
    searchText: SEARCH_TEXT,
  };

  try {
    for await (const event of auditClient.getEvents(filter)) {
      console.log(event);
    }
  } catch (error) {
    console.log(error);
  }
};
run();

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

node get-events-with-filtering.js

Experimente

Execute o comando em um shell. A chamada irá recuperar uma lista filtrada de eventos de Audit.