はじめに
Nodeライブラリは、Javascriptで書かれたアプリケーションから『Karaden SMS API』へ簡単にアクセスするための手段を提供します。
それにはAPIレスポンスから動的に初期化するAPIリソースの一連のクラス定義が含まれているため、『Karaden SMS API』の幅広いバージョンと互換性があります。
Node.jsがインストールされている環境で、下記のコマンドを実行してください。
npm install karaden-prg-node
モジュールの読込形式
Dual Packages(CommonJSとES Module)に対応しています。
使用する状況に合わせてモジュールの読み込み形式を選択してください。
ES Module形式
import { Config, MessageCreateParams, Message } from 'karaden-prg-node';
CommonJS形式
const { Config, MessageCreateParams, Message } = require('karaden-prg-node');
使い方
このライブラリを使用するには、『Karaden SMS API』でテナントを作成し、プロジェクト毎に発行できるトークンを発行する必要があります。
作成したテナントID(テナントIDはテナント選択画面で表示されています)は、`Config.tenantId`に、発行したトークンは`Config.apiKey`にそれぞれ設定します。
import { Config, MessageCreateParams, Message } from 'karaden-prg-node'; Config.apiKey = '<トークン>'; Config.tenantId = '<テナントID>'; const params = MessageCreateParams.newBuilder() .withServiceId(<サービスID>) .withTo('09012345678') .withBody('本文') .build(); Message.create(params);