Search: वेब कहानियां एपीआई संदर्भ

ऐसी वेब कहानियां खोजें जो API अनुरोध में निर्दिष्ट खोज पैरामीटर से मेल खाती हों।

तरीकों

search

वेब कहानियों की सूची लौटाता है।

एपीआई अनुरोध

GET https://webstories.today/api/v1/search

मापदंडों

q	string, आवश्यक q पैरामीटर खोजने के लिए क्वेरी शब्द निर्दिष्ट करता है।
apikey	string, आवश्यक
category	string, वैकल्पिक StoryCategory संसाधन से displayname_encoded का उपयोग करें।
language	string, आवश्यक, चूक: en भाषा पैरामीटर निर्दिष्ट करता है कि किस भाषा में श्रेणी सूची वापस की जानी चाहिए।
maxresults	string, वैकल्पिक चूक: 10, max 50

अनुरोध निकाय

इस विधि को कॉल करते समय अनुरोध निकाय प्रदान न करें।

जवाब

निम्न तालिका इस संसाधन में दिखाई देने वाले गुणों को परिभाषित करती है:

title	string वेब कहानी का शीर्षक
description	string वेबस्टोरी का विवरण, अधिकतम 280 वर्ण लंबा
language	string कहानी की भाषा, 2 अक्षर का भाषा कोड।
url	string वेब कहानी का पूरा यूआरएल
channelinfo	ChannelInfo वेब स्टोरी के मालिक चैनल/निर्माता के बारे में जानकारी।
category	StoryCategory श्रेणी की जानकारी, वेब स्टोरी से संबंधित है।

सफल होने पर, यह विधि निम्नलिखित संरचना के साथ एक प्रतिक्रिया निकाय लौटाती है:

{
  "searchquery": "dogs",
  "searchcategory": "",
  "pagination": 1,
  "webstories": [
    {
      "title": "Amazing facts about dogs that are unbelievable.",
      "url": "fascinating-facts-about-dogs",
      "language": "en",
      "category": {
        "displayname": "Animals \u0026 Pets",
        "displayname_encoded": "pets"
      },
      "description": "Dogs are around us and are part of our family. They give unconditional love and companionship. Is there something far more than what we know about them?"
    },
    {
      "title": "Importance of dog toys and their role in development",
      "url": "importance-of-dog-toys",
      "language": "en",
      "category": {
        "displayname": "Animals \u0026 Pets",
        "displayname_encoded": "pets"
      },
      "description": "Dog toys play a crucial role in the proper growth of the dog."
    },
    {
      "title": "10 ways your dog says I LOVE YOU",
      "url": "10-ways-your-dog-says-i-love-you",
      "language": "en",
      "category": {
        "displayname": "Animals \u0026 Pets",
        "displayname_encoded": "pets"
      },
      "description": "Dogs are very communicative if you know how to read their expression. Here are 10 ways your dog is telling you he or she loves you"
    },
    {
      "title": "Why do dogs make the best emotional support companions?",
      "url": "why-do-dogs-make-the-best-emotional-support-companions",
      "language": "en",
      "category": {
        "displayname": "Animals \u0026 Pets",
        "displayname_encoded": "pets"
      },
      "description": "Companionship with dogs make us happy, healthier and more complete person."
    }
  ]
}