vonage java sdk

Vonage Server SDK para Java

Este Java SDK le permite usar API Vonage en cualquier aplicación basada en JVM. Deberá haber creado una cuenta vonage.

• API compatibles
• Otros SDK
• Instalación
• Uso
• Configuración
• Preguntas frecuentes
• ¡Contribuir!

API compatibles

• Cuenta
• Solicitud
• Conversación
• Conversión
• Mensajes
• Insight Number
• Gestión de números
• Verificación de números
• Redactar
• Intercambio de sim
• SMS
• Subcolds
• Verificar
• Video
• Voz

Otros SDK

También proporcionamos SDK del servidor en otros idiomas:

• Kotlín
• .NETO
• Php
• Pitón
• Rubí
• Nodejs

También ofrecemos SDK del lado del cliente para iOS, Android y JavaScript. Vea todos nuestros SDK e integraciones en el portal de desarrolladores de Vonage.

Instalación

Los lanzamientos se publican para Maven Central. Las instrucciones para su sistema de compilación se pueden encontrar en la sección de fragmentos. Recomendamos encarecidamente que use una herramienta que admite la gestión de dependencias, como Maven, Gradle o Ivy.

Las notas de lanzamiento para cada versión se pueden encontrar en ChangeLog.

Construyelo usted mismo

Alternativamente, puede clonar el repositorio y construir el archivo jar usted mismo:

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

El perfil uberjar creará un archivo JAR con todas las dependencias necesarias para ejecutar el SDK incluido, que se puede encontrar en el directorio target . El objetivo install pondrá a disposición el SDK y sus dependencias en su repositorio Maven local (generalmente ubicado en su directorio ~/.m2 ), que luego se puede utilizar desde otros proyectos localmente en su máquina. Para usar esto en un proyecto de Gradle, debe incluir las coordenadas de dependencia y agregar mavenLocal() al bloque repositories en su archivo build.gradle .

Uso

• Para obtener ayuda para comprender nuestras API, consulte nuestro increíble portal de desarrolladores.
• Consulte el Javadoc para obtener la documentación de referencia completa.
• También hay muchas muestras de código útiles en nuestro repositorio Vonage/Vonage-Java-Code-Snippets.
• Para obtener instrucciones de uso de la API de video, consulte la guía sobre nuestro portal de desarrolladores.

Configuración

Instanciación típica

Para la configuración predeterminada, solo necesita especificar las credenciales de su cuenta de vonage utilizando la clave API y la clave secreta, la clave privada y la identificación de la aplicación o ambos. Para obtener la máxima compatibilidad con todas las API, se recomienda que especifique ambos métodos de autenticación, como así:

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

Personaliza el URI base

Por defecto, el cliente usará https://api.nexmo.com, https://rest.nexmo.com, https://api-eu.vonage.com y https://video.api.vonage.com como URIS de base para los diversos puntos finales. Para personalizarlos, puede instanciar VonageClient con un objeto HttpConfig .

HttpConfig.Builder ha sido creado para ayudar a construir este objeto. El uso es el siguiente:

 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 no especifica una propiedad, tomará cualquier valor predeterminado. También puede configurar los tres con un solo método:

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

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

Tiempo de espera personalizado

Por defecto, el SDK tiene un tiempo de espera de 1 minuto para las solicitudes. Puede cambiar esto para que sea más largo o más corto usando HttpConfig . El siguiente ejemplo establece esto en 12 segundos:

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

Preguntas frecuentes

P: ¿Qué pasó con com.vonage:client ?

R: Para evitar confusiones con nuestros diversos SDK del lado del cliente, este SDK del lado del servidor se ha movido del com.vonage:client a com.vonage:server-sdk . El antiguo ArtifactID ( com.vonage:client ) no recibirá más actualizaciones. Todos los usuarios deben migrar al nuevo artefacto. Tenga en cuenta que el SDK es funcionalmente igual, es solo un cambio de espacio de nombres en Maven Central.

P: ¿Cuál es su política sobre la seguridad de los hilos?

R: La arquitectura actual del SDK significa que solo un hilo debe usar el cliente a la vez. Si desea utilizar el SDK en un entorno multiproceso, cree una instancia separada de VonageClient para cada hilo.

P: ¿Este SDK admite el procesamiento de solicitud / respuesta asincrónica?

R: Actualmente no, pero está en la hoja de ruta.

P: ¿Cómo migro de Tokbox a Vonage?

R: Consulte la Guía de migración de Opentok.

¡Contribuir!

¡❤️ Contribuciones a esta biblioteca!

Es una buena idea hablar con nosotros primero si planea agregar alguna nueva funcionalidad. De lo contrario, siempre se agradecen los informes de errores, las correcciones de errores y los comentarios sobre la biblioteca.

Contacto