Installing the BotKit SDK¶
The Kore.ai BotKit SDK runs as a 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 Assistants, see this Kore.ai BotKit SDK Tutorial.
To install the BotKit SDK, you will need to:
- Register your application on the Kore.ai XO Platform by creating a Virtual Assistant, and then configuring it 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 XO Platform, as follows.
In the XO Platform, you need to create a bot, and then from API Extensions -> BotKit SDK section,
- Go to Deploy > Integrations > BotKit.
- Register/create an app for that assistant to generate the ClientID and Client Secret security credentials used for mutual SSL authentication for communication between your app and the XO Platform and to authorize API calls from your SDK to the Kore.ai XO Platform.
In the config.json file in the SDK, you will need to copy the following authentication keys from the XO Platform.
- 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 must define the following keys in your config.json file to get your BotKit up and running.
| KEY | DESCRIPTION |
|---|---|
| "server": { "port": 8003 } |
port: The port used to run the BotKit NodeJS app. |
| "app": { "apiPrefix": "", "url": "https://0ddf-122-174-183-138.ngrok-free.app" } |
apiPrefix: The API path prefix to the NodeJS express route (empty in the sample code). url: The ngrok Forwarding URL for the callback server. |
| "validations": { "leastNodeVersion": 10 } |
leastNodeVersion: The minimum required version of Node.js on which the application must run. Ensure the version is 10 or higher. |
| "credentials": { "apikey": "tz4fhIiIPg6c1JHnP7tiZBtGfeCtCydlv6rbc6k4acw=", "appId": "cs-9a909c58-c5a9-569d-aa7c-1f36f94b23ad", "st-67890":{ "apikey": "test_api_key2", "appId": "test_app_id2" } } |
apikey: The Client Secret value generated on the Kore XO Platform when registering your SDK app. appId: The Client ID value generated on the Kore XO Platform when registering your SDK app. st-ID: This sub-section allows users to configure the credentials for a specific bot. If no bot/st-ID block is available, this will fall back to the parent credentials. |
| "jwt": { "jwtAlgorithm": "HS256", "jwt-expiry": 60, "st-67890": { "jwtAlgorithm": "HS512", "jwt-expiry": 60 } } |
This section supports JWT variations RS256, RS512, HS256, and HS512; HS256 remains the default for backward compatibility. jwtAlgorithm: The type of algorithm used for JWT signing. jwt-expiry: JWT expiration time in seconds; the JWT token expires in 60 seconds by default. You can change this using the following KoreConfig setting: "botkit": { "jwt_expiry": 300 //seconds } st-ID: This sub-section allows users to configure these algorithms for a specific bot. If no bot/st-ID block is available, this will fall back to the parent JWT configurations. |
| "redis": { "options": { "host": "localhost", "port": 6379 }, "available": false } |
host: The hostname where the Redis server is running. Here, it's configured to run on the local machine. port: The port number on which Redis is running. By default, Redis uses port 6379. available: Indicates whether Redis is available or not. It's set to false here, meaning Redis is not in use. |
| "examples": { "mockServicesHost": "http://localhost:8004" } |
mockServicesHost: Host for mock services that can be used for testing. |
| "liveagentlicense": "8947569" | liveagentlicense: The license key for the LiveChat agent application. This is required to connect and authenticate the bot with LiveChat services. |
| "supportsMessageAck": true | supportsMessageAck: Indicates whether the app supports message acknowledgment. It's set to true here, meaning the app acknowledges receipt of messages. |
| "languages": ["en", "de"] | languages: A list of languages supported by the bot or the application. |
Note
By default, the JWT token would expire in 60 seconds. You can change this using the following KoreConfig setting:
Run BotKit SDK¶
To run BotKit SDK, in a Terminal window, enter:
Ensure that the node.js version is 10 or higher.