Search FAQ Content API

The Search FAQ Content API will help you get the contents related to the title provided.

Search FAQ Content.

POST https://kms-<sub domain>.kapturecrm.com/search-faq-contents.html

NOTE: Please replace with your sub domain name in the API.

Authentication:

To access this API endpoint, you need to include your API key in the request headers. For authentication, use the following header:

Basic <Your Token>

Request Body

There will be only one single parameter which will give you the content related to that specific FAQ

Name	Mandatory	Data Field	Description
Search	Yes	search_key	Search key takes the input of the title against which we need to seach the relevant contents for

Body Request

[
    {
        "search_key": "Metal"
    }
]

Response Body

The API responds with a JSON object containing the details of the all the contents inside that FAQ Title. If successful, the response will include the contents and the other relevant information.

Response	Response Messages
{ ..., "status": "success"}	List of customers fetched successfully.
{"message": "Invalid Auth Key","status": "failed"}	Authorization key is either not passed in header, or incorrect, or expired/disabled

Response

{
    "message": {
        "contents": [
            {
                "id": 18877,
                "title": "Are Melamine products stain proof?",
                "detail": "Melamine products are stain proof, to clean them well the user has to apply a light-duty sponge base scrubbing pad. However, excessive use of harsh abrasive cleaners, steel wool, or metal scouring pads on melamine products can lead to the removal of its top layer thus, accumulating dirt and retention of stains after continuous usage of the products.",
                "type": "FAQ",
                "categoryId": 5245,
                "categoryName": "FAQ - Milton",
                "parentCategoryName": "Milton",
                "enabled": "Yes",
                "createDate": "08 Dec, 2023 14:40",
                "attachmentDetail": ""
            },
            {
                "id": 18889,
                "title": "How to clean non-stick cookware?",
                "detail": "Refer the following steps to clean your non-stick cookware: - Allow the cookware to cool down after cooking. - Always use sponge or nylon scrubber to clean your non-stick cookware. - Do not use metal scrubber for cleaning.",
                "type": "FAQ",
                "categoryId": 5245,
                "categoryName": "FAQ - Milton",
                "parentCategoryName": "Milton",
                "enabled": "Yes",
                "createDate": "08 Dec, 2023 14:40",
                "attachmentDetail": ""
            },
            {
                "id": 18929,
                "title": "Features of Hard Anodized",
                "detail": "• Heavy gauge aluminium for even heat distribution & heat retention.\n• 2 times harder than any alloyed stainless steel which makes it durable against scratches\n• Metal spoon & spatula friendly surface for convenient cooking\n• Induction compatible*\n• Stainless steel lids for long lasting usage\n• Stainless steel Handle⁰\n• Cool bakelite handles for fry pan and kadhai",
                "type": "FAQ",
                "categoryId": 5246,
                "categoryName": "FAQ - Treo",
                "parentCategoryName": "Treo",
                "enabled": "Yes",
                "createDate": "11 Dec, 2023 12:42"
            },
            {
                "id": 18931,
                "title": "Features of Tri-ply stainless steel",
                "detail": "Tri-ply stainless steel\n• 3 layers of metal bounded together, 1st-food grade 18/8 stainless steel used in the inner surface for healthy cooking, it is the most superior stainless steel with the longest life\n• 2nd-encapsulated layer of aluminum right throughout the cookware including the bottom and the body, this helps in even heat distribution with less cooking time\n• 3rd -SS 430 magnetic stainless steel used as the 3rd layer, making cookware induction friendly, the cookware can also be used for conventional cooking \n• SS304 stainless steel lid for durability\n• Stainless steel casted long handle which are tough and durable\n• Ergonomically designed handles with air fins for better and easy gripping.\n• Free from any harmful chemical, Suitable for cooking on induction, Ceramic, Gas",
                "type": "FAQ",
                "categoryId": 5246,
                "categoryName": "FAQ - Treo",
                "parentCategoryName": "Treo",
                "enabled": "Yes",
                "createDate": "11 Dec, 2023 12:42"
            },
            {
                "id": 18936,
                "title": "What type of utensils to use on Non-Stick cookware?",
                "detail": "To increase your non-stick cookware life it is always recommended to use wooden, silicon or Nylon kitchen utensils. Metal utensils shorten the service life of\nyour cookware",
                "type": "FAQ",
                "categoryId": 5246,
                "categoryName": "FAQ - Treo",
                "parentCategoryName": "Treo",
                "enabled": "Yes",
                "createDate": "11 Dec, 2023 12:42"
            }
        ]
    },
    "status": "success"
}

Error Codes

Error Codes	Description
400	Bad Request - Invalid parameters or missing data
401	Unauthorized - Invalid or missing API key
403	Forbidden - Insufficient permissions
404	Not Found - Resource or endpoint not found
500	Internal Server Error - Server-side issue

Example of a working curl

cURL

curl --location 'kms-hamilton.kapturecrm.com/search-faq-contents.html' \
--header 'Authorization: Basic <Your Token>' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=; JSESSIONID=' \
--data '[
    {
        "search_key": "Metal"
    }
]'

Python

import requests
import json

url = "kms-hamilton.kapturecrm.com/search-faq-contents.html"

payload = json.dumps([
  {
    "search_key": "Metal"
  }
])
headers = {
  'Authorization': 'Basic <Your Token>',
  'Content-Type': 'application/json',
  'Cookie': 'JSESSIONID=; JSESSIONID='
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Node.js

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'kms-hamilton.kapturecrm.com/search-faq-contents.html',
  'headers': {
    'Authorization': 'Basic <Your Token>',
    'Content-Type': 'application/json',
    'Cookie': 'JSESSIONID=; JSESSIONID='
  },
  body: JSON.stringify([
    {
      "search_key": "Metal"
    }
  ])

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});