サーバー認証

前提条件

このガイドでは、以下の条件を満たしていることを前提としています：

  • Vonageアプリケーションでネットワーク機能機能が有効になっています。次の手順に従ってください。 ガイド をご覧ください。
  • あなたは有効な JWT.私たちの オンラインジェネレーター を作成する。 JWT にある秘密鍵とVonageアプリケーションのIDを使用します。 カスタマーダッシュボードまたは指示に従ってください。 これ 別の方法を使う

認証APIリファレンス

ネットワーク・フィーチャー認証エンドポイントのOpenAPI仕様は以下の通りです。 これ.

認証フロー

APIコールを行うには3つのステップがある：

  1. バックエンドアプリケーション 認証IDを要求する.
  2. バックエンドのアプリケーションは、その認証IDを使用して、次のことを行う。 CAMARAアクセストークンをリクエストする.
  3. 最後に、バックエンドのアプリケーションはアクセストークンを使って次のことを行います。 APIコールを行う.
Vonage Communications PlatformBackend ApplicationVonage Communications PlatformBackend Application1. Make an OIDC RequestAuthorization Response2. Request a CAMARA access tokenCAMARA access token response3. Make the API callResult

OIDCリクエストを行う

OpenID Connect（OIDC）は、OAuth 2.0プロトコルの上に構築されたIDレイヤーであり、OIDCを使用してユーザーのIDを検証する方法を提供する。 JWT トークン

[POST］ https://api-eu.vonage.com/oauth2/bc-authorize

curl -X POST https://api-eu.vonage.com/oauth2/bc-authorize \
  --header "Authorization: Bearer $JWT" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "login_hint=$PHONE_NUMBER" \
  --data-urlencode "scope=$SCOPE"

ヘッダー

ヘッダー 説明
Authorization に設定する必要がある。 Bearer とともに JWT 前のステップで生成されたトークン。その JWT は、ネットワーク機能の使用が承認されたアプリに関連付けられなければなりません。
Content-Type に設定する必要がある。 application/x-www-form-urlencoded.

ボディ・パラメーター

パラメータ 説明
login_hint (必須) 確認したい電話番号（国番号を含む）。 +447700900000
scope (必須） 文字列形式のスコープ。

別の電話番号に対してAPIコールを行いたい場合は、その電話番号用の新しいアクセストークンを生成する必要があります。

応答

成功すると、レスポンスには 200 OK ステータスと、以下のJSONデータがレスポンス・ボディに含まれる：

{
  "auth_req_id": "$AUTH_REQ_ID",
  "expires_in": 120,
  "interval": 2
}
パラメータ タイプ 説明
auth_req_id ストリング 次のステップで必要となる認証ID文字列。
expires_in イント 認証コードの有効期限までの秒数
interval イント 次のリクエストが行われるまでの秒数

CAMARAアクセストークンのリクエスト

CAMARAアクセストークンをリクエストするには、以下のアドレスに

POST
リクエストを送信してください。 https://api-eu.vonage.com/oauth2/token

curl -X POST https://api-eu.vonage.com/oauth2/token \
  --header "Authorization: Bearer $JWT" \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "auth_req_id=$AUTH_REQ_ID" \
  --data-urlencode "grant_type=urn:openid:params:grant-type:ciba"

ヘッダー

ヘッダー 説明
Authorization に設定する必要がある。 Bearer とともに JWT 前のステップで生成されたトークン。その JWT は、ネットワーク機能の使用が承認されたアプリに関連付けられなければなりません。
Content-Type に設定する必要がある。 application/x-www-form-urlencoded.

ボディ・パラメーター

パラメータ 説明
auth_req_id (必須）これは 前段階.
grant_type (必須) urn:openid:params:grant-type:ciba.

応答

成功すると、レスポンスには 200 OK ステータスと、以下のJSONデータがレスポンス・ボディに含まれる：

{
 "access_token": "$ACCESS_TOKEN",
 "token_type": "Bearer",
 "expires_in": 3600
}
パラメータ タイプ 説明
access_token ストリング APIコール時に使用されるアクセストークン。
token_type ストリング に設定されている。 Bearer.
expires_in イント アクセストークンの有効期間（秒）。

APIコールを行う

すべてのネットワーク・フィーチャー・コールには、以下のヘッダーが含まれていなければならない：

ヘッダー 説明
Authorization に設定する必要がある。 Bearer とともに access token で生成される。 前段階.

リクエスト例

次の例は、以下のAPIコールの方法を示している。 SIMスワップAPI アクセストークンを使用します：

curl -X POST https://api-eu.vonage.com/camara/sim-swap/v040/check \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data $'{
        "phoneNumber": "'$PHONE_NUMBER'",
        "maxAge": 240
}'

応答例

成功すると、レスポンスには 200 OK ステータスと、以下のJSONデータがレスポンス・ボディに含まれる：

{
   "swapped": true
}