uni-sdk

Unimatrix Ruby SDK

The Unimatrix Ruby SDK provides convenient access to integrate communication capabilities into your Ruby applications using the Unimatrix HTTP API. The SDK provides support for sending SMS, 2FA verification, and phone number lookup.

Getting started

Before you begin, you need an Unimatrix account. If you don't have one yet, you can sign up for an Unimatrix account and get free credits to get you started.

Documentation

Check out the documentation at unimtx.com/docs for a quick overview.

Installation

The recommended way to install the Unimatrix SDK for Ruby is to use the gem package manager, which is available on RubyGems.

Run the following command to add uni-sdk as a dependency to your project:

gem install uni-sdk

If you are installing via Bundler, add this line to your application's Gemfile:

gem 'uni-sdk'

Usage

The following example shows how to use the Unimatrix Ruby SDK to interact with Unimatrix services.

Initialize a client

require 'uni-sdk'

client = Uni::Client.new('your access key id', 'your access key secret')

or you can configure your credentials by environment variables:

export UNIMTX_ACCESS_KEY_ID=your_access_key_id
export UNIMTX_ACCESS_KEY_SECRET=your_access_key_secret

Send SMS

Send a text message to a single recipient.

require 'uni-sdk'

client = Uni::Client.new('your access key id', 'your access key secret')

begin
  resp = client.messages.send({
    to: '+1206880xxxx', # in E.164 format
    text: 'Your verification code is 2048.'
  })
  puts resp.data
rescue Uni::UniError => e
  puts 'Exception: ' + e.message
end

Send verification code

Send a one-time passcode (OTP) to a recipient. The following example will automatically generate a verification code.

require 'uni-sdk'

client = Uni::Client.new()

resp = client.otp.send({
  to: '+1206880xxxx'
})
puts resp.data

Check verification code

Verify the one-time passcode (OTP) that a user provided. The following example will check whether the user-provided verification code is correct.

require 'uni-sdk'

client = Uni::Client.new()

resp = client.otp.verify({
  to: '+1206880xxxx',
  code: '123456' # the code user provided
})
puts resp.valid

Reference

Other Unimatrix SDKs

To find Unimatrix SDKs in other programming languages, check out the list below:

• Java
• Go
• Node.js
• Python
• PHP
• .NET

License

This library is released under the MIT License.