Obtenir les types d'événements d'audit

Cet extrait de code montre comment obtenir une liste de tous les types d'événements pris en charge.

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

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 Event Types" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

Créez un fichier nommé get-event-types.sh et ajoutez le code suivant :

source "../config.sh"

Voir la source complète

Rédiger le code

Ajouter ce qui suit à get-event-types.sh:

curl -X "OPTIONS" "https://api.nexmo.com/beta/audit/events" \
     -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-event-types.sh

Conditions préalables

Installer le CLI

npm install -g nexmo-cli

Créer une application

nexmo app:create "Get Event Types" 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-event-types.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-event-types.js:

auditClient.getEvent()
  .then((event) => console.log(event))
  .catch((error) => console.error(error));

Voir la source complète

Exécutez votre code

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

node get-event-types.js

Essayez-le

Exécutez la commande dans un shell. L'appel permet d'obtenir une liste des types d'événements d'audit pris en charge, semblable à ce qui suit :

{
  "eventTypes": [
    {
      "type": "USER_STATUS",
      "description": "User status updated"
    },
    {
      "type": "USER_UPDATE",
      "description": "User updated"
    },
    {
      "type": "USER_BILLING_UPDATE",
      "description": "User billing updated"
    },
    {
      "type": "USER_CREATE",
      "description": "User created"
    },
    {
      "type": "USER_LOGIN",
      "description": "User login into Customer dashboard"
    },
    {
      "type": "USER_LOGOUT",
      "description": "User logout from Customer dashboard"
    },
    {
      "type": "USER_PRODUCT_SEARCH",
      "description": "User product search"
    },
    {
      "type": "USER_API_KEYS_UPDATE",
      "description": "Sub-accounts for user updated"
    },
    {
      "type": "ACCOUNT_SECRET_DELETE",
      "description": "Account secret deleted"
    },
    {
      "type": "ACCOUNT_SECRET_CREATE",
      "description": "Account secret created"
    },
    {
      "type": "ACCOUNT_UPDATE_SETTINGS_API",
      "description": "Account Settings updated via API"
    },
    {
      "type": "NUMBER_ASSIGN",
      "description": "Number assigned"
    },
    {
      "type": "NUMBER_UPDATED",
      "description": "Number updated"
    },
    {
      "type": "NUMBER_USER_CANCELED",
      "description": "Number canceled by user"
    },
    {
      "type": "NUMBER_LINKED",
      "description": "Number linked to application"
    },
    {
      "type": "NUMBER_UNLINKED",
      "description": "Number unlinked from application"
    },
    {
      "type": "APP_CREATE",
      "description": "Application created"
    },
    {
      "type": "APP_UPDATE",
      "description": "Application updated"
    },
    {
      "type": "APP_DELETE",
      "description": "Application deleted"
    },
    {
      "type": "APP_DISABLE",
      "description": "Application disabled"
    },
    {
      "type": "APP_ENABLE",
      "description": "Application enabled"
    },
    {
      "type": "IP_WHITELIST_CREATE",
      "description": "Whitelist IP added"
    },
    {
      "type": "IP_WHITELIST_DELETE",
      "description": "Whitelist IP deleted"
    },
    {
      "type": "AUTORELOAD_ENABLE",
      "description": "Automatic reload enabled"
    },
    {
      "type": "AUTORELOAD_UPDATE",
      "description": "Automatic reload settings updated"
    },
    {
      "type": "AUTORELOAD_DISABLE",
      "description": "Automatic reload disabled"
    }
  ]
}