The Ding Ruby library provides convenient access to the Ding API from applications written in the Ruby language.
Ding: The OTP API allows you to send authentication codes to your users using their phone numbers.
The SDK can be installed using RubyGems:
gem install ding_sdkSend an OTP code to a user's phone number.
require 'ding_sdk'
s = ::DingSDK::Ding.new
s.config_security(
::DingSDK::Shared::Security.new(
api_key: "YOUR_API_KEY",
)
)
req = ::DingSDK::Shared::CreateAuthenticationRequest.new(
customer_uuid: "cf2edc1c-7fc6-48fb-86da-b7508c6b7b71",
locale: "fr-FR",
phone_number: "+1234567890",
)
res = s.otp.create_authentication(req)
if ! res.create_authentication_response.nil?
# handle response
endCheck that a code entered by a user is valid.
require 'ding_sdk'
s = ::DingSDK::Ding.new
s.config_security(
::DingSDK::Shared::Security.new(
api_key: "YOUR_API_KEY",
)
)
req = ::DingSDK::Shared::CreateCheckRequest.new(
authentication_uuid: "eebe792b-2fcc-44a0-87f1-650e79259e02",
check_code: "123456",
customer_uuid: "64f66a7c-4b2c-4131-a8ff-d5b954cca05f",
)
res = s.otp.check(req)
if ! res.create_check_response.nil?
# handle response
endPerform a retry if a user has not received the code.
require 'ding_sdk'
s = ::DingSDK::Ding.new
s.config_security(
::DingSDK::Shared::Security.new(
api_key: "YOUR_API_KEY",
)
)
req = ::DingSDK::Shared::RetryAuthenticationRequest.new(
authentication_uuid: "a4e4548a-1f7b-451a-81cb-a68ed5aff3b0",
customer_uuid: "28532118-1b33-420a-b57b-648c9bf85fee",
)
res = s.otp.retry(req)
if ! res.retry_authentication_response.nil?
# handle response
endSend feedback about the authentication process.
require 'ding_sdk'
s = ::DingSDK::Ding.new
s.config_security(
::DingSDK::Shared::Security.new(
api_key: "YOUR_API_KEY",
)
)
req = ::DingSDK::Shared::FeedbackRequest.new(
customer_uuid: "cc0f6c04-40de-448f-8301-3cb0e6565dff",
phone_number: "+1234567890",
status: ::DingSDK::Shared::FeedbackRequestStatus::ONBOARDED,
)
res = s.otp.feedback(req)
if ! res.feedback_response.nil?
# handle response
endGet the status of an authentication.
require 'ding_sdk'
s = ::DingSDK::Ding.new
s.config_security(
::DingSDK::Shared::Security.new(
api_key: "YOUR_API_KEY",
)
)
res = s.otp.get_authentication_status(auth_uuid="d8446450-f2fa-4dd9-806b-df5b8c661f23")
if ! res.authentication_status_response.nil?
# handle response
endPerform a phone number lookup.
require 'ding_sdk'
s = ::DingSDK::Ding.new
s.config_security(
::DingSDK::Shared::Security.new(
api_key: "YOUR_API_KEY",
)
)
res = s.lookup.lookup(customer_uuid="69a197d9-356c-45d1-a807-41874e16b555", phone_number="<value>")
if ! res.lookup_response.nil?
# handle response
endAvailable methods
- lookup - Look up for phone number
- check - Check a code
- create_authentication - Send a code
- feedback - Send feedback
- get_authentication_status - Get authentication status
- retry - Perform a retry
You can override the default server globally by passing a server index to the server_idx: int optional parameter 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 |
The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
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!
