Verify移行ガイド

Verifyからの移行は、以下のガイドを参考にしてください。 レガシー への Verify.このためには、新しいバージョンを呼び出すようにエンドポイントURLを更新し、アプリケーションの設定を変更する必要があります。Verifyの使用を開始するために、事前登録フォームに入力する必要はありません。

概要

Vonage Verify API は、開発者が二要素認証 (2FA) を実装し、不正行為から保護し、ユーザの信頼性を確保できるようにするサービスです。 VonageはこのAPIに2つのバージョンを提供しています：レガシーと現在のVerifyである。両方のバージョンは同じ主な機能を果たしますが、その特徴、機能、および 両者の特徴、機能、使用方法には大きな違いがある。

大きな違い

• 柔軟性とカスタマイズ:Verifyは、レガシーと比較して、より柔軟なワークフロー作成と、より機能豊富なカスタムテンプレート管理システムなどの強化されたカスタマイズオプションを提供します。
• チャンネルサポート:Verifyには、Silent Auth、RCS、WhatsApp、Eメールなど、様々な新しいチャネルを通じた認証のサポートが追加されました。
• セキュリティ機能:Verifyには、セキュリティ機能の向上と最新規格への準拠が含まれるようになりました。
• 詐欺防止:ベリファイ・レガシーから新しいベリファイAPIに移行した顧客は、以下の保護とアクセスを得ることができる。 Vonage Fraud Defender Advanced 追加料金なし。
• エラー処理:Verifyは、より詳細なエラーメッセージを提供し、より高度なレート制限や自動再試行メカニズムなど、ハンドリングが改善されました。
• APIの設計と統合:Verifyは同期と非同期の両方の統合パターンをサポートしています。

機能比較

APIコール

非同期モードがVerifyに導入され、メッセージやコールステータスをWebhookで受信できるようになりました。 whatsapp_interactive)およびサマリー・コールバックを使用する。また redirect_url そして check_url.

のApplicationセクションでVerifyコールバック用のWebhookを設定する必要があります。 顧客ダッシュボード:

ウェブフックに関する詳しいドキュメントは以下をご覧ください。 これ.

エンドポイント

Verify APIコールはすべて、新しいエンドポイントを使用するように更新する必要があります：

ワークフロー

Verifyは、レガシーの固定されたワークフローとは対照的に、独自のワークフローを定義する柔軟性を提供します。ワークフローでは、お好きなサポート・チャンネルの組み合わせを、最大3チャンネルまで指定できます。

ワークフローの詳細については、以下のドキュメントを参照してください。 これ.

チャンネル

Verifyに新チャンネルが登場：

• ショートメール
• ボイス（旧レガシーのTTS）
• WhatsApp
• 電子メール
• サイレント認証
• RCS

これらのチャネルの詳細については、以下を参照してください。 API仕様.

サイレント認証に特化したドキュメントは これ.

サマリー・コールバック

コールバックは、イベントのステータス、対応する request_id とチャンネルを使用する。以下のシーケンス図は、1つのチャンネルを使用する場合、またはワークフローで複数のチャンネルを使用する場合の動作を示しています。

シングル・チャンネル

複数チャンネル

レスポンス・コード

エンドポイントを変更するだけでなく、アプリケーションもVerify使用時に受信した応答コードを理解できるように更新する必要があります：

キャンセルについて

テンプレート

PSD2への対応

検索検証リクエスト

不正管理

シーケンス図の検証

ベリファイ・フロー

サマリーコールバックでリクエストをVerifyする

サイレント認証シーケンス図

V1とV2のペイロードパラメータ解析の検証

検証リクエストの送信

小切手検証リクエスト

検索検証リクエスト

検証リクエストのキャンセル

次の検証プロセスのトリガー

カスタムテンプレート

PSD2への対応

Verify V1 vs Verify V2 ワークフロー・マッピング

ワークフロー1（デフォルト）

パターン： sms → tts → tts

ベリファイV1

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 1
}

ベリファイV2

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "sms", "to": "15555551234"},
    {"channel": "voice", "to": "15555551234"},
    {"channel": "voice", "to": "15555551234"}
  ]
}

ワークフロー2

パターン： sms → sms → tts

ベリファイV1

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 2
}

ベリファイV2

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "sms", "to": "15555551234"},
    {"channel": "sms", "to": "15555551234"},
    {"channel": "voice", "to": "15555551234"}
  ]
}

ワークフロー3

パターン： TTS → TTS

ベリファイV1

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 3
}

ベリファイV2

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "voice", "to": "15555551234"},
    {"channel": "voice", "to": "15555551234"}
  ]
}

ワークフロー4

パターン： SMS → SMS

ベリファイV1

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 4
}

ベリファイV2

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "sms", "to": "15555551234"},
    {"channel": "sms", "to": "15555551234"}
  ]
}

ワークフロー5

パターン： SMS → TTS

ベリファイV1

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 5
}

ベリファイV2

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "sms", "to": "15555551234"},
    {"channel": "voice", "to": "15555551234"}
  ]
}

ワークフロー6

パターン： ショートメール

ベリファイV1

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 6
}

ベリファイV2

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "sms", "to": "15555551234"}
  ]
}

ワークフロー7

パターン： TTS

ベリファイV1

{
  "api_key": "your_key",
  "api_secret": "your_secret",
  "number": "15555551234",
  "brand": "YourBrand",
  "workflow_id": 7
}

ベリファイV2

{
  "brand": "YourBrand",
  "workflow": [
    {"channel": "voice", "to": "15555551234"}
  ]
}