Recuperar eventos de Audit

Puedes consultar un registro de todos los eventos de Audit asociados a tu cuenta de Vonage. También puedes filtrar esta lista por fechas, palabras clave, usuario y tipo de evento.

En este tutorial

Verá cómo recuperar una lista filtrada de eventos de auditoría:

Requisitos previos

Para seguir este tutorial, necesitarás:

  • A Account de Vonage.
  • Una aplicación de Terminal en la que puedes escribir o pegar comandos de Curl. También puedes utilizar Paw, Postman o una aplicación similar.
  • Tendrás que saber tu VONAGE_API_KEY y VONAGE_API_SECRET que puede obtener en su cuadro de mando.

También puede consultar el Documentación de la API de Audit.

NOTA: En los ejemplos que aparecen a continuación, sustituye VONAGE_API_KEY y VONAGE_API_SECRET con los valores reales obtenidos de su cuadro de mando.

Recuperar una lista de eventos de Audit

Para recibir una lista de todos los eventos de Audit introduzca lo siguiente en su terminal:

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

Al ejecutar este comando, obtendrás una lista de todos los eventos de Audit.

Recuperar una lista filtrada de eventos de Audit

Es muy posible que la lista de eventos de Audit que recibas en el paso anterior te resulte abrumadora, sobre todo si llevas ya algún tiempo utilizando tu cuenta de Vonage. Puedes filtrar esta lista según varios parámetros:

Parámetro de consulta Descripción
event_type El tipo de evento de Audit, por ejemplo: APP_CREATE, NUMBER_ASSIGNetc. Puede especificar una lista delimitada por comas de tipos de eventos aquí.
search_text Cadena de búsqueda compatible con JSON. Busque un texto específico en un evento de Audit.
date_from Recuperar eventos de Audit a partir de esta fecha (en formato ISO-8601).
date_to Recuperar eventos de Audit hasta esta fecha (en formato ISO-8601).
page Número de página a partir de la página 1.
size Número de elementos por página (entre 1 y 100; valor predeterminado: 30).

Así, por ejemplo, para filtrar por fechas, puedes introducir el siguiente 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'

Esto devolverá todos los eventos de auditoría que ocurrieron durante agosto de 2018.

Puedes acotar aún más la búsqueda de varias formas. Por ejemplo, también puedes filtrar según tipo de evento de Audit.

Así, por ejemplo, para buscar eventos de Audit del mes de agosto del tipo NUMBER_ASSIGN podrías introducir lo siguiente:

$  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'

Puedes filtrar aún más según search_text. Por ejemplo, para encontrar todos los eventos de Audit que contengan el texto "password" puede introducir el siguiente comando:

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

Recuperar un evento de Audit específico

Si conoces el UUID de un evento de Audit concreto, puedes recuperar la información correspondiente a ese objeto de evento de Audit. Por ejemplo, si el UUID del evento es aaaaaaaa-bbbb-cccc-dddd-0123456789ab deberías escribir:

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

Esto devolvería el objeto de evento de auditoría JSON para el evento de auditoría especificado.

Conclusión

Utilizando las capacidades de filtrado de la API de Audit, usted tiene un control total sobre los eventos de auditoría que recupera.

Recursos