Détails techniques de l'API Audit

L'API Audit de Vonage vous permet de surveiller votre Account en suivant les événements. Ces événements sont générés lorsque les utilisateurs de votre Account travaillent avec les SDK ou interagissent avec le tableau de bord API de Vonage.

Avec cette API, vous pouvez :

Récupérer une liste d'événements d'Audit.
Récupérer un événement d'Audit spécifique.
Filtrer les événements en fonction de paramètres tels que la date, l'identifiant de l'utilisateur et le type d'événement.

Bêta

Cette API est actuellement en version bêta.

Vonage est toujours heureux de recevoir vos commentaires. Vos suggestions nous aident à améliorer le produit. Si vous avez besoin d'aide, veuillez envoyer un courriel à soutien en mentionnant Audit API dans la ligne d'objet. Veuillez noter que pendant la période bêta, l'assistance est limitée au lundi et au vendredi.

Pendant la période bêta, Vonage peut étendre les capacités de l'API d'Audit.

Contenu

Dans ce document, vous trouverez des informations sur

Authentification

Les interactions avec l'API Audit sont authentifiées à l'aide de l'authentification de base. L'authentification de base vous permet d'utiliser votre VONAGE_API_KEY et VONAGE_API_SECRET pour valider vos demandes d'API. Pour plus d'informations générales sur l'authentification, voir Authentification.

Événements relatifs à l'audit

Les événements d'audit sont des activités qui se produisent lorsqu'un utilisateur interagit avec l'API de Vonage ou le tableau de bord de l'API de Vonage. Les événements d'audit sont représentés par un objet JSON. Les exemples d'événements d'audit comprennent :

Mise à jour des paramètres du compte.
Un numéro Vonage est attribué à une application.
Création d'une application Vonage.

De plus amples informations sur les types d'événements liés à l'audit sont disponibles sur le site web de la Commission européenne. Événements relatifs à l'audit page.

Objet de l'événement d'audit

Un exemple d'objet d'événement d'audit est la "mise à jour d'un nombre", qui a la forme suivante 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"
  }
}

Pour commencer

Cet exemple vous montre comment commencer à utiliser l'API Audit. Il montre comment récupérer une liste d'événements d'audit.

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`	Votre clé API Vonage.
`VONAGE_API_SECRET`	Votre secret API Vonage.

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

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

source "../config.sh"

Voir la source complète

Rédiger le code

Ajouter ce qui suit à get-events.sh:

curl "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-events.sh

Conditions préalables

Installer le CLI

npm install -g nexmo-cli

Créer une application

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

Créez un fichier nommé get-events.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.js:

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