The Ding Java library provides convenient access to the Ding API from applications written in the Java language.
Ding: The OTP API allows you to send authentication codes to your users using their phone numbers.
- SDK Installation
- SDK Example Usage
- Available Resources and Operations
- Error Handling
- Server Selection
- Authentication
JDK 11 or later is required.
The samples below show how a published SDK artifact is used:
Gradle:
implementation 'live.ding:dingsdk:0.8.3'Maven:
<dependency>
<groupId>live.ding</groupId>
<artifactId>dingsdk</artifactId>
<version>0.8.3</version>
</dependency>After cloning the git repository to your file system you can build the SDK artifact from source to the build directory by running ./gradlew build on *nix systems or gradlew.bat on Windows systems.
If you wish to build from source and publish the SDK artifact to your local Maven repository (on your filesystem) then use the following command (after cloning the git repo locally):
On *nix:
./gradlew publishToMavenLocal -Pskip.signingOn Windows:
gradlew.bat publishToMavenLocal -Pskip.signingSend an OTP code to a user's phone number.
package hello.world;
import java.lang.Exception;
import live.ding.dingsdk.Ding;
import live.ding.dingsdk.models.errors.ErrorResponse;
import live.ding.dingsdk.models.operations.CreateAuthenticationResponse;
import live.ding.dingsdk.models.shared.CreateAuthenticationRequest;
import live.ding.dingsdk.models.shared.Security;
public class Application {
public static void main(String[] args) throws ErrorResponse, Exception {
Ding sdk = Ding.builder()
.security(Security.builder()
.apiKey("YOUR_API_KEY")
.build())
.build();
CreateAuthenticationRequest req = CreateAuthenticationRequest.builder()
.customerUuid("cf2edc1c-7fc6-48fb-86da-b7508c6b7b71")
.phoneNumber("+1234567890")
.locale("fr-FR")
.build();
CreateAuthenticationResponse res = sdk.otp().createAuthentication()
.request(req)
.call();
if (res.createAuthenticationResponse().isPresent()) {
// handle response
}
}
}Check that a code entered by a user is valid.
package hello.world;
import java.lang.Exception;
import live.ding.dingsdk.Ding;
import live.ding.dingsdk.models.errors.ErrorResponse;
import live.ding.dingsdk.models.operations.CheckResponse;
import live.ding.dingsdk.models.shared.CreateCheckRequest;
import live.ding.dingsdk.models.shared.Security;
public class Application {
public static void main(String[] args) throws ErrorResponse, Exception {
Ding sdk = Ding.builder()
.security(Security.builder()
.apiKey("YOUR_API_KEY")
.build())
.build();
CreateCheckRequest req = CreateCheckRequest.builder()
.authenticationUuid("eebe792b-2fcc-44a0-87f1-650e79259e02")
.checkCode("123456")
.customerUuid("64f66a7c-4b2c-4131-a8ff-d5b954cca05f")
.build();
CheckResponse res = sdk.otp().check()
.request(req)
.call();
if (res.createCheckResponse().isPresent()) {
// handle response
}
}
}Perform a retry if a user has not received the code.
package hello.world;
import java.lang.Exception;
import live.ding.dingsdk.Ding;
import live.ding.dingsdk.models.errors.ErrorResponse1;
import live.ding.dingsdk.models.operations.RetryResponse;
import live.ding.dingsdk.models.shared.RetryAuthenticationRequest;
import live.ding.dingsdk.models.shared.Security;
public class Application {
public static void main(String[] args) throws ErrorResponse1, Exception {
Ding sdk = Ding.builder()
.security(Security.builder()
.apiKey("YOUR_API_KEY")
.build())
.build();
RetryAuthenticationRequest req = RetryAuthenticationRequest.builder()
.authenticationUuid("a4e4548a-1f7b-451a-81cb-a68ed5aff3b0")
.customerUuid("28532118-1b33-420a-b57b-648c9bf85fee")
.build();
RetryResponse res = sdk.otp().retry()
.request(req)
.call();
if (res.retryAuthenticationResponse().isPresent()) {
// handle response
}
}
}Send feedback about the authentication process.
package hello.world;
import java.lang.Exception;
import live.ding.dingsdk.Ding;
import live.ding.dingsdk.models.operations.FeedbackResponse;
import live.ding.dingsdk.models.shared.FeedbackRequest;
import live.ding.dingsdk.models.shared.FeedbackRequestStatus;
import live.ding.dingsdk.models.shared.Security;
public class Application {
public static void main(String[] args) throws Exception {
Ding sdk = Ding.builder()
.security(Security.builder()
.apiKey("YOUR_API_KEY")
.build())
.build();
FeedbackRequest req = FeedbackRequest.builder()
.customerUuid("cc0f6c04-40de-448f-8301-3cb0e6565dff")
.phoneNumber("+1234567890")
.status(FeedbackRequestStatus.ONBOARDED)
.build();
FeedbackResponse res = sdk.otp().feedback()
.request(req)
.call();
if (res.feedbackResponse().isPresent()) {
// handle response
}
}
}Get the status of an authentication.
package hello.world;
import java.lang.Exception;
import live.ding.dingsdk.Ding;
import live.ding.dingsdk.models.operations.GetAuthenticationStatusResponse;
import live.ding.dingsdk.models.shared.Security;
public class Application {
public static void main(String[] args) throws Exception {
Ding sdk = Ding.builder()
.security(Security.builder()
.apiKey("YOUR_API_KEY")
.build())
.build();
GetAuthenticationStatusResponse res = sdk.otp().getAuthenticationStatus()
.authUuid("d8446450-f2fa-4dd9-806b-df5b8c661f23")
.call();
if (res.authenticationStatusResponse().isPresent()) {
// handle response
}
}
}Perform a phone number lookup.
package hello.world;
import java.lang.Exception;
import live.ding.dingsdk.Ding;
import live.ding.dingsdk.models.errors.ErrorResponse1;
import live.ding.dingsdk.models.operations.LookupResponse;
import live.ding.dingsdk.models.shared.Security;
public class Application {
public static void main(String[] args) throws ErrorResponse1, Exception {
Ding sdk = Ding.builder()
.security(Security.builder()
.apiKey("YOUR_API_KEY")
.build())
.build();
LookupResponse res = sdk.lookup().lookup()
.customerUuid("69a197d9-356c-45d1-a807-41874e16b555")
.phoneNumber("<value>")
.call();
if (res.lookupResponse().isPresent()) {
// handle response
}
}
}Available methods
- lookup - Look up for phone number
- check - Check a code
- createAuthentication - Send a code
- feedback - Send feedback
- getAuthenticationStatus - Get authentication status
- retry - Perform a retry
You can override the default server globally by passing a server index to the serverIndex builder method when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
|---|---|---|
| 0 | https://api.ding.live/v1 |
None |
package hello.world;
import java.lang.Exception;
import live.ding.dingsdk.Ding;
import live.ding.dingsdk.models.errors.ErrorResponse;
import live.ding.dingsdk.models.operations.CheckResponse;
import live.ding.dingsdk.models.shared.CreateCheckRequest;
import live.ding.dingsdk.models.shared.Security;
public class Application {
public static void main(String[] args) throws ErrorResponse, Exception {
Ding sdk = Ding.builder()
.serverIndex(0)
.security(Security.builder()
.apiKey("YOUR_API_KEY")
.build())
.build();
CreateCheckRequest req = CreateCheckRequest.builder()
.authenticationUuid("eebe792b-2fcc-44a0-87f1-650e79259e02")
.checkCode("123456")
.customerUuid("64f66a7c-4b2c-4131-a8ff-d5b954cca05f")
.build();
CheckResponse res = sdk.otp().check()
.request(req)
.call();
if (res.createCheckResponse().isPresent()) {
// handle response
}
}
}The default server can also be overridden globally by passing a URL to the serverURL builder method when initializing the SDK client instance. For example:
package hello.world;
import java.lang.Exception;
import live.ding.dingsdk.Ding;
import live.ding.dingsdk.models.errors.ErrorResponse;
import live.ding.dingsdk.models.operations.CheckResponse;
import live.ding.dingsdk.models.shared.CreateCheckRequest;
import live.ding.dingsdk.models.shared.Security;
public class Application {
public static void main(String[] args) throws ErrorResponse, Exception {
Ding sdk = Ding.builder()
.serverURL("https://api.ding.live/v1")
.security(Security.builder()
.apiKey("YOUR_API_KEY")
.build())
.build();
CreateCheckRequest req = CreateCheckRequest.builder()
.authenticationUuid("eebe792b-2fcc-44a0-87f1-650e79259e02")
.checkCode("123456")
.customerUuid("64f66a7c-4b2c-4131-a8ff-d5b954cca05f")
.build();
CheckResponse res = sdk.otp().check()
.request(req)
.call();
if (res.createCheckResponse().isPresent()) {
// handle response
}
}
}Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
By default, an API error will throw a models/errors/SDKError exception. When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the check method throws the following exceptions:
| Error Type | Status Code | Content Type |
|---|---|---|
| models/errors/ErrorResponse | 400 | application/json |
| models/errors/SDKError | 4XX, 5XX | */* |
package hello.world;
import java.lang.Exception;
import live.ding.dingsdk.Ding;
import live.ding.dingsdk.models.errors.ErrorResponse;
import live.ding.dingsdk.models.operations.CheckResponse;
import live.ding.dingsdk.models.shared.CreateCheckRequest;
import live.ding.dingsdk.models.shared.Security;
public class Application {
public static void main(String[] args) throws ErrorResponse, Exception {
Ding sdk = Ding.builder()
.security(Security.builder()
.apiKey("YOUR_API_KEY")
.build())
.build();
CreateCheckRequest req = CreateCheckRequest.builder()
.authenticationUuid("eebe792b-2fcc-44a0-87f1-650e79259e02")
.checkCode("123456")
.customerUuid("64f66a7c-4b2c-4131-a8ff-d5b954cca05f")
.build();
CheckResponse res = sdk.otp().check()
.request(req)
.call();
if (res.createCheckResponse().isPresent()) {
// handle response
}
}
}This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
apiKey |
apiKey | API key |
You can set the security parameters through the security builder method when initializing the SDK client instance. For example:
package hello.world;
import java.lang.Exception;
import live.ding.dingsdk.Ding;
import live.ding.dingsdk.models.errors.ErrorResponse;
import live.ding.dingsdk.models.operations.CheckResponse;
import live.ding.dingsdk.models.shared.CreateCheckRequest;
import live.ding.dingsdk.models.shared.Security;
public class Application {
public static void main(String[] args) throws ErrorResponse, Exception {
Ding sdk = Ding.builder()
.security(Security.builder()
.apiKey("YOUR_API_KEY")
.build())
.build();
CreateCheckRequest req = CreateCheckRequest.builder()
.authenticationUuid("eebe792b-2fcc-44a0-87f1-650e79259e02")
.checkCode("123456")
.customerUuid("64f66a7c-4b2c-4131-a8ff-d5b954cca05f")
.build();
CheckResponse res = sdk.otp().check()
.request(req)
.call();
if (res.createCheckResponse().isPresent()) {
// handle response
}
}
}This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!