{"id":18058,"date":"2018-08-24T11:29:43","date_gmt":"2018-08-24T11:29:43","guid":{"rendered":"https:\/\/developer.kore.ai\/v9-3\/?post_type=docs&p=15176"},"modified":"2022-12-23T09:46:12","modified_gmt":"2022-12-23T09:46:12","slug":"apis","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v9-3\/docs\/bots\/api-guide\/apis\/","title":{"rendered":"Using Kore.ai APIs"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

The Kore.ai XO Platform allows you to develop Virtual Assistants using secured APIs. All key developer activities like creation, import and export, training, and publishing are available using these APIs. Key account management activities like managing XO Platform access, managing admin, and roles can also be performed via secured public APIs. For a complete list of APIs and usage instructions <\/span>refer here<\/span><\/a>.<\/span><\/p>\n

Authentication of the API requests involves the following two steps:<\/span><\/p>\n

    \n
  1. Creating an App<\/strong>: As a part of creating the app, you need to select the API scopes for the App, which allows you to provide access to only the selected APIs to the app.<\/span><\/li>\n
      \n
    1. XO Platform API Scopes<\/strong>: Assistant developers can define specific API Scopes from the XO Platform.<\/span><\/li>\n
    2. Bot Admin Console API Scopes<\/strong>: Account administrators can define API Scopes to access any of the assistants built in their accounts from the Admin Console.<\/span><\/li>\n<\/ol>\n
    3. Associate API Scopes to an App<\/strong>: To allow a client application to access the XO Platform APIs, you need to associate the client app with the assistant.<\/span><\/li>\n<\/ol>\n

      Additionally, you can secure the connections with the Platform by the following methods:<\/span><\/p>\n

        \n
      1. Enforce JTI Claim<\/strong> \u2013 Once enabled, the Platform would accept the requests only from calls with the JTI Claim in the requests and those without JTI Claim would be rejected<\/span><\/li>\n
      2. Enforce JWE Encryption<\/strong>\u2013 Generating JWT token: To access the XO Platform\u2019s public APIs, the application making the API request requires authentication. Kore.ai uses the JWT (JSON Web Token) mechanism to handle the authentication. For a quick overview of the JWT token, read <\/span>Introduction to JWT tokens<\/span><\/a>.<\/span>
        \n<\/span>Use the Client ID and Client Secret of the client app from above to generate a JWT token. This token needs to be passed as a part of each API request for authorization.<\/span><\/li>\n<\/ol>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n<\/div><\/div><\/div><\/div><\/div><\/section>
        <\/div><\/div>
        \r\n\t
        \r\n\t\t
        \r\n\t\t\t

        Creating & Managing Apps<\/span><\/span><\/h2>\n

        XO Platform<\/span><\/span><\/h3>\n

        The following steps let you create a Client App from the XO Platform:<\/span><\/p>\n

          \n
        1. Select <\/span>Deploy<\/strong> tab from the top menu<\/span><\/li>\n
        2. From the left menu, click <\/span>Integrations > Manage Apps<\/strong><\/li>\n
        3. Click <\/span>New App<\/strong>.<\/span><\/li>\n
        4. On the Create Client App page:<\/span><\/li>\n
            \n
          1. enter a <\/span>name<\/span><\/em> for the app,<\/span><\/li>\n
          2. enforce JTI and\/or JWE as per your requirements<\/span><\/li>\n<\/ol>\n
          3. Click <\/span>Next<\/strong> and <\/span>Done<\/strong>.
            \n\"\"<\/a>
            \n<\/span><\/li>\n
          4. You will be directed to the Manage Apps page, where all the apps associated with this assistant will be displayed.<\/span><\/li>\n
          5. Once you select an app, the Client ID and Client Secret sections appear. Here is where you will also find a list of places where this app is used, like web SDK, botkit SDK, etc.<\/span><\/li>\n
          6. You can also use this screen to <\/span>delete<\/strong> apps by using the trash icon against the respective app. <\/span>
            \n<\/span><\/p>\n\n\n\n
            Note<\/em><\/strong>, Only the Bot Owner can delete an app.<\/span><\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ol>\n

            \"\"<\/a><\/p>\n\n\n\n
            Note: Before the release of ver 7.3 of the Platform, apps were associated with the user. The apps have been associated with an assistant since the release of ver 7.3 of the Platform. Developers, other than the bot owner, with Apps and Scopes permission, will have access to these apps. To ensure backward compatibility, if an app is being used by more than one assistant, then the app will be duplicated with the same credentials for each of these assistants.<\/span><\/em><\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

            Bots Admin Console<\/span><\/span><\/h3>\n

            The following steps let you create a Client App from the Bot Admin Console:<\/span><\/p>\n

              \n
            1. On the side-navigation panel of the Bots Admin homepage, click <\/span>Security & Control > API Scopes<\/strong>.<\/span><\/li>\n
            2. On the API Scopes page, click <\/span>New<\/strong>.<\/span><\/li>\n
            3. To create a new app, click the<\/span> Manage Apps <\/strong>link.<\/span><\/li>\n
            4. Click <\/span>New App<\/strong>,<\/span><\/li>\n
                \n
              1. enter a name and<\/span><\/li>\n
              2. enforce JTI and\/or JWE as per your requirements<\/span><\/li>\n<\/ol>\n
              3. Click<\/span> Save<\/strong>.<\/span><\/li>\n<\/ol>\n

                Data Tables<\/span><\/span><\/h3>\n

                The Data table option has been added to the Platform in v7.3 of the Platform (<\/span>see here for more<\/span><\/a>). Access control to these would be different from the XO Platform and Bot Admin Console access controls.<\/span><\/p>\n

                You can define apps to securely access the data from data tables and data views.<\/span><\/p>\n