vonage java sdk

Vonage Server SDK para Java

Este Java SDK permite que você use APIs Vonage em qualquer aplicativo baseado em JVM. Você precisará ter criado uma conta Vonage.

• APIs suportadas
• Outros SDKs
• Instalação
• Uso
• Configuração
• Perguntas frequentes
• Contribuir!

APIs suportadas

• Conta
• Aplicativo
• Conversa
• Conversão
• Mensagens
• Number Insight
• Gerenciamento de números
• Verificação do número
• Redigir
• SIM SWAP
• SMS
• Subcontas
• Verificar
• Vídeo
• Voz

Outros SDKs

Também fornecemos SDKs de servidor em outros idiomas:

• Kotlin
• .LÍQUIDO
• Php
• Python
• Rubi
• Nodejs

Também oferecemos SDKs do lado do cliente para iOS, Android e JavaScript. Veja todos os nossos SDKs e integrações no portal de desenvolvedores Vonage.

Instalação

Os lançamentos são publicados no Maven Central. As instruções para o seu sistema de construção podem ser encontradas na seção Snippets. Recomendamos fortemente que você use uma ferramenta que suporta gerenciamento de dependência, como Maven, Gradle ou Ivy.

As notas de lançamento para cada versão podem ser encontradas no Changelog.

Construa você mesmo

Como alternativa, você pode clonar o repositório e construir o arquivo de jar:

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

O perfil uberjar criará um arquivo JAR com todas as dependências necessárias para executar o SDK incluído, que pode ser encontrado no diretório target . A meta install disponibilizará o SDK e suas dependências no repositório Maven local (geralmente localizado no seu diretório ~/.m2 ), que pode ser usado em outros projetos localmente em sua máquina. Para usar isso em um projeto Gradle, você precisa incluir as coordenadas de dependência e adicionar mavenLocal() ao bloco repositories no seu arquivo build.gradle .

Uso

• Para obter ajuda para entender nossas APIs, confira nosso incrível portal de desenvolvedores.
• Verifique o Javadoc para obter documentação completa de referência.
• Também existem muitas amostras de código úteis em nosso repositório Vonage/Vonage-Java-Code Snippets.
• Para instruções de uso da API de vídeo, consulte o guia em nosso portal de desenvolvedor.

Configuração

Instanciação típica

Para configuração padrão, você só precisa especificar suas credenciais da conta Vonage usando a chave da API e a chave secreta, a chave privada e a inscrição ou ambos. Para obter a máxima compatibilidade com todas as APIs, é recomendável que você especifique os dois métodos de autenticação, assim:

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

Personalize o URI base

Por padrão, o cliente usará https://api.nexmo.com, https://rest.nexmo.com, https://api-eu.vonage.com e https://video.api.vonage.com como URIs base para os vários pontos de extremidade. Para personalizá -los, você pode instanciar VonageClient com um objeto HttpConfig .

HttpConfig.Builder foi criado para ajudar na construção deste objeto. O uso é o seguinte:

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

Se você não especificar uma propriedade, ele assumirá qualquer que seja o valor padrão. Você também pode definir os três com um único método:

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

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

Tempo limite personalizado

Por padrão, o SDK tem um tempo limite de 1 minuto para solicitações. Você pode alterar isso para ser mais longo ou mais curto usando HttpConfig . O exemplo a seguir define isso para 12 segundos:

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

Perguntas frequentes

P: O que aconteceu com com.vonage:client ?

R: Para evitar confusão com nossos vários SDKs do lado do cliente, este SDK do lado do servidor foi movido do com.vonage:client coordena para com.vonage:server-sdk . O antigo Artifactid ( com.vonage:client ) não receberá mais atualizações. Todos os usuários devem migrar para o novo ArtifactID. Observe que o SDK é funcionalmente o mesmo, é apenas uma alteração no Maven Central.

P: Qual é a sua política sobre segurança de threads?

R: A arquitetura atual do SDK significa que apenas um thread deve usar o cliente por vez. Se você deseja usar o SDK em um ambiente multithread, crie uma instância separada do VonageClient para cada thread.

P: Este SDK suporta processamento de solicitação / resposta assíncrona?

R: Atualmente não, mas está no roteiro.

P: Como faço para migrar do Tokbox para o Vonage?

A: Veja o Guia de Migração do Opentok.

Contribuir!

Contribuições para esta biblioteca!

É uma boa ideia conversar conosco primeiro se você planeja adicionar qualquer nova funcionalidade. Caso contrário, relatórios de bugs, correções de bugs e feedback na biblioteca são sempre apreciados.

Contato