vonage java sdk

Vonage Server SDK для Java

Этот Java SDK позволяет использовать API Vonage в любом приложении на основе JVM. Вам нужно было создать аккаунт Vonage.

• Поддерживается API
• Другие SDK
• Установка
• Использование
• Конфигурация
• Часто задаваемые вопросы
• Способствовать!

Поддерживается API

• Счет
• Приложение
• Беседа
• Обращение
• Сообщения
• Номер понимание
• Управление номерами
• Проверка числа
• Отредактировать
• SIM -обратный обмен
• SMS
• Subaccounts
• Проверять
• Видео
• Голос

Другие SDK

Мы также предоставляем сервер SDK на других языках:

• Котлин
• .СЕТЬ
• PHP
• Питон
• Рубин
• Nodejs

Мы также предлагаем клиентские SDK для iOS, Android и Javascript. Посмотрите все наши SDK и интеграции на портале разработчика Vonage.

Установка

Выпуски опубликованы в Maven Central. Инструкции для вашей системы сборки можно найти в разделе фрагментов. Мы настоятельно рекомендуем вам использовать инструмент, который поддерживает управление зависимостями, например, Maven, Gradle или Ivy.

Заметки для выпуска для каждой версии можно найти в ChangeLog.

Создайте это самостоятельно

В качестве альтернативы вы можете клонировать репо и построить файл JAR самостоятельно:

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

Профиль uberjar создаст файл JAR со всеми зависимостями, необходимыми для запуска включенного SDK, который можно найти в target каталоге. Цель install сделает SDK и его зависимости доступными в вашем местном хранилище Maven (обычно расположенном под вашим каталогом ~/.m2 ), который затем можно использовать из других проектов на вашей машине. Чтобы использовать это в проекте Gradle, вам необходимо включить координаты зависимости и добавить mavenLocal() в блок repositories в вашем файле build.gradle .

Использование

• Для понимания наших API -интерфейсов ознакомьтесь с нашим потрясающим порталом разработчиков.
• Проверьте Javadoc для полной справочной документации.
• Есть также много полезных образцов кода в нашем хранилище Vonage/Vonage-Java-Code-Snippets.
• Инструкции по использованию видео API см. Руководство на нашем портале разработчиков.

Конфигурация

Типичный экземпляр

Для конфигурации по умолчанию вам просто необходимо указать учетные данные для учетной записи Vonage, используя ключ API и секретный, закрытый ключ и идентификатор приложения или обоих. Для максимальной совместимости со всеми API -интерфейсом рекомендуется указать оба метода аутентификации, например, SO:

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

Настроить базовый URI

По умолчанию клиент будет использовать https://api.nexmo.com, https://rest.nexmo.com, https://api-eu.vonage.com и https://video.api.vonage.com в качестве базового URI для различных конечных точек. Чтобы настроить их, вы можете создать экземпляр VonageClient с объектом HttpConfig .

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

Если вы не указаете свойство, оно примет на себя то, какое значение по умолчанию. Вы также можете установить все три с помощью одного метода:

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

Часто задаваемые вопросы

В: Что случилось с com.vonage:client ?

О: Чтобы избежать путаницы с нашими различными SDK на стороне клиента, этот серверный SDK был перемещен из com.vonage:client Comportanates в com.vonage:server-sdk . Старый Artifactid ( com.vonage:client ) не получит дополнительных обновлений. Все пользователи должны мигрировать в новый Artifactid. Обратите внимание, что SDK функционально такой же, это просто изменение пространства имен на Maven Central.

В: Какова ваша политика в области безопасности потока?

A: Текущая архитектура SDK означает, что только один поток должен использовать клиент за раз. Если вы хотите использовать SDK в многопоточной среде, создайте отдельный экземпляр VonageClient для каждого потока.

В: Поддерживает ли этот SDK асинхронное запрос / обработку ответов?

A: В настоящее время нет, но это на дорожной карте.

В: Как мне мигрировать из Tokbox в Vonage?

A: См. Руководство по миграции Opentok.

Способствовать!

Мы ❤ Вклад в эту библиотеку!

Хорошей идеей сначала поговорить с нами, если вы планируете добавить какие -либо новые функции. В противном случае всегда ценятся отчеты об ошибках, исправления ошибок и отзывы о библиотеке.

Контакт