Recuperar eventos de Audit

Você pode acessar um registro de todos os eventos de auditória associados à sua conta da Vonage. Também é possível filtrar essa lista por data, palavra-chave, usuário e tipo de evento.

Neste tutorial

Você verá como recuperar uma lista filtrada de eventos de Audit:

Pré-requisitos

Para seguir este tutorial, você precisará de:

  • A Account da Vonage.
  • Um aplicativo de Terminal em execução, no qual você pode digitar ou colar comandos do Curl. Como alternativa, você pode usar o Paw, o Postman ou um aplicativo semelhante.
  • Você precisará saber o seu VONAGE_API_KEY e VONAGE_API_SECRET que você pode obter junto ao seu painel de controle.

Você também pode consultar o Documentação da API de Audit.

NOTA: Nos exemplos a seguir, substitua VONAGE_API_KEY e VONAGE_API_SECRET com valores reais obtidos a partir do seu painel de controle.

Recuperar uma lista de eventos de Audit

Para receber uma lista de todos os eventos de Audit, digite o seguinte no seu terminal:

curl "https://api.nexmo.com/beta/audit/events" \ -u 'VONAGE_API_KEY:VONAGE_API_SECRET'

Ao executar este comando, você receberá uma lista de todos os eventos de Audit.

Recuperar uma lista filtrada de eventos de Audit

A lista de eventos de Audit que você recebe na etapa anterior pode parecer um pouco assustadora, especialmente se você já usa sua conta da Vonage há algum tempo. Você pode filtrar essa lista com base em vários parâmetros:

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).

Por exemplo, para filtrar com base em datas, você pode digitar o seguinte comando:

$ curl "https://api.nexmo.com/beta/audit/events?date_from=2018-08-01&date_to=2018-08-31" \
     -u 'VONAGE_API_KEY:VONAGE_API_SECRET'

Isso retornará todos os eventos de Audit ocorridos durante o mês de agosto de 2018.

Você pode refinar ainda mais essa seleção de várias maneiras. Por exemplo, você também pode filtrar com base em tipo de evento de Audit.

Por exemplo, para localizar eventos de Audit ocorridos em agosto do tipo NUMBER_ASSIGN você poderia inserir o seguinte:

$  curl "https://api.nexmo.com/beta/audit/events?date_from=2018-08-01&date_to=2018-08-31&event_type=NUMBER_ASSIGN" \
     -u 'VONAGE_API_KEY:VONAGE_API_SECRET'

Você pode filtrar ainda mais com base em search_text. Por exemplo, para localizar todos os eventos de Audit que contenham o texto “senha”, você pode digitar o seguinte comando:

$  curl "https://api.nexmo.com/beta/audit/events?search_text=password" \
     -u 'VONAGE_API_KEY:VONAGE_API_SECRET'

Recuperar um evento de auditagem específico

Se você souber o UUID de um evento de Audit específico, poderá recuperar as informações desse objeto de evento de Audit. Por exemplo, se o UUID do evento for aaaaaaaa-bbbb-cccc-dddd-0123456789ab você digitaria:

$ curl "https://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab" \
     -u 'VONAGE_API_KEY:VONAGE_API_SECRET'

Isso retornaria, então, o objeto JSON do evento de Audit correspondente ao evento de Audit especificado.

Conclusão

Ao utilizar os recursos de filtragem da API de Audit, você tem controle total sobre os eventos de auditoria que recupera.

Recursos