vonage java sdk

Vonage Server SDK für Java

Mit diesem Java SDK können Sie von Vonage-APIs in jeder JVM-basierten Anwendung verwenden. Sie müssen ein Vonage -Konto erstellt haben.

• Unterstützte APIs
• Andere SDKs
• Installation
• Verwendung
• Konfiguration
• FAQ
• Beitragen!

Unterstützte APIs

• Konto
• Anwendung
• Gespräch
• Konvertierung
• Nachrichten
• Nummer Einsicht
• Zahlenmanagement
• Zahlenüberprüfung
• Reduzieren
• SIM -Tausch
• SMS
• Untersuchungen
• Verifizieren
• Video
• Stimme

Andere SDKs

Wir bieten auch Server -SDKs in anderen Sprachen:

• Kotlin
• .NETTO
• Php
• Python
• Rubin
• Nodejs

Wir bieten auch clientseitige SDKs für iOS, Android und JavaScript an. Sehen Sie sich alle unsere SDKs und Integrationen im Portal von Vonage Developer an.

Installation

Veröffentlichungen werden an Maven Central veröffentlicht. Anweisungen für Ihr Build -System finden Sie im Abschnitt Snippets. Wir empfehlen dringend , ein Tool zu verwenden, das das Abhängigkeitsmanagement wie Maven, Gradle oder Ivy unterstützt.

Versionshinweise für jede Version finden Sie im Changelog.

Bauen Sie es selbst auf

Alternativ können Sie das Repo klonen und die JAR -Datei selbst erstellen:

git clone [email protected]:vonage/vonage-java-sdk.git
mvn install -P uberjar

Das uberjar -Profil erstellt eine JAR -Datei mit allen Abhängigkeiten, die zum Ausführen des SDK enthalten sind, das im target zu finden ist. Mit dem install wird das SDK und seine Abhängigkeiten in Ihrem örtlichen Maven -Repository (normalerweise unter Ihrem ~/.m2 -Verzeichnis) verfügbar, das dann vor Ort auf Ihrem Computer aus anderen Projekten verwendet werden kann. Um dies in einem Gradle-Projekt zu verwenden, müssen Sie die Abhängigkeitskoordinaten einbeziehen und mavenLocal() in die Blockierung repositories in Ihre build.gradle Datei hinzufügen.

Verwendung

• Um unsere APIs zu verstehen, finden Sie in unserem großartigen Entwicklerportal.
• Überprüfen Sie die Javadoc, um die vollständige Referenzdokumentation zu erhalten.
• Es gibt auch viele nützliche Code-Beispiele in unserem von Vonage/Vonage-Java-Code-Snippets-Repository.
• Anweisungen zur Verwendung von Video -API -Nutzungen finden Sie im Leitfaden in unserem Entwicklerportal.

Konfiguration

Typische Instanziierung

Für die Standardkonfiguration müssen Sie Ihre Anmeldeinformationen von Vonage -Konto nur mit API -Schlüssel und geheimen, privaten Schlüssel- und Anwendungs ​​-ID oder beides angeben. Für die maximale Kompatibilität mit allen APIs wird empfohlen, beide Authentifizierungsmethoden wie SO anzugeben:

 VonageClient client = VonageClient . builder ()
        . applicationId ( APPLICATION_ID )
        . privateKeyPath ( PRIVATE_KEY_PATH )
        . apiKey ( API_KEY )
        . apiSecret ( API_SECRET )
        . build ();

Passen Sie den Basis -URI an

Standardmäßig verwendet der Client https://api.nexmo.com, https://rest.nexmo.com, https://api-eu.vonage.com und https://video.api.vonage.com als Basis uris für die verschiedenen Endpunkte. Um diese anzupassen, können Sie VonageClient mit einem HttpConfig -Objekt instanziieren.

HttpConfig.Builder wurde erstellt, um dieses Objekt zu erstellen. Die Verwendung ist wie folgt:

 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 ();

Wenn Sie keine Eigenschaft angeben, wird dies der Standardwert übernehmen. Sie können auch alle drei mit einer einzelnen Methode festlegen:

 HttpConfig httpConfig = HttpConfig . builder (). baseUri ( "http://example.com" ). build ();

VonageClient client = VonageClient . builder ()
        . apiKey ( API_KEY ). apiSecret ( API_SECRET )
        . httpConfig ( httpConfig )
        . build ();

Benutzerdefinierte Zeitüberschreitung

Standardmäßig hat der SDK eine Timeout von 1 Minute für Anfragen. Sie können dies ändern, um mit HttpConfig länger oder kürzer zu sein. Das folgende Beispiel legt dies auf 12 Sekunden fest:

 VonageClient client = VonageClient . builder ()
        . applicationId ( APPLICATION_ID )
        . privateKeyPath ( PRIVATE_KEY_PATH )
        . httpConfig ( HttpConfig . builder (). timeoutMillis ( 12_000 ). build ())
        . build ();

Häufig gestellte Fragen

F: Was ist mit com.vonage:client passiert?

A: Um Verwirrung mit unseren verschiedenen clientseitigen SDKs zu vermeiden, wurde dieses serverseitige SDK von com.vonage:client Koordinaten nach com.vonage:server-sdk verschoben. Die alte Artefaktid ( com.vonage:client ) erhält keine weiteren Aktualisierungen. Alle Benutzer sollten in die neue Artefaktis migrieren. Bitte beachten Sie, dass der SDK funktional gleich ist, sondern nur eine Namespace -Änderung für Maven Central.

F: Was ist Ihre Richtlinie zur Sicherheit von Threads?

A: Die aktuelle Architektur des SDK bedeutet, dass jeweils nur ein Thread den Client verwenden sollte. Wenn Sie das SDK in einer Multithread -Umgebung verwenden möchten, erstellen Sie für jeden Thread eine separate Instanz von VonageClient .

F: Unterstützt diese SDK asynchrone Anforderung / Antwortverarbeitung?

A: Derzeit nein, aber es ist auf der Roadmap.

F: Wie migriere ich von Tokbox nach Vonage?

A: Siehe den Openentok -Migrationshandbuch.

Beitragen!

Wir sind Beiträge zu dieser Bibliothek!

Es ist eine gute Idee, zuerst mit uns zu sprechen, wenn Sie vorhaben, neue Funktionen hinzuzufügen. Andernfalls werden Fehlerberichte, Fehlerbehebungen und Feedback in der Bibliothek immer geschätzt.

Kontakt