はじめに
Rubyライブラリは、Rubyで書かれたアプリケーションから『Karaden SMS API』へ簡単にアクセスするための手段を提供します。
それにはAPIレスポンスから動的に初期化するAPIリソースの一連のクラス定義が含まれているため、『Karaden SMS API』の幅広いバージョンと互換性があります。
Rubyがインストールされている環境で、Gemfileに下記の依存関係を設定します。
gem 'karaden-prg-ruby'
当該ディレクトリにて下記のコマンドを実行します。
bundle install
使い方
このライブラリを使用するには、『Karaden SMS API』でテナントを作成し、プロジェクト毎に発行できるトークンを発行する必要があります。
作成したテナントID(テナントIDはテナント選択画面で表示されています)は、`Karaden::Config.tenant_id`に、発行したトークンは`Karaden::Config.api_key`にそれぞれ設定します。
require 'karaden'
Karaden::Config.api_key = '<トークン>'
Karaden::Config.tenant_id = '<テナントID>'
params = Karaden::Param::Message::MessageCreateParams.new_builder
.with_service_id(<サービスID>)
.with_to('09012345678')
.with_body('本文')
.build
Karaden::Model::Message.create(params)