{"id":17800,"date":"2016-07-12T13:52:06","date_gmt":"2016-07-12T13:52:06","guid":{"rendered":"http:\/\/apidocs.kore.com\/?post_type=docs&#038;p=3752"},"modified":"2023-10-16T15:44:22","modified_gmt":"2023-10-16T14:44:22","slug":"sdk-app-registration","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/sdks\/sdk-app-registration\/","title":{"rendered":"SDK App Registration"},"content":{"rendered":"<p><span style=\"font-weight: 400;\">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 XO Platform.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">When you register your app, you will need to select a security algorithm:<\/span><\/p>\n<ul>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><b>HS256 <\/b><b>\/ HS512<\/b><span style=\"font-weight: 400;\"> \u2013 XO Platform generates and displays the Client ID and Client Secret necessary to generate the JWT token from your server.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><b>RS256<\/b> <b>\/ RS512 <\/b><span style=\"font-weight: 400;\">\u2013 Upload your public key to the platform and use the private key to generate the signature from your server.<\/span><\/li>\n<\/ul>\n<p><strong>To register an app:<\/strong><\/p>\n<ol>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">Open the assistant that you are working with.<\/span><\/li>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">Select the <\/span><strong>Deploy <\/strong><span style=\"font-weight: 400;\">tab from the top menu.<\/span><\/li>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">From the left menu, click <\/span><strong>Channel &gt; Web\/Mobile<\/strong><span style=\"font-weight: 400;\"> Client.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221005051621\/add-app-1-1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-48094\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221005051621\/add-app-1-1.png\" alt=\"\" width=\"548\" height=\"458\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221005051621\/add-app-1-1.png 712w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20221005051621\/add-app-1-1-300x251.png 300w\" sizes=\"auto, (max-width: 548px) 100vw, 548px\" \/><\/a><br \/>\n<\/span><\/li>\n<li style=\"font-weight: 400;\"><span style=\"font-weight: 400;\">In the <\/span><strong>Select App<\/strong><span style=\"font-weight: 400;\"> drop-down list, select your existing app registration or click <\/span><strong>Create App<\/strong><span style=\"font-weight: 400;\"> to create a new app.<\/span><span style=\"font-weight: 400;\"><br \/>\n<\/span><br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807075634\/Web_SDK_Client_App.png\"><img loading=\"lazy\" decoding=\"async\" width=\"745\" height=\"586\" class=\"alignnone size-medium wp-image-58556\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807075634\/Web_SDK_Client_App.png\" alt=\"\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807075634\/Web_SDK_Client_App.png 745w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807075634\/Web_SDK_Client_App-300x236.png 300w\" sizes=\"auto, (max-width: 745px) 100vw, 745px\" \/><\/a><\/li>\n<li>In the <strong>Name<\/strong> field, enter the name for the app registration used in Bot Builder. For example, <strong>weather app<\/strong>.<\/li>\n<li>Select one of these scopes for the app:\n<ul>\n<li><strong>Allow anonymous users to chat with the bot<\/strong>: Enables anonymous users to interact with the bot.<\/li>\n<li><strong>Auto register new users on Kore.ai Bots Platform<\/strong>:\u00a0Select to control the auto-user registration in Kore.ai if the user assertion is unknown.<\/li>\n<\/ul>\n<\/li>\n<li>In the <strong>JWT Signing<\/strong> <strong>Algorithms Used For Client App Authentication<\/strong>\u00a0drop-down list, select one of the following security algorithms:\n<ul>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><b>RS256\/<\/b><b>RS512<\/b><b>: <\/b><span style=\"font-weight: 400;\">Select to enable the <\/span><b>Public Key.<\/b> <i><span style=\"font-weight: 400;\">The Private key, used for encryption, is provided by the user, and the Public key, used for decryption, is provided by the Platform<\/span><\/i><span style=\"font-weight: 400;\">. Both the keys have to be used for generating the token.<\/span><span style=\"font-weight: 400;\"> The Public Key is used by the XO Platform to authenticate the client application.<\/span><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><b>HS256\/<\/b><b>HS512<\/b><b>:<\/b><span style=\"font-weight: 400;\"> Select to generate a <\/span><b>Secret Key <\/b><span style=\"font-weight: 400;\">and a <\/span><b>Client ID<\/b><span style=\"font-weight: 400;\">. The <\/span><b>Client ID<\/b><span style=\"font-weight: 400;\"> is required for app initialization, and the <\/span><b>Secret Key<\/b><span style=\"font-weight: 400;\"> is used by the XO Platform to authenticate the client application<\/span>.<\/li>\n<\/ul>\n<\/li>\n<li><span style=\"font-weight: 400;\">(Optional) In the <\/span><b>Push Notifications<\/b><span style=\"font-weight: 400;\"> section, click <\/span><b>Enable<\/b><span style=\"font-weight: 400;\"> and then specify a URL to send the notifications<\/span>.<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807080118\/Web_SDK_Client_App1.png\"><img loading=\"lazy\" decoding=\"async\" width=\"749\" height=\"825\" class=\"alignnone size-medium wp-image-58559\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807080118\/Web_SDK_Client_App1.png\" alt=\"\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807080118\/Web_SDK_Client_App1.png 749w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807080118\/Web_SDK_Client_App1-272x300.png 272w\" sizes=\"auto, (max-width: 749px) 100vw, 749px\" \/><\/a><\/li>\n<li style=\"font-weight: 400;\" aria-level=\"1\"><span style=\"font-weight: 400;\">When you Enable the Push Notifications, you can select one of the following options to manage the notifications:<\/span>\n<ul>\n<li aria-level=\"1\"><b>All Messages<\/b><span style=\"font-weight: 400;\"> &#8211; Sends push notifications for all conversation messages to the client app.<\/span><\/li>\n<li aria-level=\"1\"><b>Message Delivery Failures<\/b><span style=\"font-weight: 400;\"> &#8211; Sends push notifications for failure scenarios such as WebSocket Disconnected, App is Killed, and Message Delivery Failure.<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807081323\/Web_SDK_Client_App2.png\"><img loading=\"lazy\" decoding=\"async\" width=\"752\" height=\"821\" class=\"alignnone size-medium wp-image-58562\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807081323\/Web_SDK_Client_App2.png\" alt=\"\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807081323\/Web_SDK_Client_App2.png 752w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807081323\/Web_SDK_Client_App2-275x300.png 275w\" sizes=\"auto, (max-width: 752px) 100vw, 752px\" \/><\/a><\/span><\/li>\n<\/ul>\n<\/li>\n<li><span style=\"font-weight: 400;\">To customize the display messages for the push notifications messages sent to the client app, select one of the following options:<\/span>\n<ul>\n<li><b>Send Original Messages<\/b><span style=\"font-weight: 400;\"> &#8211; Sends the actual conversation message as part of the push notification.<\/span><\/li>\n<li><b>Show a standard message from standard responses<\/b><span style=\"font-weight: 400;\"> &#8211; Sends a generic message instead of the original message.<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807081734\/Web_SDK_Client_App3.png\"><img loading=\"lazy\" decoding=\"async\" width=\"747\" height=\"823\" class=\"alignnone size-medium wp-image-58565\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807081734\/Web_SDK_Client_App3.png\" alt=\"\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807081734\/Web_SDK_Client_App3.png 747w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807081734\/Web_SDK_Client_App3-272x300.png 272w\" sizes=\"auto, (max-width: 747px) 100vw, 747px\" \/><\/a><\/span><\/li>\n<li><span style=\"font-weight: 400;\">Click <\/span><b>Manage Responses<\/b><span style=\"font-weight: 400;\"> to add custom messages in the push notification. To learn more about adding responses, see <\/span><a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/bot-intelligence\/default-standard-responses\/\"><span style=\"font-weight: 400;\">Default Standard Responses<\/span><\/a><span style=\"font-weight: 400;\"> and <\/span><a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/bot-intelligence\/default-dialog\/\"><span style=\"font-weight: 400;\">Default Conversations<\/span><\/a><span style=\"font-weight: 400;\">.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807082646\/Web_SDK_Client_App4.png\"><img loading=\"lazy\" decoding=\"async\" width=\"835\" height=\"896\" class=\"alignnone size-medium wp-image-58568\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807082646\/Web_SDK_Client_App4.png\" alt=\"\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807082646\/Web_SDK_Client_App4.png 835w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807082646\/Web_SDK_Client_App4-280x300.png 280w\" sizes=\"auto, (max-width: 835px) 100vw, 835px\" \/><\/a><\/span><\/li>\n<\/ul>\n<\/li>\n<li><span style=\"font-weight: 400;\">Click <\/span><b>Save <\/b><span style=\"font-weight: 400;\">and then <\/span><b>Create<\/b><span style=\"font-weight: 400;\">. The app registration details appear<\/span>.<br \/>\n<a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807082905\/Web_SDK_Client_App5.png\"><img loading=\"lazy\" decoding=\"async\" width=\"1193\" height=\"888\" class=\"alignnone size-medium wp-image-58571\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807082905\/Web_SDK_Client_App5.png\" alt=\"\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807082905\/Web_SDK_Client_App5.png 1193w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807082905\/Web_SDK_Client_App5-300x223.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10-1\/wp-content\/uploads\/sites\/35\/20230807082905\/Web_SDK_Client_App5-1024x762.png 1024w\" sizes=\"auto, (max-width: 1193px) 100vw, 1193px\" \/><\/a><\/li>\n<li>To copy\u00a0the app registration details to the clipboard for your application, you can click <strong><span style=\"color: #333333;\">Copy<\/span><\/strong>\u00a0for\u00a0<strong>Bot Name<\/strong>, <strong>Bot ID<\/strong>, and\u00a0<strong>Client ID<\/strong>. For <strong>Client Secret<\/strong>, click <strong>View<\/strong>, and then click <strong>Copy<\/strong>.<\/li>\n<li>In the <strong>Allow Alert Task Setup<\/strong> section, select <strong>Yes<\/strong> to enable your application users to\u00a0set 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.<\/li>\n<li>In the <strong>Enable Channel<\/strong> section, select <strong>Yes<\/strong> to enable the channel immediately after saving.<\/li>\n<li>Click <strong>Save<\/strong> to save the settings and close the <strong>Web\/Mobile Client\u00a0Channel<\/strong> page.<\/li>\n<\/ol>\n<p><span style=\"font-weight: 400;\">The <\/span><em><span style=\"font-weight: 400;\">Channel Information updated successfully<\/span><\/em><span style=\"font-weight: 400;\"> message is displayed on the top-right corner of the page.<\/span><\/p>\n<p><span style=\"font-weight: 400;\">Once the app is registered, you can implement it using one of the methods presented under App Details, as follows:<\/span><\/p>\n<ol>\n<li style=\"font-weight: 400;\"><strong>Share the URL<\/strong><span style=\"font-weight: 400;\"> with the users to interact with your virtual assistant.<\/span><\/li>\n<li style=\"font-weight: 400;\"><strong>Embed HTML<\/strong><span style=\"font-weight: 400;\">: Copy and paste the HTML code before the end of the BODY tag on every page of the application where you want to display the chat widget. <\/span><a href=\"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/sdks\/kore-ai-web-sdk-tutorial\/\"><span style=\"font-weight: 400;\">Know more<\/span><\/a><\/li>\n<\/ol>\n<div class=\"w-separator size_small with_line width_default thick_1 style_solid color_border align_center\"><div class=\"w-separator-h\"><\/div><\/div>\n","protected":false},"excerpt":{"rendered":"<p>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 XO Platform. When you register your app, you will need to select a security algorithm: HS256 \/ HS512 \u2013 XO Platform generates and displays the Client ID and Client&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[36],"tags":[],"class_list":["post-17800","post","type-post","status-publish","format-standard","hentry","category-sdks"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/17800","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=17800"}],"version-history":[{"count":14,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/17800\/revisions"}],"predecessor-version":[{"id":59873,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/17800\/revisions\/59873"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=17800"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=17800"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=17800"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}