------------- From the MSDOS command window, type in the following curl commands: -------------- 1) To authenticate with API user: qcapi with password: OKCStest1 curl -X POST https://xyz-23a-ka-irs.custhelp.com/km/api/latest/auth/integration/authorize -H "Accept: application/json" -H "Content-Type: application/json" -H "kmauthtoken: {\"siteName\":\"xyz_23a_ka\"}" -d "{\"login\": \"qcapi\", \"password\": \"OKCStest1\", \"siteName\": \"xyz_23a_ka\"}" ==> {"authenticationToken":"bGl2ZXRlc3RfMjNhX2thOmZkVXI0WVptUXd0S2VZOUg0cGFKL1QwSU9sQ2F3ZTgyNnBRamZNYTNvZkJ0aHFBUkxVdFRUMXlqOXBaQUV5YkQ4QmhBMExVRDZ1UTJWMTNMQTJVd1NQeGovYytzZ05UNFd6NlFEWWtFbFNZYzY4OEorU0tuSWNCY1ZUUExlcVdyU1V6YjZOQjNQOEwyWDl3NzhJOU4wclcvbUZ0Nk8xNm45Vk02WjhRbzl3ND0="} 2) To authorize(impersonate) with Console (or Contact) user for the subsequent KA REST API calls. For this case, I choose to authorize with Console user: dev_Rnt with password: 5HuZv5HS curl -X POST https://xyz-23a-ka-irs.custhelp.com/km/api/latest/auth/authorize -H "Accept: application/json" -H "kmauthtoken: {\"siteName\":\"xyz_23a_ka\",\"integrationUserToken\":\"bGl2ZXRlc3RfMjNhX2thOmZkVXI0WVptUXd0S2VZOUg0cGFKL1QwSU9sQ2F3ZTgyNnBRamZNYTNvZkJ0aHFBUkxVdFRUMXlqOXBaQUV5YkQ4QmhBMExVRDZ1UTJWMTNMQTJVd1NQeGovYytzZ05UNFd6NlFEWWtFbFNZYzY4OEorU0tuSWNCY1ZUUExlcVdyU1V6YjZOQjNQOEwyWDl3NzhJOU4wclcvbUZ0Nk8xNm45Vk02WjhRbzl3ND0=\"}" -d "userName=dev_Rnt&password=5HuZv5HS&siteName=xyz_23a_ka&userExternalType=ACCOUNT" ==> {"authenticationToken":"{\"localeId\":\"en_US\",\"knowledgeInteractionId\":null,\"interactionIdGenerated\":null,\"appId\":null,\"siteName\":\"xyz_23a_ka\",\"interfaceId\":null,\"requiresBillable\":null,\"captureAnalytics\":null,\"integrationUserToken\":null,\"userToken\":\"r9JYhJJfQR7wa9IH+LDMFrdk6Tk41ttXJ6KG9HOWoz9nqJ/hg5OWoAS4ODoT4SS2h/rNs+nK8hI5zR2DDeldp7a3szyurESZDnvwP4tN/TAvaOYMhR6CWqeHVYvbxzxLpZsMFBhECArTlLlQqP0ipQ==\",\"referrer\":null,\"querySource\":null,\"clientIP\":null,\"localeOverride\":null}","user":{"recordId":"4B474D0DF88648E9A42A04F76E384814","name":"Rnt_dev Rnt_dev","email":"invalid.email@rnt.invalid","externalId":30,"externalType":"ACCOUNT","isActive":true,"isLocked":false,"adminUser":true,"banUser":false,"dateAdded":"2023-04-25T19:30:24-0400","dateModified":"2023-04-25T19:38:12-0400","firstName":"Rnt_dev","isDefaultAdministrator":false,"lastName":"Rnt_dev","login":"dev_Rnt","canReceiveEmailNotificationsForAssignedTasks":true,"canReceiveEmailNotificationsForTasksICanPerform":true,"reputationPoints":10,"showEmail":false,"showName":false,"subscribeOnTopicCreation":false,"subscribeOnTopicReply":false,"subscriptionSchedule":1,"defaultLocale":{"recordId":"en_US"}}} 3) Now we are invoking the subsequent KA REST API calls (as Console user: dev_Rnt with whatever its security roles/permissions). For this case, I simply get/retrieve the published KB12 answer curl -X GET https://xyz-23a-ka-irs.custhelp.com/km/api/latest/content/docId/KB12? -H "Content-Type: application/json" -H "kmauthtoken: {\"siteName\":\"xyz_23a_ka\", \"interfaceId\":1, \"integrationUserToken\":\"bGl2ZXRlc3RfMjNhX2thOmZkVXI0WVptUXd0S2VZOUg0cGFKL1QwSU9sQ2F3ZTgyNnBRamZNYTNvZkJ0aHFBUkxVdFRUMXlqOXBaQUV5YkQ4QmhBMExVRDZ1UTJWMTNMQTJVd1NQeGovYytzZ05UNFd6NlFEWWtFbFNZYzY4OEorU0tuSWNCY1ZUUExlcVdyU1V6YjZOQjNQOEwyWDl3NzhJOU4wclcvbUZ0Nk8xNm45Vk02WjhRbzl3ND0=\", \"userToken\" : \"r9JYhJJfQR7wa9IH+LDMFrdk6Tk41ttXJ6KG9HOWoz9nqJ/hg5OWoAS4ODoT4SS2h/rNs+nK8hI5zR2DDeldp7a3szyurESZDnvwP4tN/TAvaOYMhR6CWqeHVYvbxzxLpZsMFBhECArTlLlQqP0ipQ==\"}" ==> 01023237aedbd6018723c726b8007978 01023237aedbd6018723c726b8007973 KB12 My REST API Search test document 1.0 1000023 en_US canonical https://xyz-23a-ka-irs.custhelp.com:443/km/api/latest/locales/en_US application/json, application/xml GET 2023-04-25T19:38:12-0400 canonical https://xyz-23a-ka-irs.custhelp.com:443/km/api/latest/content/01023237aedbd6018723c726b8007978 application/json, application/xml GET collection https://xyz-23a-ka-irs.custhelp.com:443/km/api/latest/content application/json, application/xml GET https://xyz-23a-ka-irs.custhelp.com:443/km/api/latest/metadata-catalog/content 0102323b6a84130186145bb151007fe0 KB KB canonical https://xyz-23a-ka-irs.custhelp.com:443/km/api/latest/contentTypes/0102323b6a84130186145bb151007fe0 application/json, application/xml GET PRIORITY_0 2023-04-25T19:38:11-0400 2023-04-25T19:38:11-0400 2023-04-25T19:38:12-0400 2023-04-25T19:36:00-0400 9999-12-31T00:00:00-0500 4B474D0DF88648E9A42A04F76E384814 Rnt_dev Rnt_dev invalid.email@rnt.invalid 30 ACCOUNT canonical https://xyz-23a-ka-irs.custhelp.com:443/km/api/latest/users/4B474D0DF88648E9A42A04F76E384814 application/json, application/xml GET 4B474D0DF88648E9A42A04F76E384814 Rnt_dev Rnt_dev invalid.email@rnt.invalid 30 ACCOUNT canonical https://xyz-23a-ka-irs.custhelp.com:443/km/api/latest/users/4B474D0DF88648E9A42A04F76E384814 application/json, application/xml GET 4B474D0DF88648E9A42A04F76E384814 Rnt_dev Rnt_dev invalid.email@rnt.invalid 30 ACCOUNT canonical https://xyz-23a-ka-irs.custhelp.com:443/km/api/latest/users/4B474D0DF88648E9A42A04F76E384814 application/json, application/xml GET true false 2023-04-25T19:38:11-0400 false 1.0 HISTORICAL_USEFULNESS false https://xyz-23a-ka-as.custhelp.com/fas/resources/xyz_23a_ka/content/draft/01023237aedbd6018723c726b8007978/01023237aedbd6018723c726b8007973/ false 45DD7D2B3F444DDBAE0777F81B4E442A RN_PRODUCT_3 003 Application 3 PRODUCT canonical https://xyz-23a-ka-irs.custhelp.com:443/km/api/latest/categories/45DD7D2B3F444DDBAE0777F81B4E442A application/json, application/xml GET 5E4433778E274985B0D34AB050E1B9BD RN_CATEGORY_7 007 Support 7 CATEGORY canonical https://xyz-23a-ka-irs.custhelp.com:443/km/api/latest/categories/5E4433778E274985B0D34AB050E1B9BD application/json, application/xml GET C298151ACCE74194900D044087E9C6A1 RN_CATEGORY_4 004 Purchase 4 CATEGORY canonical https://xyz-23a-ka-irs.custhelp.com:443/km/api/latest/categories/C298151ACCE74194900D044087E9C6A1 application/json, application/xml GET 0102323b6a84130186145bb151007fef DEFAULT Default canonical https://xyz-23a-ka-irs.custhelp.com:443/km/api/latest/views/0102323b6a84130186145bb151007fef application/json, application/xml GET 92CB7C7C60BD455A8F0AC07DE7D82E74 TENANT xyz_23a_ka canonical https://xyz-23a-ka-irs.custhelp.com:443/km/api/latest/views/92CB7C7C60BD455A8F0AC07DE7D82E74 application/json, application/xml GET 4) KA REST API get initial KA Search session & transaction id (mostly for KA Search Analytics data tracking for subsequent KA REST API Search calls) curl -X POST https://xyz-23a-ka-qp.custhelp.com/srt/api/v1/search/initialScreen -H "Accept: application/xml" -H "Content-Type: application/json" -H "kmauthtoken: {\"siteName\":\"xyz_23a_ka\", \"interfaceId\":1, \"integrationUserToken\" : \"bGl2ZXRlc3RfMjNhX2thOmZkVXI0WVptUXd0S2VZOUg0cGFKL1QwSU9sQ2F3ZTgyNnBRamZNYTNvZkJ0aHFBUkxVdFRUMXlqOXBaQUV5YkQ4QmhBMExVRDZ1UTJWMTNMQTJVd1NQeGovYytzZ05UNFd6NlFEWWtFbFNZYzY4OEorU0tuSWNCY1ZUUExlcVdyU1V6YjZOQjNQOEwyWDl3NzhJOU4wclcvbUZ0Nk8xNm45Vk02WjhRbzl3ND0=\", \"userToken\" : \"r9JYhJJfQR7wa9IH+LDMFrdk6Tk41ttXJ6KG9HOWoz9nqJ/hg5OWoAS4ODoT4SS2h/rNs+nK8hI5zR2DDeldp7a3szyurESZDnvwP4tN/TAvaOYMhR6CWqeHVYvbxzxLpZsMFBhECArTlLlQqP0ipQ==\"}" -d "{\"session\":\"1\"}" ==> 24983982d41af8-398d-45c0-a279-c039644aab681444908172-1 5) Simple KA Search REST API query with question: REST API Search curl -X POST https://xyz-23a-ka-qp.custhelp.com/srt/api/v1/search/question?question=REST+API+Search^&startOverFlag -H "Accept: application/xml" -H "Content-Type: application/json" -H "kmauthtoken: {\"siteName\":\"xyz_23a_ka\", \"interfaceId\":1, \"integrationUserToken\" : \"bGl2ZXRlc3RfMjNhX2thOmZkVXI0WVptUXd0S2VZOUg0cGFKL1QwSU9sQ2F3ZTgyNnBRamZNYTNvZkJ0aHFBUkxVdFRUMXlqOXBaQUV5YkQ4QmhBMExVRDZ1UTJWMTNMQTJVd1NQeGovYytzZ05UNFd6NlFEWWtFbFNZYzY4OEorU0tuSWNCY1ZUUExlcVdyU1V6YjZOQjNQOEwyWDl3NzhJOU4wclcvbUZ0Nk8xNm45Vk02WjhRbzl3ND0=\", \"userToken\" : \"r9JYhJJfQR7wa9IH+LDMFrdk6Tk41ttXJ6KG9HOWoz9nqJ/hg5OWoAS4ODoT4SS2h/rNs+nK8hI5zR2DDeldp7a3szyurESZDnvwP4tN/TAvaOYMhR6CWqeHVYvbxzxLpZsMFBhECArTlLlQqP0ipQ==\"}" -d "{\"session\":\"24983982d41af8-398d-45c0-a279-c039644aab68\", \"transactionId\":\"1444908172\"}" ==> ANSWER0000.9894988536834717101unstructuredCMS-XML16777216100002383886110.9894988536834717<url>IM:KB:01023237aedbd6018723c726b8007978:en_US:published:KB12:1000023:1.0</url><type>STRING</type><snippets><snippets><text>My REST API Search test document</text><level>0</level></snippets></snippets>2023-04-25T16:38:12-0400IM:KB:01023237aedbd6018723c726b8007978:en_US:published:KB12:1000023:1.0?ui_mode=answer&prior_transaction_id=1444908172&iq_action=4&answer_id=16777216&turl=IM%3AKB%3A01023237aedbd6018723c726b8007978%3Aen_US%3Apublished%3AKB12%3A1000023%3A1.0?ui_mode=answer&prior_transaction_id=1444908172&iq_action=12&answer_id=16777216&related_ids=null?ui_mode=answer&prior_transaction_id=1444908172&iq_action=5&answer_id=16777216&highlight_info=8388611,6,11&turl=IM%3AKB%3A01023237aedbd6018723c726b8007978%3Aen_US%3Apublished%3AKB12%3A1000023%3A1.0#__highlightIM:KB:01023237aedbd6018723c726b8007978:en_US:published:KB12:1000023:1.0STRINGMy 1REST 3API 3Search 3test document 1DOC_TYPESDocument Types1falsefalsetruefalseDOC_TYPES.CMS-XMLArticle1falsefalsetruefalseCOLLECTIONSCollections1falsefalsetruetrueCOLLECTIONS.OKKB-KBKB1falsefalsetruefalseCMS-CATEGORY_REFCategories1falsefalsetruefalseCMS-CATEGORY_REF.RN_CATEGORY_4Purchase1falsefalsetruefalseCMS-CATEGORY_REF.RN_CATEGORY_7Support1falsefalsetruefalseCMS-PRODUCTProducts1falsefalsetruefalseCMS-PRODUCT.RN_PRODUCT_3Application1falsefalsetruefalsefalseREST API SearchREST API Search24983982d41af8-398d-45c0-a279-c039644aab6814449081721444908172