{"id":22085589,"url":"https://github.com/nexmo/nexmo-spring-boot-starter","last_synced_at":"2025-10-09T11:49:18.186Z","repository":{"id":37962222,"uuid":"185665930","full_name":"Nexmo/nexmo-spring-boot-starter","owner":"Nexmo","description":"Spring Boot Starter for Nexmo","archived":false,"fork":false,"pushed_at":"2025-04-03T00:32:46.000Z","size":53,"stargazers_count":5,"open_issues_count":16,"forks_count":6,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-05-22T22:06:18.811Z","etag":null,"topics":["java","kotlin","nexmo","spring","spring-boot","starter","vonage"],"latest_commit_sha":null,"homepage":null,"language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Nexmo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-08T19:16:31.000Z","updated_at":"2024-11-19T01:13:38.000Z","dependencies_parsed_at":"2024-04-30T05:22:02.532Z","dependency_job_id":"b834c35a-5d75-4637-b506-6f5d5e319b08","html_url":"https://github.com/Nexmo/nexmo-spring-boot-starter","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/Nexmo/nexmo-spring-boot-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nexmo%2Fnexmo-spring-boot-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nexmo%2Fnexmo-spring-boot-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nexmo%2Fnexmo-spring-boot-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nexmo%2Fnexmo-spring-boot-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nexmo","download_url":"https://codeload.github.com/Nexmo/nexmo-spring-boot-starter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nexmo%2Fnexmo-spring-boot-starter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266878569,"owners_count":23999619,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java","kotlin","nexmo","spring","spring-boot","starter","vonage"],"created_at":"2024-12-01T01:15:11.204Z","updated_at":"2025-10-09T11:49:13.152Z","avatar_url":"https://github.com/Nexmo.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ⚠️ This repository is no longer maintained.\n\n\u003cimg src=\"https://developer.nexmo.com/assets/images/Vonage_Nexmo.svg\" height=\"48px\" alt=\"Nexmo is now known as Vonage\" /\u003e\n\n**Please use [Vonage-Community/sample-serversdk-java-springboot](https://github.com/Vonage-Community/sample-serversdk-java-springboot) instead.**\n\n## Support Notice\nThis is an archived repository. If you have any questions, feel free to reach out to us at devrel@vonage.com or through our [Community Slack](https://developer.vonage.com/community/slack).\n\n\u003chr /\u003e\n\n## Nexmo Spring Boot Starter\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.nexmo/nexmo-spring-boot-starter.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.nexmo%22%20AND%20a:%22nexmo-spring-boot-starter%22)\n[![Build Status](https://travis-ci.org/Nexmo/nexmo-spring-boot-starter.svg?branch=main)](https://travis-ci.org/Nexmo/nexmo-spring-boot-starter)\n[![codecov](https://codecov.io/gh/Nexmo/nexmo-spring-boot-starter/branch/master/graph/badge.svg)](https://codecov.io/gh/Nexmo/nexmo-spring-boot-starter)\n\nThis Spring Boot Starter has been provided to help with integrating the [Nexmo Java SDK](https://github.com/Nexmo/nexmo-java) into your [Spring Boot](https://spring.io/projects/spring-boot) project.\n\n * [Installation](#installation)\n * [Usage](#usage)\n * [Customizing the NexmoClient](#customizing-the-nexmoclient)\n * [Customize Nexmo Client Version](#customize-nexmo-client-version)\n \n### Installation\n\nFor Gradle:\n\n```groovy\nrepositories {\n    mavenCentral()\n}\n\ndependencies {\n    implementation 'com.nexmo:nexmo-spring-boot-starter:1.1.0'\n}\n```\n\nFor Maven:\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.nexmo\u003c/groupId\u003e\n  \u003cartifactId\u003enexmo-spring-boot-starter\u003c/artifactId\u003e\n  \u003cversion\u003e1.1.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### Usage\n\nThe Nexmo Spring Boot Starter will automatically configure instances of the `NexmoClient.Builder`, `NexmoClient`, and any of the other sub-clients (`AccountClient`, `VoiceClient`, etc..) once you have provided the required configuration values.\n\n* For help understanding our APIs, check out our [developer portal](https://developer.nexmo.com/).\n* There are also **many useful code samples** in our [nexmo/nexmo-java-code-snippets](https://github.com/Nexmo/nexmo-java-code-snippets) repository.\n\n#### Configuration\n\nThe following configuration values are used to configure the starter. Check out the [Application Property Files](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-external-config-application-property-files) and [Externalized Configuration](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-external-config) reference in the Spring Boot documentation for how to provide configuration values.\n\n##### API Key and Secret Configuration\n\n```\nnexmo.creds.api-key=your-api-key\nnexmo.creds.secret=your-api-secret\n```\n\nThis will give you access to automatically wire in the `NexmoClient`, `AccountClient`, `ApplicationClient`, `ConversionClient`, `InsightClient`, `NumbersClient`, `RedactClient`, `SmsClient`, `SnsClient`, and `VerifyClient`.\n\nYou can also provide a signature secret:\n\n```\nnexmo.creds.api-key=your-api-key\nnexmo.creds.signature=signature\n```\n\n##### Application ID and Private Key Configuration\nTo gain access to the `VoiceClient` you will need to provide a [Nexmo Application ID]() and location or contents of a private key file associated with the Nexmo Application.\n\nHere is an example providing the path to the key:\n```\nnexmo.creds.application-id=application-id\nnexmo.creds.private-key-path=/path/to/your/private.key\n```\n\nHere is an example providing the contents of the key:\n```\nnexmo.creds.application-id=application-id\nnexmo.creds.private-key-contents=contents-of-the-key\n```\n\n#### Customizing the `NexmoClient`\n\nBy default, the auto configuration will create a `NexmoClient.Builder` using the information provided in your `application.properties`, `application.yml`, or other external configuration source. However, when registering the `NexmoClient` and all of the other sub-clients, the auto configuration can opt to use a pre-registered `NexmoClient.Builder`.\n\nFor example, if you would like to customize the base URI that the library uses, you can register a custom version of the `NexmoClient.Builder` in your configuration class:\n\n```java\n@Autowired\nNexmoCredentialsProperties nexmoCredentialsProperties;\n\n@Bean\npublic NexmoClient.Builder customNexmoBuilder() {\n    return NexmoClient.builder()\n            .apiKey(nexmoCredentialsProperties.getApiKey())\n            .apiSecret(nexmoCredentialsProperties.getSecret())\n            .httpConfig(HttpConfig.builder().baseUri(\"https://example.com\").build());\n}\n```\n\u003e Note that you must include your credentials as shown in this example. This builder completely replaces the automatically configured one.\n\n### Customize Nexmo Client Version\n\nBy default, the Nexmo Spring Boot Starter will transitively define Nexmo Client to the latest version at its release. You can override this by adding a dependency on the Nexmo Client, bringing in `4.2.0` for example:\n\nFor Gradle:\n\n```groovy\nrepositories {\n    mavenCentral()\n}\n\ndependencies {\n    implementation 'com.nexmo:client:4.2.0'\n}\n```\n\nFor Maven:\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.nexmo\u003c/groupId\u003e\n  \u003cartifactId\u003eclient\u003c/artifactId\u003e\n  \u003cversion\u003e4.2.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nBringing in older versions of the supported Nexmo Client, may result in some unforseen consequences and build errors. As a result here is a list of each version targeted by each version of the starter:\n\n| Nexmo Spring Boot Starter | Nexmo Java Client |\n|---|---|\n| v1.0.0 | v4.3.0 |\n| v1.0.1 | v4.3.1 |\n| v1.1.0 | v4.4.0 |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnexmo%2Fnexmo-spring-boot-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnexmo%2Fnexmo-spring-boot-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnexmo%2Fnexmo-spring-boot-starter/lists"}