Obtenir des événements d'audit avec filtrage

Dans cet extrait de code, vous voyez comment obtenir une liste d'événements d'audit avec filtrage.

Paramètres

Vous pouvez filtrer la liste des objets d'événements renvoyés en utilisant des paramètres de requête. Les paramètres qui peuvent être spécifiés sont présentés dans le tableau suivant :

Paramètre d'interrogation	Description
`event_type`	Le type d'événement d'audit, par exemple : `APP_CREATE`, `NUMBER_ASSIGN`et ainsi de suite. Vous pouvez spécifier une liste délimitée par des virgules de types d'événements ici.
`search_text`	Chaîne de recherche compatible JSON. Recherche d'un texte spécifique dans un événement d'audit.
`date_from`	Récupérer les événements d'audit à partir de cette date (au format ISO-8601).
`date_to`	Récupérer les événements d'audit jusqu'à cette date (au format ISO-8601).
`page`	Numéro de page à partir de la page 1.
`size`	Nombre d'éléments par page (entre 1 et 100, par défaut 30).

Exemple

Vous devrez vous assurer que les valeurs remplaçables suivantes sont définies dans le code de l'exemple à l'aide d'une méthode appropriée :

Clé	Description
`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".

Dans l'exemple suivant, le Créer une application et Initialiser vos dépendances sont facultatives.

Conditions préalables

Une application Vonage contient la configuration requise pour votre projet. Vous pouvez créer une application à l'aide de CLI Vonage (voir ci-dessous) ou de via le tableau de bord. Pour en savoir plus sur les applications voir notre guide des concepts Vonage.

Installer le CLI

npm install -g nexmo-cli

Créer une application

Une fois l'interface de programmation installée, vous pouvez l'utiliser pour créer une application Vonage. Exécutez la commande suivante et notez l'identifiant de l'application qu'elle renvoie. C'est la valeur à utiliser dans NEXMO_APPLICATION_ID dans l'exemple ci-dessous. Elle créera également private.key dans le répertoire actuel, dont vous aurez besoin à l'étape Initialiser vos dépendances.

Vonage doit se connecter à votre machine locale pour accéder à votre answer_url. Nous recommandons d'utiliser ngrok pour ce faire. Veillez à remplacer demo.ngrok.io dans les exemples ci-dessous par votre propre URL ngrok.

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

Créez un fichier nommé get-events-with-filtering.sh et ajoutez le code suivant :

source "../config.sh"

Voir la source complète

Rédiger le code

Ajouter ce qui suit à 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"

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

./get-events-with-filtering.sh

Conditions préalables

Installer le CLI

npm install -g nexmo-cli

Créer une application

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

Créez un fichier nommé get-events-with-filtering.js et ajoutez le code suivant :

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

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

Voir la source complète

Rédiger le code

Ajouter ce qui suit à 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();

Voir la source complète

Exécutez votre code

Enregistrez ce fichier sur votre machine et exécutez-le :

node get-events-with-filtering.js

Essayez-le

Exécutez la commande dans un shell. L'appel permet d'obtenir une liste filtrée des événements d'audit.