Unimatrix Node.js SDK

インストール

Node.js向けUnimatrix SDKの推奨インストール方法は、npm からの導入です。

npm i uni-sdk

Yarnを使う場合:

yarn add uni-sdk

利用方法

以下は、Unimatrix Node.js SDKの基本的な利用例です。

クライアントの初期化

const { UniClient } = require('uni-sdk')

const client = new UniClient({
  accessKeyId: 'your access key id',
  accessKeySecret: 'your access key secret' // Simple Mode の場合はこの行を削除
})

環境変数で資格情報を設定することもできます。

export UNIMTX_ACCESS_KEY_ID=your_access_key_id
export UNIMTX_ACCESS_KEY_SECRET=your_access_key_secret

SMSの送信

単一の宛先電話番号へSMSを送信する例です。

const { UniClient } = require('uni-sdk')
const client = new UniClient()

client.messages.send({
  to: '+1206880xxxx', // E.164形式
  text: 'Your verification code is 2048.'
})
  .then(ret => {
    console.log('Result:', ret)
  })
  .catch(e => {
    console.error(e)
  })

async/await を利用する場合は、次のように記述できます。

try {
  const ret = await client.messages.send({
    // ...
  })
  console.log('Result:', ret)
} catch (e) {
  console.error(e)
}

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

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

認証コード（OTP）の送信

認証コード（OTP）を送信する例です。以下では認証コードを自動生成して送信します。

const { UniClient } = require('uni-sdk')
const client = new UniClient()

client.otp.send({
  to: '+1206880xxxx'
})
  .then(ret => {
    console.log('Result:', ret)
  })

認証コード（OTP）の検証

ユーザーが入力した認証コードを検証する例です。以下では、入力された認証コードが正しいかを確認します。

const { UniClient } = require('uni-sdk')
const client = new UniClient()

client.otp.verify({
  to: '+1206880xxxx',
  code: '123456' // ユーザーが入力した認証コード
})
  .then(ret => {
    console.log('Valid:', ret.valid)
  })