Audit APIの技術的詳細

Vonage Audit APIを使用すると、イベントを追跡してアカウントを監視することができます。これらのイベントは、アカウント・ユーザがSDKを使用したり、Vonage API Dashboardとやり取りする際に生成されます。

このAPIを使えば、次のことができる：

• Audit イベントのリストを取得します。
• 特定の Audit イベントを取得します。
• 日付、ユーザーID、イベントタイプなどのパラメータでイベントをフィルタリングします。

ベータ

このAPIは現在ベータ版です。

Vonageは常にお客様のフィードバックをお待ちしております。お客様のご意見は製品の改善に役立ちます。サポートが必要な場合は、Eメール サポート 件名に Audit API とご記入ください。ベータ期間中のサポートは月曜日から金曜日までとさせていただきます。

ベータ期間中、Vonage は Audit API の機能を拡張する可能性があります。

内容

この文書では、以下について学ぶことができる：

• 認証
• 監査イベント
• Audit イベントオブジェクト
• Audit APIを使い始める方法
• Concepts
• コード・スニペット
• 使用例
• 参考

認証

Audit APIとのやり取りは、Basic認証を使用して認証されます。ベーシック認証では VONAGE_API_KEY そして VONAGE_API_SECRET を使用してAPIリクエストを検証します。認証に関する一般的な情報は 認証.

監査イベント

Audit イベントは、ユーザが Vonage API または Vonage API Dashboard とやり取りする際に発生するアクティビティです。Audit イベントは JSON オブジェクトで表されます。監査イベントの例には以下が含まれます：

• アカウント設定の更新。
• Vonage Numbersはアプリケーションに割り当てられます。
• Vonageアプリケーションの作成。

Auditイベントの種類に関する詳細な情報は、「Auditイベントの種類」を参照されたい。 監査イベント ページを参照されたい。

Audit イベントオブジェクト

監査イベント・オブジェクトの例としては、「数字の更新」がある。 event_type の 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"
  }
}

はじめに

この例では、Audit API を使い始める方法を示します。監査イベントのリストを取得する方法を示します。

以下の置換可能な値が、便利な方法でサンプルコードに設定されていることを確認する必要があります：

source "../config.sh"

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

npm install @vonage/audit

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

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

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

Concepts

• 監査イベント: 監査イベントの概念（監査イベントの種類と構造を含む）。

コード・スニペット

• フィルタリングによる監査イベントの取得
• 監査イベントの取得
• 監査イベントの取得
• 監査イベントの種類を取得する

使用例

• 監査イベントの取得

また、次のようなブログ記事もある。 Pythonを使ったAudit APIでアプリケーションを監視する 役に立つかもしれない。

参考

• Audit API リファレンス