Detalles técnicos de la API de Audit

La API de Audit de Vonage te permite supervisar tu cuenta mediante el seguimiento de eventos. Estos eventos se generan cuando los usuarios de tu cuenta utilizan los SDK o interactúan con el panel de control de la API de Vonage.

Con esta API puedes:

Recuperar una lista de eventos de Audit.
Recuperar un evento de Audit específico.
Filtre los eventos por parámetros como la fecha, el ID de usuario y el tipo de evento.

Beta

Esta API se encuentra actualmente en fase beta.

Vonage siempre agradece tus comentarios. Tus sugerencias nos ayudan a mejorar el producto. Si necesitas ayuda, envía un email a soporte e incluya Audit API en el asunto. Tenga en cuenta que durante el periodo Beta los horarios de asistencia se limitan a lunes a viernes.

Durante el período Beta, Vonage puede ampliar las capacidades de la API de Audit.

Índice

En este documento podrás obtener información sobre:

Autenticación
Eventos de Audit
Objeto de evento de Audit
Cómo empezar a utilizar la API de auditoría
Concepts
Fragmentos de código
Casos prácticos
Referencia

Autenticación

Las interacciones con la API de Audit se autentican utilizando la autenticación básica. La autenticación básica le permite utilizar su VONAGE_API_KEY y VONAGE_API_SECRET para validar sus solicitudes de API. Para obtener más información general sobre la autenticación, consulte Autenticación.

Eventos de Audit

Los eventos de auditoría son actividades que ocurren cuando un usuario interactúa con la API de Vonage o el panel de la API de Vonage. Los eventos de auditoría están representados por un objeto JSON. Algunos ejemplos de eventos de auditoría son:

Actualización de los ajustes de Account.
Un número de Vonage se asigna a una aplicación.
Creación de una aplicación de Vonage.

Para más información sobre los tipos de actos de auditoría, consulte la página Eventos de Audit página.

Objeto de evento de Audit

Un ejemplo de objeto de evento de Audit es «actualización de un número», que tiene event_type de NUMBER_UPDATED:

{
  "_links": {
    "self": {
      "href": "http://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
    }
  },
  "id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
  "event_type": "NUMBER_UPDATED",
  "event_type_description": "Number updated",
  "created_at": "2018-08-13T10:15:31",
  "account_id": "abcd1234",
  "source": "DEVAPI",
  "source_ip": "154.59.142.233",
  "source_description": "Developer API",
  "source_country": "GB",
  "context": {
    "country": "GB",
    "msisdn": "447700900000",
    "voice-type": "sip",
    "voice-value": "sip:user@example12.com",
    "accountId": "abcd1234"
  }
}

Primeros pasos

Este ejemplo te muestra cómo empezar a utilizar la API de Audit. En él se explica cómo recuperar una lista de eventos de Audit.

Tendrá que asegurarse de que los siguientes valores reemplazables se establecen en el código de ejemplo utilizando cualquier método conveniente:

Clave	Descripción
`VONAGE_API_KEY`	Tu clave API de Vonage.
`VONAGE_API_SECRET`	Tu clave secreta de la API de Vonage.

En el siguiente ejemplo, el Crear una solicitud y Inicializa tus dependencias son opcionales.

Requisitos previos

Una aplicación de Vonage contiene la configuración necesaria para tu proyecto. Puedes crear una aplicación usando CLI de Vonage (ver a continuación) o a través del cuadro de mandos. Para obtener más información sobre las aplicaciones consulta nuestra guía de conceptos de Vonage.

Instalar la CLI

npm install -g nexmo-cli

Crear una aplicación

Una vez que tengas la CLI instalada, puedes usarla para crear una aplicación de Vonage. Ejecuta el siguiente comando y anota el ID de aplicación que devuelve. Este es el valor a usar en NEXMO_APPLICATION_ID en el ejemplo de abajo. También creará private.key en el directorio actual, que necesitarás en el paso Inicialice sus dependencias.

Vonage necesita conectarse a tu máquina local para acceder a tu answer_url. Recomendamos usar ngrok para hacerlo. Asegúrate de cambiar demo.ngrok.io en los ejemplos a continuación por tu propia URL de ngrok.

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

Crea un archivo llamado get-events.sh y añade el siguiente código:

source "../config.sh"

Ver fuente completa

Escriba el código

Añada lo siguiente a get-events.sh:

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

Ver fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

./get-events.sh

Requisitos previos

Instalar la CLI

npm install -g nexmo-cli

Crear una aplicación

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

npm install @vonage/audit

Crea un archivo llamado get-events.js y añade el siguiente código:

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

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

Ver fuente completa

Escriba el código

Añada lo siguiente a get-events.js:

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