{"id":21759,"date":"2019-07-01T09:31:27","date_gmt":"2019-07-01T08:31:27","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?p=21759"},"modified":"2021-03-26T07:48:57","modified_gmt":"2021-03-26T07:48:57","slug":"api-collection","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/api-collection\/","title":{"rendered":"API Collection"},"content":{"rendered":"<section class=\"l-section wpb_row height_auto\"><div class=\"l-section-h i-cf\"><div class=\"g-cols vc_row type_default valign_top\"><div class=\"vc_col-sm-12 wpb_column vc_column_container\"><div class=\"vc_column-inner\"><div class=\"wpb_wrapper\">\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<p>Postman is a popular tool to help test and develop APIs. To make it more convenient for integration with the Kore.ai APIs, we&#8217;ve developed a Postman collection.<\/p>\n<p>The entire collection is divided into two categories:<\/p>\n<ol>\n<li>APIs which are related to the Bot Builder functionality;<\/li>\n<li>APIs related to the Admin Console functionality.<\/li>\n<\/ol>\n<p>For the complete list of APIs along with usage instructions, <a href=\"\/docs\/bots\/api-guide\/api-list\/\" target=\"_blank\" rel=\"noopener noreferrer\">refer here<\/a>.<\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\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>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h2><span class=\"ez-toc-section\" id=\"Getting_Started\">Getting Started<\/span><\/h2>\n<p>To get started, download the following and install Postman.<\/p>\n<ul>\n<li><a href=\"https:\/\/www.getpostman.com\/\" target=\"_blank\" rel=\"noopener noreferrer\">Postman App from here<\/a><\/li>\n<li><a href=\"https:\/\/github.com\/Koredotcom\/Public-APIs\" target=\"_blank\" rel=\"noopener noreferrer\">Kore.ai Postman Collection from here<\/a><\/li>\n<li>Go through the <a href=\"\/docs\/bots\/api-guide\/apis\/\" target=\"_blank\" rel=\"noopener noreferrer\">following document<\/a> for details on API Scope association and JWT token generation.<\/li>\n<\/ul>\n<p>Once you have Postman running, you can click &#8216;<strong>Import<\/strong>&#8216; and select the two JSON files in the Postman Collection package. After it has been imported, you should see &#8216;<em>Kore.ai Public APIs<\/em>&#8216; under <strong>Collections<\/strong> and also be able to select &#8216;<em>PublicAPIEnv<\/em>&#8216; as the <strong>Environment<\/strong>, as shown below:<\/p>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/16\/postman1.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-22098\" src=\"\/wp-content\/uploads\/sites\/16\/postman1.png\" alt=\"\" width=\"1365\" height=\"727\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/16\/20221201095958\/postman1.png 1365w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/16\/20221201095958\/postman1-300x160.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/16\/20221201095958\/postman1-1024x545.png 1024w\" sizes=\"auto, (max-width: 1365px) 100vw, 1365px\" \/><\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\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>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h2><span class=\"ez-toc-section\" id=\"Environment_Configuration\">Environment Configuration<\/span><\/h2>\n<p>Postman offers a configurable environment which is essentially a set of key-value pairs. It allows you to create commonly used variables that can be referenced across multiple requests. You can read <a href=\"https:\/\/learning.getpostman.com\/docs\/postman\/environments_and_globals\/manage_environments\/\" target=\"_blank\" rel=\"noopener noreferrer\">more about it here<\/a>.<\/p>\n<p>The pre-configured &#8216;<em>PublicAPIEnv<\/em>&#8216; environment contains a non-exhaustive set of variables that are referenced by the collection. Edit and replace these variables with your own values.<\/p>\n<p><strong>To edit the values:<\/strong><\/p>\n<ul>\n<li>either click the little <strong>eye button<\/strong> next to the environment dropdown and then <strong>edit<\/strong>,<\/li>\n<li>or <strong>hover<\/strong> over the variable you want to edit and click the <strong>edit icon<\/strong>.<\/li>\n<\/ul>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/16\/postman3.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-22107\" src=\"\/wp-content\/uploads\/sites\/16\/postman3.png\" alt=\"\" width=\"1363\" height=\"729\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/16\/20221201095957\/postman3.png 1363w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/16\/20221201095957\/postman3-300x160.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/16\/20221201095957\/postman3-1024x548.png 1024w\" sizes=\"auto, (max-width: 1363px) 100vw, 1363px\" \/><\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\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>\r\n\t<div class=\"wpb_text_column \">\r\n\t\t<div class=\"wpb_wrapper\">\r\n\t\t\t<h2><span class=\"ez-toc-section\" id=\"Testing_APIs\">Testing APIs<\/span><\/h2>\n<p>You can choose any of the APIs in the collection and <strong>Send<\/strong> the API request to test the same.\u00a0 Each API has a link to the developer docs for more details.<\/p>\n<p><a ref=\"magnificPopup\" href=\"\/wp-content\/uploads\/sites\/16\/postman2.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-22100\" src=\"\/wp-content\/uploads\/sites\/16\/postman2.png\" alt=\"\" width=\"1364\" height=\"726\" srcset=\"https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/16\/20221201095957\/postman2.png 1364w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/16\/20221201095957\/postman2-300x160.png 300w, https:\/\/kore-wordpress.s3.us-east-2.amazonaws.com\/developer.kore.ai\/wp-content\/uploads\/sites\/16\/20221201095957\/postman2-1024x545.png 1024w\" sizes=\"auto, (max-width: 1364px) 100vw, 1364px\" \/><\/a><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\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><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"Postman is a popular tool to help test and develop APIs. To make it more convenient for integration with the Kore.ai APIs, we've developed a Postman collection. The entire collection is divided into two categories: APIs which are related to the Bot Builder functionality; APIs related to the Admin Console functionality. For the complete list...","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-21759","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/21759","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/comments?post=21759"}],"version-history":[{"count":12,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/21759\/revisions"}],"predecessor-version":[{"id":22880,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/21759\/revisions\/22880"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=21759"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=21759"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=21759"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}