https://a.storyblok.com/f/270183/1368x665/c3de0b34bf/25mar_dev_blog_client-library.png

Alvaro Navarroシニア・デベロッパー・アドボケイト

AlvaroはVonageの開発者支持者であり、ネットワークAPIに焦点を当てています。デベロッパーエクスペリエンス、API、オープンソースに情熱を注ぐ。仕事以外では、コミックショップを探検したり、SFやホラーフェスティバルに参加したり、有名な小さなプラスチックブロックで何かを作ったりしているところをよく見かける。

AndroidとiOS用の新しいクライアント・ライブラリのご紹介

最終更新日 March 11, 2025

所要時間：1 分

クライアント・ライブラリアンドロイドおよび iOSこの新しいSDKは、開発者がWiFiをバイパスし、特定のAPIコールがモバイルネットワーク経由でのみ送信されるようにするためにゼロから設計されています。このクライアント・ライブラリは Verifyサイレント認証および Numbers Verification SDKに代わるものです。に代わるものです。

なぜこれが重要なのか

次のようなネットワークAPIがあります。番号検証APIまたはサイレント認証によるVerify APIなどの一部のネットワークAPIは、モバイルネットワーク上でのみ動作する。これは、モバイル・オペレーターがユーザーをVerifyするためにネットワーク・トラフィック・データに依存しているためである。

新しいクライアント・ライブラリは、ユーザー・デバイスのWiFi接続を手動でオフにすることなく、APIのGETリクエストをセルラー・ネットワーク経由で送信する。

仕組み

Vonage Client Libaryをモバイル・アプリケーションに統合するのは簡単です。わずか数行のコードで、開発者は必要に応じてWiFiをバイパスし、モバイルネットワークを通じてAPIリクエストを送信することができます。

実際に見てみよう！

アンドロイド

クライアント・ライブラリを使用するには、以下の依存関係をビルド.gradleファイルに追加します：

implementation 'com.vonage:client-library:1.0.0'

APIコールを行う前に、必要なパッケージをインポートし、ライブラリを初期化する：

import com.vonage.clientlibrary.VGCellularRequestClient
import com.vonage.clientlibrary.VGCellularRequestParameters

VGCellularRequestClient.initializeSdk(this.applicationContext)

を作成します。オブジェクトを作成する。オブジェクトを作成します：

val params = VGCellularRequestClientParameters(
    url = "http://www.vonage.com",
    headers = mapOf("x-my-header" to "My Value") ,
    queryParameters = mapOf("query-param" to "value"),
    maxRedirectCount = 10
)

どこでだ：

URL: APIエンドポイントに対応する。
Headers: リクエストに含めたいHTTPヘッダーの文字列のマップ。
queryParameters: GETリクエストに含まれるクエリパラメータの文字列（キーと値のペア）のマップ。
maxRedirectCount: オプション。デフォルトは10。このパラメータは許可されるリダイレクトの数を設定します。 TBC

最後にを呼び出す。メソッドを呼び出す：

val response = VGCellularRequestClient.getInstance().startCellularGetRequest(params)

このメソッドは、APIコールをデバッグするための2番目のブーリアン・パラメーターをサポートしている。このパラメーターのデフォルトはfalseだが、以下のようにして有効にできる：

val response = 
VGCellularRequestClient.getInstance().startCellularGetRequest(params, true)

iOS

Androidと同様に、クライアント・ライブラリを依存関係としてプロジェクトに追加する：

let package = Package(
    dependencies: [
        .Package(url: "https://github.com/Vonage/vonage-ios-client-library.git")
    ]
)

このライブラリはココアポッドを使ってインストールすることもできる。 VonageClientLibrary.

ライブラリをインポートして初期化する：

import VonageClientLibrary

let client = VGCellularRequestClient()



Create a VGCellularRequestClientParameters object with the necessary parameters:
let params = VGCellularRequestParameters(url: "http://www.vonage.com",
                                headers: ["x-my-header": "My Value"],
                                queryParameters: ["query-param" : "value"]
                                maxRedirectCount: 10)

を使用する。 startCellularGetRequestメソッドを使用します。2番目のパラメータ デバッグはオプションで、デバッグ・フラグを設定します (デフォルトは false)：

let response = try await client.startCellularRequest(params: params, debug: true)

回答

URLエンドポイントからレスポンスを受信するとメソッドは、以下のプロパティを含むオブジェクトを返します。メソッドは、以下のプロパティを含むオブジェクトを返します：

{
    "http_status": string, // HTTP status code of the URL response
    "response_body" : {    // Optional, depending on the HTTP status
        ...                // The response body of the requested url
    },
    "debug" : {            // Present if the debug flag is set to true
        "device_info": string, 
        "url_trace" : string
    }
}

接続性がない場合、またはクライアント・ライブラリで内部エラーが発生した場合、レスポンス・オブジェクトには以下のプロパティが含まれます：

{
    "error" : string,             // Error code
    "error_description": string,  // Error description
    "debug" : {                   // Present if debug flag is set to true
        "device_info": string, 
        "url_trace" : string
    }
}

質問や共有したいことがありますか？Vonageコミュニティ VonageコミュニティSlackまたは開発者向けニュースレターでフォローしてください。 X（旧Twitter）YouTubeチャンネル YouTubeチャンネルビデオチュートリアルを購読する。 LinkedInのVonage開発者ページ開発者が学び、コミュニティとつながるためのスペースです。つながりを維持し、進捗状況を共有し、最新の開発者向けニュース、ヒント、イベントを把握してください！