同期実装

はじめに

このガイドでは、ユーザーをリダイレクトした後にバックエンドが直接応答するのを待つ、同期的なアプローチを使ってサイレント認証を実装する方法を説明します。

注:シンクロナス実装を使用している場合、アプリケーション・ダッシュボードでVerify機能をオンにすると、次のようになります。 任意, これは、ステータスウェブフック(Synchronous実装には不要)を受信する機能を切り替えるだけだからです。

以下の図に、同期バージョンの Silent Authentication を実装するために必要な手順を示す:

VonageApp BackendMobile AppVonageApp BackendMobile AppRequest Verification CodeOpen check_url over cellular network using Vonage SDKCheck Verification CodeVerify phone numberPOST v2/verify202 OK (check_url, request_id)Response (check_url)GET check_urlSeveral 302 RedirectsHTTP 200 (request_id, code)Request (request_id, code)POST v2/verify/:request_id (code)HTTP 200 (status: completed)Response (Completed)

リクエスト検証コード

サイレント認証プロセスを開始するには、以下のリクエストを行う。 /verify エンドポイントを使用します。次の例では ワークフロー は、Verify が最初にサイレント認証を使用しようとすることを指定します。何らかの理由で要求が失敗した場合、SMS にフォールバックし、音声通話 OTP に続く。

注:複数のチャンネルを使用する場合、サイレント認証 マスト ワークフローの最初のチャンネルである。

サンプルを実行するには、サンプルコード内の以下の変数を独自の値に置き換えてください:

可変 説明
JWT を使用して API リクエストを認証します。 JWT.
VERIFY_BRAND_NAME 認証メッセージでユーザーに表示される会社名またはサービス名。
VONAGE_APPLICATION_PRIVATE_KEY_PATH アプリケーションの秘密鍵。
VONAGE_APPLICATION_ID アプリケーションのアプリケーションID。
VERIFY_NUMBER E.164形式のOTP送信先電話番号(例. +44111223344).

Write the code

Add the following to request.sh:

curl -X POST "https://api.nexmo.com/v2/verify" \
  -H "Authorization: Bearer $JWT"\
  -H 'Content-Type: application/json' \
  -d $'{
	 "brand": "'$VERIFY_BRAND_NAME'",
   "workflow": [
      {
         "channel": "silent_auth",
         "to": "'$VERIFY_NUMBER'"
      },
      {
         "channel": "sms",
         "to": "'$VERIFY_NUMBER'"
      },
      {
         "channel": "voice",
         "to": "'$VERIFY_NUMBER'"
      }
   ]
}'

View full source

Run your code

Save this file to your machine and run it:

sh request.sh

もしリクエストが成功し、Numbersが 対応を受け取ります。 200 Ok レスポンスを含む request_id そして check_url 体内の

{
  "request_id": "c11236f4-00bf-4b89-84ba-88b25df97315",
  "check_url": "https://api.nexmo.com/v2/verify/31eaf23d-b2db-4c42-9d1d-e847e75ab330/silent-auth/redirect"
}

リクエストが期限切れになるか、キャンセルされるまで、 check_url を使用してサイレント認証チェックを行うことができる。この応答を受け取ったら、以下のように check_url 認証しようとしているモバイル・デバイスから。

重要だ: について check_url リクエストは(Wi-Fiではなく)モバイルデータ接続を介して実行する必要があります。これを確実にするために推奨される方法は、デバイスのセルラーネットワークを介してリクエストを自動的にルーティングするVonage Client SDK(iOSまたはAndroid)を使用することです。詳しくは サイレント認証のためのWi-Fiバイパスガイド をご覧ください。

GET]リクエストを行うと、いくつかのHTTPリクエストを受信する。 302 リダイレクトは、ターゲット・デバイスが使用している地域とキャリアに依存する:

HTTP/1.1 302 Found
Location: https://eu.api.silentauth.com/phone_check/v0.2/checks/31eaf23d-b2db-4c42-9d1d-e847e75ab330/redirect

リダイレクトに従うと、次のいずれかになります。 HTTP 200 または HTTP 409 レスポンスは、リクエストが有効かどうかに応じて変化する。ネットワークに問題がある場合は、このようなレスポンスが表示される:

HTTP/1.1 409 CONFLICT
Content-Type: application/json

{
  "title": "Network error",
  "detail": "The Silent Auth request could not be completed due to formatting or the carrier is not supported."
}

潜在的なエラーコードの完全なリストは、以下のページにあります。 API仕様.

リクエストが有効な場合は、次のメッセージが表示されます。 HTTP 200 あなたの request_id そして code:

{
  "request_id": "c11236f4-00bf-4b89-84ba-88b25df97315",
  "code": "si9sfG"
}

注:安全な認証チェックを保証し、潜在的な中間者攻撃(man in middle attack)を軽減するために、オリジナルを保存する。 request_id と比較する。 request_id がレスポンスに返される。IDが一致しない場合は、サイレント認証チェックを中止しなければならない。詳細は サンプルアプリケーション を参照されたい。

提供された検証コードを確認する

エンドユーザーがコードを受け取ったら、

POST
リクエストを /v2/verify/{request_id} エンドポイント {request_id} を、前の通話で受け取ったIDで入力してください。

サンプルを実行するには、サンプルコード内の以下の変数を独自の値に置き換えてください:

可変 説明
JWT を使用して API リクエストを認証します。 JWT.
VERIFY_REQUEST_ID について request_id 前のステップで受け取った。
VONAGE_APPLICATION_PRIVATE_KEY_PATH アプリケーションの秘密鍵。
VONAGE_APPLICATION_ID アプリケーションのアプリケーションID。
VERIFY_CODE エンドユーザーが受信した検証コード

Write the code

Add the following to check-verification-code.sh:

curl -X POST "https://api.nexmo.com/v2/verify/$VERIFY_REQUEST_ID" \
  -H "Authorization: Bearer $JWT"\
  -H 'Content-Type: application/json' \
  -d $'{
    "code": "'$VERIFY_CODE'"
  }'

View full source

Run your code

Save this file to your machine and run it:

sh check-verification-code.sh

注:サイレント認証ワークフローのコードは、以下の場合にのみチェックできます。 かつて.

コードが有効であれば、最終的なレスポンスとして以下のステータスが返されます。 completed:

{
   "request_id": "31eaf23d-b2db-4c42-9d1d-e847e75ab330",
   "status": "completed"
}

エラーがある場合は「Invalid Code」と表示されます:

{
   "title": "Invalid Code",
   "type": "https://www.developer.vonage.com/api-errors/verify#invalid-code",
   "detail": "The code you provided does not match the expected value.",
   "instance": "bf0ca0bf927b3b52e3cb03217e1a1ddf"
}

この時点で、サイレント認証の検証は完了です。