Unimatrix Ruby SDK

インストール

Ruby向けUnimatrix SDKは、RubyGems からgemで導入する方法を推奨します。

gem install uni-sdk

Bundlerを使う場合は Gemfile に次を追加します。

gem 'uni-sdk'

利用方法

クライアントの初期化

require 'uni-sdk'

client = Uni::Client.new('your access key id', 'your access key secret') # Simple Mode の場合は第1引数のみ

環境変数でも設定できます。

export UNIMTX_ACCESS_KEY_ID=your_access_key_id
export UNIMTX_ACCESS_KEY_SECRET=your_access_key_secret

SMSの送信

require 'uni-sdk'

client = Uni::Client.new()

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

テンプレートを使用する例:

client.messages.send({
  to: '+1650253xxxx',
  signature: 'Unimatrix',
  templateId: 'pub_verif_en_basic2',
  templateData: {
    code: '2048'
  }
})

認証コード（OTP）の送信

require 'uni-sdk'

client = Uni::Client.new()

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

認証コード（OTP）の検証

require 'uni-sdk'

client = Uni::Client.new()

resp = client.otp.verify({
  to: '+1206880xxxx',
  code: '123456' # ユーザーが入力した認証コード
})
puts resp.valid