vonage java sdk

Vonage Server SDK pour Java

Ce SDK Java vous permet d'utiliser des API Vonage dans n'importe quelle application basée sur JVM. Vous devrez avoir créé un compte Vonage.

• API soutenues
• Autres SDK
• Installation
• Usage
• Configuration
• FAQ
• Contribuer!

API soutenues

• Compte
• Application
• Conversation
• Conversion
• Messages
• Insight du nombre
• Gestion des nombres
• Vérification du nombre
• Rédiger
• Échange de sim
• SMS
• Sous-comptes
• Vérifier
• Vidéo
• Voix

Autres SDK

Nous fournissons également des SDK de serveur dans d'autres langues:

• Kotlin
• .FILET
• Php
• Python
• Rubis
• Nodejs

Nous proposons également des SDK côté client pour iOS, Android et JavaScript. Voir tous nos SDK et intégrations sur le portail des développeurs Vonage.

Installation

Les sorties sont publiées à Maven Central. Des instructions pour votre système de construction se trouvent dans la section des extraits. Nous vous recommandons fortement d'utiliser un outil qui prend en charge la gestion des dépendances, comme Maven, Gradle ou Ivy.

Les notes de version pour chaque version peuvent être trouvées dans le Changelog.

Construisez-le vous-même

Alternativement, vous pouvez cloner le dépôt et construire le fichier pot vous-même:

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

Le profil uberjar créera un fichier JAR avec toutes les dépendances nécessaires pour exécuter le SDK inclus, qui peut être trouvé dans le répertoire target . L'objectif install mettra le SDK et ses dépendances disponibles dans votre référentiel Maven local (généralement situé dans votre répertoire ~/.m2 ), qui peut ensuite être utilisé à partir d'autres projets localement sur votre machine. Pour l'utiliser dans un projet Gradle, vous devez inclure les coordonnées de dépendance et ajouter mavenLocal() au bloc repositories dans votre fichier build.gradle .

Usage

• Pour aider à comprendre nos API, consultez notre portail de développeur génial.
• Vérifiez le Javadoc pour la documentation de référence complète.
• Il existe également de nombreux échantillons de code utiles dans notre référentiel Vonage / Vonage-Java-Code-Snippets.
• Pour les instructions d'utilisation de l'API vidéo, consultez le guide sur notre portail de développeur.

Configuration

Instanciation typique

Pour la configuration par défaut, il vous suffit de spécifier vos informations d'identification de compte Vonage à l'aide de la clé API et du secret, de la clé privée et de l'ID d'application ou les deux. Pour une compatibilité maximale avec toutes les API, il est recommandé de spécifier les deux méthodes d'authentification, comme ainsi:

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

Personnalisez l'uri de base

Par défaut, le client utilisera https://api.nexmo.com, https://rest.nexmo.com, https://api-eu.vonage.com et https://video.api.vonage.com comme uris de base pour les différents paramètres. Pour les personnaliser, vous pouvez instancier VonageClient avec un objet HttpConfig .

HttpConfig.Builder a été créé pour aider à construire cet objet. L'utilisation est la suivante:

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

Si vous ne spécifiez pas de propriété, il prendra la valeur par défaut. Vous pouvez également définir les trois avec une seule méthode:

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

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

Timeout personnalisé

Par défaut, le SDK a un délai de 1 minute pour les demandes. Vous pouvez changer cela pour être plus long ou plus court à l'aide de HttpConfig . L'exemple suivant définit cela à 12 secondes:

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

Questions fréquemment posées

Q: Qu'est-il arrivé à com.vonage:client ?

R: Pour éviter la confusion avec nos différents SDK côté client, ce SDK côté serveur a été déplacé du com.vonage:client Coordonnées vers com.vonage:server-sdk . L'ancien artefactive ( com.vonage:client ) ne recevra pas d'autres mises à jour. Tous les utilisateurs doivent migrer vers le nouvel artefactive. Veuillez noter que le SDK est fonctionnellement le même, c'est juste un changement d'espace de noms sur Maven Central.

Q: Quelle est votre politique sur la sécurité des fils?

R: L'architecture actuelle du SDK signifie qu'un seul thread doit utiliser le client à la fois. Si vous souhaitez utiliser le SDK dans un environnement multithread, créez une instance distincte de VonageClient pour chaque thread.

Q: Ce SDK prend-il en charge le traitement de la demande / réponse asynchrone?

R: Actuellement non, mais c'est sur la feuille de route.

Q: Comment migrer de Tokbox vers Vonage?

R: Voir le guide de migration OpenTok.

Contribuer!

Nous contribuons à cette bibliothèque!

C'est une bonne idée de nous parler d'abord si vous prévoyez d'ajouter de nouvelles fonctionnalités. Sinon, les rapports de bogues, les corrections de bogues et les commentaires sur la bibliothèque sont toujours appréciés.

Contact