Karaden Nodeライブラリ

Karaden Nodeライブラリは、Javascriptで書かれたアプリケーションからKaraden APIへ簡単にアクセスするための手段を提供します。

それにはAPIレスポンスから動的に初期化するAPIリソースの一連のクラス定義が含まれているため、Karaden APIの幅広いバージョンと互換性があります。

インストール方法

パッケージを変更しないならば、このソースコードは必要ありません。

パッケージを使用したいだけならば、下記を実行するだけです。

``console
npm install karaden-prg-node
`

動作環境

Node.js 18～

使い方

このライブラリを使用するには、Karadenでテナントを作成し、プロジェクト毎に発行できるトークンを発行する必要があります。

作成したテナントID（テナントIDはテナント選択画面で表示されています）は、Config.tenantIdに、発行したトークンはConfig.apiKeyにそれぞれ設定します。

`javascript
import { Config, MessageCreateParams, Message } from 'karaden-prg-node';

Config.apiKey = '<トークン>';
Config.tenantId = '<テナントID>';

const params = MessageCreateParams.newBuilder()
.withServiceId(1)
.withTo('09012345678')
.withBody('本文')
.build();

Message.create(params);
`

$3

Dual Packages（CommonJSとES Module）に対応しています。

使用する状況に合わせてモジュールの読み込み形式を選択してください。

#### ES Module形式

`javascript
import { Config, MessageCreateParams, Message } from 'karaden-prg-node';
`

#### CommonJS形式

`javascript
const { Config, MessageCreateParams, Message } = require('karaden-prg-node');
`

$3

同一のプロセスで複数のキーを使用する必要がある場合、リクエスト毎にキーやテナントIDを設定することができます。

`javascript
const params = MessageDetailParams.newBuilder()
.withId('<メッセージID>')
.build();

const requestOptions = RequestOptions.newBuilder()
.withApiKey('<トークン>')
.withTenantId('<テナントID>')
.build();

Message.detail(params, requestOptions);
`


$3


通信をするファイルサイズや実行環境の通信速度によってはHTTP通信時にタイムアウトが発生する可能性があります。

何度も同じような現象が起こる際は、ファイルサイズの調整もしくはRequestOptionsからタイムアウトの時間を増やして、再度実行してください。

`javascript
const requestOptions = RequestOptions.newBuilder()
.withApiKey('<トークン>')
.withTenantId('<テナントID>')
.withConnectionTimeout(<ミリ秒>)
.withReadTimeout(<ミリ秒>)
.build();

const bulkMessage = BulkMessageService.create('<ファイルパス>', requestOptions);
``