BotKit SDK のインストール

Kore.ai BotKit SDKは、Node.js アプリケーションとして動作します。独自のリバースプロキシ、ファイアウォール、ロードバランサーを追加することで、可用性、スケーラビリティ、パフォーマンスなどの関数要件を満たすことができます。このセクションでは、BotKit SDK のインストールと設定に関する詳細な概要を説明します。Kore.ai サンプルボットを使ったインストールとセットアップの詳細なエンドツーエンドのチュートリアルについては、Kore.ai BotKit SDK Tutorial をご覧ください。BotKit SDK をインストールするには、以下が必要です:

ボットを作成し、そのボットを Web/モバイルチャネル用に設定して、Kore.ai ボットプラットフォームにアプリケーションを登録します。
BotKit SDK ライブラリをダウンロードしてデプロイします。
config.json ファイルの設定を行います。

承認

BotKit SDK のインストールの前提として、Kore.ai ボットビルダーツールを使って、SDK アプリを Kore.ai ボットプラットフォームに登録する必要があります。ボットビルダーではボットを作成し、[API 拡張] > [BotKit SDK] セクションでそのボット用のアプリを登録または作成して、アプリとボットプラットフォーム間の通信のための相互 SSL 認証や、SDK から Kore.ai ボットプラットフォームへの API 呼出しの認証に使用される ClientID と クライアントシークレットのセキュリティ資格情報を生成することができます。 SDK の config.json ファイルでは、ボットビルダーから以下の認証キーをコピーする必要があります。

appId = ClientID
appKey ークライアントシークレット

詳しくは、 <a href="/docs/bots/kore-web-sdk/sdk-app-registration/">「SDKアプリの登録」</a>をご覧ください。詳しくは SDKアプリの登録をご覧ください。

インストールとセットアップ

Kore.ai BotKit SDK のライブラリは、以下の GitHub リポジトリからダウンロードできます。https://github.com/Koredotcom/BotKit SDK を設定するには、config.json ファイルに以下のキーを定義して、BotKit を稼働させる必要があります。

キー	説明
`"server": {` "port": }	BotKit Node.js アプリを実行するポートを指定します。
`app": {` "apiPrefix” : }	Node.js express ルートの API パスのプレフィックスを指定します。
`"credentials": {` "appId": }	SDK アプリの登録時に Kore ボットビルダーで生成されるクライアント ID の値です。

JWT トークンの有効期限は、デフォルトで 60 秒です。これは以下の KoreConfig の設定で変更できます:

"botkit":{ "jwt_expiry": 300 //seconds }

BotKit SDK を実行するには、ターミナル ウィンドウで、次のように入力します: node app.js

On this Page

Installing the BotKit SDK

The Kore.ai BotKit SDK runs as Node.js application. You can add your own reverse proxy, firewall, and load balancer to meet your functional requirements for availability, scalability, and performance.
This section provides a high-level overview of BotKit SDK installation and configuration.
For a detailed end-to-end tutorial on installation and setup using our Kore.ai Sample Bots, see the Kore.ai BotKit SDK Tutorial.
To install the BotKit SDK, you will need to:

Register your application on the Kore.ai Bots Platform by creating a bot, and then configuring that bot for the Web/Mobile channel.
Download and deploy the BotKit SDK libraries.
Configure the config.json file.

Authorization

As a prerequisite for BotKit SDK installation, you need to register your SDK app with the Kore.ai Bots Platform using the Kore.ai Bot Builder tool.
In Bot Builder you need to create a bot, and then from API Extensions -> BotKit SDK section, register/create an app for that bot to generate the ClientID and Client Secret security credentials used for mutual SSL authentication for communication between your app and the Bots Platform and to authorize API calls from your SDK to the Kore.ai Bots Platform.
In the config.json file in the SDK, you will need to copy the following authentication keys from Bot Builder.

appId = ClientID
appKey – Client Secret

For more information, see SDK App Registration.

Installation and Setup

The Kore.ai BotKit SDK libraries can be downloaded from the Github repository at:
https://github.com/Koredotcom/BotKit
To configure your SDK, you need to define the following keys in your config.json file to get your BotKit up and running.

Key	Description
`"server": {` “port”: }	Specifies the port to run the BotKit NodeJS app .
`app": {` “apiPrefix” : }	Specifies the API path prefix to the NodeJS express route.
`"credentials": {` “appId”: }	The Client ID value generated in Kore Bot Builder when registering your SDK app.

Note that the JWT token would expire in 60 seconds, by default. You can change this using the following KoreConfig setting:

"botkit":{
       "jwt_expiry": 300 //seconds
  }

To run BotKit SDK, in a Terminal window, enter:
node app.js

On this Page