Audit API Technische Details

Die Vonage Audit API ermöglicht Ihnen die Überwachung Ihres Accounts durch die Verfolgung von Ereignissen. Diese Ereignisse werden erzeugt, wenn Ihre Account-Benutzer mit den SDKs arbeiten oder mit dem Vonage API Dashboard interagieren.

Mit dieser API können Sie:

Ruft eine Liste von Audit-Ereignissen ab.
Rufen Sie ein bestimmtes Audit-Ereignis ab.
Filtern Sie Ereignisse nach Parametern wie Datum, Benutzer-ID und Ereignistyp.

Beta

Diese API befindet sich derzeit im Beta-Stadium.

Vonage freut sich immer über Ihr Feedback. Ihre Vorschläge helfen uns, das Produkt zu verbessern. Wenn Sie Hilfe benötigen, senden Sie bitte eine E-Mail an Unterstützung und geben Sie in der Betreffzeile Audit API an. Bitte beachten Sie, dass die Supportzeiten während der Beta-Phase auf Montag bis Freitag beschränkt sind.

Während der Beta-Phase kann Vonage die Möglichkeiten der Audit-API erweitern.

Inhalt

In diesem Dokument erfahren Sie mehr über:

Authentifizierung

Interaktionen mit der Audit-API werden mit Basic Authentication authentifiziert. Die Basisauthentifizierung ermöglicht Ihnen die Verwendung Ihrer VONAGE_API_KEY und VONAGE_API_SECRET um Ihre API-Anfragen zu validieren. Weitere allgemeine Informationen zur Authentifizierung finden Sie unter Authentifizierung.

Audit-Ereignisse

Audit-Ereignisse sind Aktivitäten, die auftreten, wenn ein Benutzer mit der Vonage API oder dem Vonage API Dashboard interagiert. Audit-Ereignisse werden durch ein JSON-Objekt dargestellt. Beispiele für Audit-Ereignisse sind:

Aktualisierungen der Account-Einstellungen.
Eine Vonage Number wird einer Anwendung zugewiesen.
Erstellung einer Vonage-Anwendung.

Weitere Informationen über die Arten von Audit-Ereignissen finden Sie auf der Seite Audit-Ereignisse Seite.

Audit-Ereignis-Objekt

Ein Beispiel für ein Audit-Ereignis ist die "Aktualisierung einer Nummer", die Folgendes beinhaltet event_type von 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"
  }
}

Erste Schritte

Dieses Beispiel zeigt Ihnen, wie Sie mit der Audit-API beginnen können. Es zeigt, wie man eine Liste von Audit-Ereignissen abruft.

Sie müssen sicherstellen, dass die folgenden ersetzbaren Werte im Beispielcode mit einer geeigneten Methode gesetzt werden:

Schlüssel	Beschreibung
`VONAGE_API_KEY`	Ihr Vonage API-Schlüssel.
`VONAGE_API_SECRET`	Ihr Vonage API-Geheimnis.

Im folgenden Beispiel wird die Erstellen Sie eine Applikation und Initialisieren Sie Ihre Abhängigkeiten Verfahren sind fakultativ.

Voraussetzungen

Eine Vonage-Applikation enthält die erforderliche Konfiguration für Ihr Projekt. Sie können eine Applikation mit Hilfe von Vonage CLI (siehe unten) oder über das Dashboard erstellen. Mehr über Applikationen erfahren Sie unter siehe unseren Vonage Concepts Leitfaden.

Installieren Sie die CLI

npm install -g nexmo-cli

Erstellen Sie eine Applikation

Sobald Sie die CLI installiert haben, können Sie damit eine Vonage-Anwendung erstellen. Führen Sie den folgenden Befehl aus und notieren Sie sich die Anwendungs-ID, die er zurückgibt. Dies ist der Wert, der im folgenden Beispiel in NEXMO_APPLICATION_ID verwendet wird. Es wird auch private.key im aktuellen Verzeichnis erstellt, das Sie im Schritt Initialisieren Sie Ihre Abhängigkeiten benötigen.

Vonage muss sich mit Ihrem lokalen Rechner verbinden, um auf Ihr answer_url zuzugreifen. Wir empfehlen die Verwendung von ngrok für diesen Zweck. Stellen Sie sicher, dass Sie demo.ngrok.io in den folgenden Beispielen in Ihre eigene ngrok-URL ändern.

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

Erstellen Sie eine Datei mit dem Namen get-events.sh und fügen Sie den folgenden Code hinzu:

source "../config.sh"

Vollständige Quelle anzeigen

Schreiben Sie den Code

Fügen Sie Folgendes zu get-events.sh hinzu:

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

Vollständige Quelle anzeigen

Führen Sie Ihren Code aus

Speichern Sie diese Datei auf Ihrem Rechner und führen Sie sie aus:

./get-events.sh

Voraussetzungen

Installieren Sie die CLI

npm install -g nexmo-cli

Erstellen Sie eine Applikation

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

Erstellen Sie eine Datei mit dem Namen get-events.js und fügen Sie den folgenden Code hinzu:

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

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

Vollständige Quelle anzeigen

Schreiben Sie den Code

Fügen Sie Folgendes zu get-events.js hinzu:

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