このJava SDKを使用すると、JVMベースのアプリケーションでVonage APIを使用できます。 Vonageアカウントを作成する必要があります。
また、他の言語でサーバーSDKを提供します。
また、iOS、Android、JavaScript用のクライアント側SDKも提供しています。 Vonage Developer PortalのすべてのSDKと統合をご覧ください。
リリースはMaven Centralに公開されています。ビルドシステムの指示は、スニペットセクションにあります。 Maven、Gradle、Ivyなどの依存関係管理をサポートするツールを使用することを強くお勧めします。
各バージョンのリリースノートは、Changelogにあります。
または、リポジトリをクローンしてJARファイルを自分で構築できます。
git clone [email protected]:vonage/vonage-java-sdk.git
mvn install -P uberjar
uberjar
プロファイルは、 target
ディレクトリにあるSDKを実行するために必要なすべての依存関係を備えたJARファイルを作成します。 install
目標により、SDKとその依存関係は、地元のMavenリポジトリ(通常は~/.m2
ディレクトリの下にあります)で利用可能になり、その後、マシン上の他のプロジェクトから使用できます。これをGradleプロジェクトで使用するには、依存関係の座標を含めて、 build.gradle
ファイルのrepositories
ブロックにmavenLocal()
を追加する必要があります。
デフォルトの構成の場合、APIキーとシークレット、秘密キーとアプリケーションID、またはその両方を使用して、Vonageアカウント資格情報を指定するだけです。すべてのAPIとの互換性を最大限に活用するには、次のように両方の認証方法を指定することをお勧めします。
VonageClient client = VonageClient . builder ()
. applicationId ( APPLICATION_ID )
. privateKeyPath ( PRIVATE_KEY_PATH )
. apiKey ( API_KEY )
. apiSecret ( API_SECRET )
. build ();
デフォルトでは、クライアントはhttps://api.nexmo.com、https://rest.nexmo.com、https://api-eu.vonage.comおよびhttps://video.api.vonage.comを使用します。さまざまなエンドポイントのベースURIとして。これらをカスタマイズするには、 HttpConfig
オブジェクトを使用してVonageClient
インスタンス化できます。
HttpConfig.Builder
このオブジェクトの構築を支援するために作成されました。使用法は次のとおりです。
HttpConfig httpConfig = HttpConfig . builder ()
. apiBaseUri ( "https://api.example.com" )
. restBaseUri ( "https://rest.example.com" )
. apiEuBaseUri ( "https://api-eu.example.com" )
. videoBaseUri ( "https://video.example.com" )
. build ();
VonageClient client = VonageClient . builder ()
. apiKey ( API_KEY ). apiSecret ( API_SECRET )
. httpConfig ( httpConfig )
. build ();
プロパティを指定しない場合、デフォルト値が何であれ、 3つすべてを単一の方法で設定することもできます。
HttpConfig httpConfig = HttpConfig . builder (). baseUri ( "http://example.com" ). build ();
VonageClient client = VonageClient . builder ()
. apiKey ( API_KEY ). apiSecret ( API_SECRET )
. httpConfig ( httpConfig )
. build ();
デフォルトでは、SDKにはリクエストの1分間のタイムアウトがあります。 HttpConfig
使用して、これを長くまたは短くするように変更できます。次の例では、これを12秒に設定します。
VonageClient client = VonageClient . builder ()
. applicationId ( APPLICATION_ID )
. privateKeyPath ( PRIVATE_KEY_PATH )
. httpConfig ( HttpConfig . builder (). timeoutMillis ( 12_000 ). build ())
. build ();
Q: com.vonage:client
はどうなりましたか?
A:さまざまなクライアント側のSDKとの混乱を避けるために、このサーバー側のSDKはcom.vonage:client
座標からcom.vonage:server-sdk
に移動しました。古いartifactid( com.vonage:client
)は、さらなる更新を受け取りません。すべてのユーザーは、新しいartifactidに移行する必要があります。 SDKは機能的に同じであり、Maven Centralの名前空間の変更にすぎないことに注意してください。
Q:スレッドの安全性に関するポリシーは何ですか?
A: SDKの現在のアーキテクチャは、1つのスレッドのみが一度にクライアントを使用する必要があることを意味します。マルチスレッド環境でSDKを使用したい場合は、各スレッドのVonageClient
の個別のインスタンスを作成します。
Q:このSDKは非同期リクエスト /応答処理をサポートしていますか?
A:現在はいいえですが、ロードマップにあります。
Q:TokboxからVonageに移動するにはどうすればよいですか?
A: Opentok Migration Guideを参照してください。
このライブラリへの貢献!
新しい機能を追加する予定がある場合は、最初にお話しすることをお勧めします。それ以外の場合、ライブラリに関するバグレポート、バグ修正、フィードバックは常に高く評価されています。