To use any of the Kore.ai Bot SDKs, you must first register your app to get the authentication credentials to communicate between the Kore.ai Bot and your application hosting the Bot. The Kore.ai Bot SDKs can be used to add a chat widget into your company application that enables your application users to chat with the application using natural language input. The Kore.ai Bots platform interprets the user input, processes the request and responds back to the user.
The Bots Platform will only accept requests from authorized clients to connect to, and exchange messages. To authorize the connection, you must register your app and get required client credentials. The credentials authorize the client app and provide for user assertion.
This topic describes how to register your application and generate credentials for your clients that are required to exchange messages between your application and the Kore.ai Bots Platform, and then configure and add the Web/Mobile Client Channel to your Bot.
To add the Web/Mobile Client Channel to your bot, you must first register, or create an app in Bot Builder. When you create an app, you are provisioning credentials for you application to communicate securely with Kore.ai servers. After you create an app, you can use that app registration in the configuration to add the Web/Mobile Client Channel to your Bot.
To add the Web/mobile Client channel
- Open the bot to which you want to add the Web/Mobile Client channel.
- On the bots menu, click Channel > Web/Mobile Client.
- In the Select App drop-down list, select your existing app registration or click Create App to create a new app.
- In the Name field, enter the name for the app registration used in Bot Builder, for example, My App Registration.
- Select one of these scopes for the app:
- Allow anonymous users to chat with the bot: enables anonymous users to interact with the bot.
- Auto register new users on Kore.ai Bots Platform: Select to control the auto-user registration in Kore.ai if the user assertion is unknown.
- In the JWT Signing Algorithms Used For Client App Authentication drop-down list, select one of the following security algorithms:
- RS256: Select to enable the Public Key field. The Public Key is used by the Kore.ai Bots Platform to authenticate the client application.
- HS256: Select to generate a Secret Key and a Client ID. The Client ID is required for SDK initialization, and the Secret Key used by the Kore.ai Bots Platform to authenticate the client application.
- Optionally, In the Push Notifications section, click Enable and then specify a URL to send the notifications to.
- Click Create. The app registration details appear.
- To copy the app registration details to the clipboard for your application, you can click Copy for Bot Name, Bot ID, and Client ID. For Client Secret, click View, and then click Copy.
- In the Allow Alert Task Setup section, Select Yes to enable your application users to set up their own alert tasks using the web client. By default, this setting is disabled for web client users, but mobile client users can always setup their own alerts.
- In the Enable Channel section, select Yes to enable the channel immediately after saving.
- Click Save to save the settings and close the Web/Mobile Client Channel page.
The Channel Information updated successfully message is displayed on the top-right corner of the page.
Once enabled see here for steps to integrate your Bot at your web application.
Editing the Web/Mobile Channel
To edit the Web/Mobile Client channel, hover your mouse over the channel to modify, and then click the Settings icon displayed to show the command menu displayed in the following illustration.
Select one of the following commands to modify the channel:
- Edit – Click to open the Web/Mobile Client channel setup page.
- Disable/Enable – Click Disable to temporarily disable use of the Web/Mobile Client channel for your Bot. When the channel is disabled, click Enable to enable use of the Web/Mobile Client channel.
- Delete – Click Delete, and then click OK in the Delete Confirmation dialog to permanently delete the Bot channel configuration.
Warning: This operation is permanent, and cannot be undone.