{"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":"2022-10-05T05:18:50","modified_gmt":"2022-10-05T04:18:50","slug":"sdk-app-registration","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10\/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\"><strong>HS256<\/strong><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\"><strong>RS256<\/strong><span style=\"font-weight: 400\"> \u2013 You 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 \/><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10\/wp-content\/uploads\/sites\/30\/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\/wp-content\/uploads\/sites\/30\/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\/wp-content\/uploads\/sites\/30\/20221005051621\/add-app-1-1.png 712w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10\/wp-content\/uploads\/sites\/30\/20221005051621\/add-app-1-1-300x251.png 300w\" sizes=\"auto, (max-width: 548px) 100vw, 548px\" \/><\/a><br \/><\/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 \/><\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">In the <\/span><strong>Name<\/strong><span style=\"font-weight: 400\"> field, enter the name for the app registration used in XO Platform, for example, <\/span><span style=\"font-weight: 400\">Weather app<\/span><span style=\"font-weight: 400\">.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">Select one of these scopes for the app:<\/span><\/li>\n<ol>\n<li style=\"font-weight: 400\"><strong>Allow anonymous users to chat with the assistant<\/strong><span style=\"font-weight: 400\">: enables anonymous users to interact with the assistant.<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>Auto <\/strong><span style=\"font-weight: 400\">register<\/span><strong> new users on Kore.ai XO Platform<\/strong><span style=\"font-weight: 400\">: Select to control the auto-user registration in Kore.ai if the user assertion is unknown.<\/span><\/li>\n<\/ol>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">In the JWT Signing <\/span><strong>Algorithms Used For Client App Authentication<\/strong><span style=\"font-weight: 400\"> drop-down list, select one of the two available security algorithms. <\/span><a href=\"https:\/\/developer.kore.ai\/v10\/docs\/bots\/api-guide\/apis\/#Generating_JWT_Token\"><span style=\"font-weight: 400\">Refer here on how to generate the below keys<\/span><\/a><span style=\"font-weight: 400\">. The algorithms are as follows:<\/span><\/li>\n<ol>\n<li style=\"font-weight: 400\"><strong>RS256: <\/strong><span style=\"font-weight: 400\">Select to enable the <\/span><strong>Public Key<\/strong><span style=\"font-weight: 400\"> field. The <\/span><strong>Public Key<\/strong><span style=\"font-weight: 400\"> is used by the Kore.ai XO Platform to authenticate the client application.<\/span><\/li>\n<li style=\"font-weight: 400\"><strong>HS256:<\/strong><span style=\"font-weight: 400\"> Select to generate a <\/span><strong>Secret Key <\/strong><span style=\"font-weight: 400\">and a <\/span><strong>Client ID<\/strong><span style=\"font-weight: 400\">. The <\/span><strong>Client ID<\/strong><span style=\"font-weight: 400\"> is required for SDK initialization, and the <\/span><strong>Secret Key<\/strong><span style=\"font-weight: 400\"> used by the Kore.ai XO Platform to authenticate the client application.<\/span><\/li>\n<\/ol>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">Optionally, In the <\/span><strong>Push Notifications<\/strong><span style=\"font-weight: 400\"> section, click <\/span><strong>Enable<\/strong><span style=\"font-weight: 400\"> and then specify a URL to send the notifications to.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">Click <\/span><strong>Create<\/strong><span style=\"font-weight: 400\">. The app registration details appear.<br \/><a ref=\"magnificPopup\" href=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10\/wp-content\/uploads\/sites\/30\/20221005051617\/app-details-2-2.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-48091\" src=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10\/wp-content\/uploads\/sites\/30\/20221005051617\/app-details-2-2.png\" alt=\"\" width=\"576\" height=\"522\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10\/wp-content\/uploads\/sites\/30\/20221005051617\/app-details-2-2.png 1193w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10\/wp-content\/uploads\/sites\/30\/20221005051617\/app-details-2-2-300x272.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/v10\/wp-content\/uploads\/sites\/30\/20221005051617\/app-details-2-2-1024x928.png 1024w\" sizes=\"auto, (max-width: 576px) 100vw, 576px\" \/><\/a><br \/><\/span><\/li>\n<li style=\"font-weight: 400\">To copy the app registration details to the clipboard for your application, you can click <strong>Copy<\/strong> for <strong>Bot Name<\/strong>, <strong>Bot ID<\/strong>, and <strong>Client ID<\/strong>. For <strong>Client Secret<\/strong>, click <strong>View<\/strong>, and then click <strong>Copy<\/strong>.<\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">In the <\/span><strong>Allow Alert Task Setup<\/strong><span style=\"font-weight: 400\"> section, Select <\/span><strong>Yes<\/strong><span style=\"font-weight: 400\"> 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 set up their own alerts.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">In the <\/span><strong>Enable Channel<\/strong><span style=\"font-weight: 400\"> section, select <\/span><strong>Yes<\/strong><span style=\"font-weight: 400\"> to enable the channel immediately after saving.<\/span><\/li>\n<li style=\"font-weight: 400\"><span style=\"font-weight: 400\">Click <\/span><strong>Save<\/strong><span style=\"font-weight: 400\"> to save the settings and close the <\/span><strong>Web\/Mobile Client Channel<\/strong><span style=\"font-weight: 400\"> page.<\/span><\/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\/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 \u2013 XO Platform generates and displays the Client ID and Client Secret necessary&#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\/wp-json\/wp\/v2\/posts\/17800","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10\/wp-json\/wp\/v2\/comments?post=17800"}],"version-history":[{"count":9,"href":"https:\/\/developer.kore.ai\/v10\/wp-json\/wp\/v2\/posts\/17800\/revisions"}],"predecessor-version":[{"id":48099,"href":"https:\/\/developer.kore.ai\/v10\/wp-json\/wp\/v2\/posts\/17800\/revisions\/48099"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10\/wp-json\/wp\/v2\/media?parent=17800"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10\/wp-json\/wp\/v2\/categories?post=17800"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10\/wp-json\/wp\/v2\/tags?post=17800"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}