Recuperar eventos de Audit

Puedes recuperar un registro de todos los eventos de auditoría asociados con tu cuenta de Vonage. También puedes filtrar esta lista según las fechas, la palabra clave, el usuario y el tipo de evento.

En este tutorial

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

Requisitos previos

Para realizar este tutorial necesitarás:

  • A Account de Vonage.
  • Una aplicación Terminal en la que pueda escribir o pegar comandos Curl. También puede utilizar Paw, Postman o una aplicación similar.
  • Deberá conocer su VONAGE_API_KEY y VONAGE_API_SECRET que puede obtener en su salpicadero.

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

NOTA: En los ejemplos siguientes, sustituya VONAGE_API_KEY y VONAGE_API_SECRET con los valores reales obtenidos de su salpicadero.

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'

Cuando ejecute este comando recibirá una lista de todos los eventos de Audit.

Recuperar una lista filtrada de eventos de Audit

La lista de eventos de auditoría que recibes en el paso anterior puede ser abrumadora, especialmente si has estado usando tu cuenta de Vonage durante algún tiempo. 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, por defecto 30).

Así, por ejemplo, para filtrar en base a fechas puede 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.

Puede reducir la búsqueda de varias maneras. Por ejemplo, también puede filtrar por tipo de evento de Audit.

Así, por ejemplo, para encontrar eventos de Audit en agosto de 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'

También puede filtrar por 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 conoce el UUID de un evento de auditoría específico, puede recuperar la información de ese objeto de evento de auditoría. Por ejemplo, si el UUID del evento es aaaaaaaa-bbbb-cccc-dddd-0123456789ab entrarías:

$ 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