Search: Referência da API de Histórias da Web

Pesquise Histórias da Web que correspondam aos parâmetros de pesquisa especificados em uma solicitação de API.

Métodos

search

Retorna uma lista de Web Stories.

Solicitação de API

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

Parâmetros

q	string, requeridos O parâmetro q especifica o termo de consulta a ser pesquisado.
apikey	string, requeridos
category	string, opcional Use o displayname_encoded do recurso StoryCategory.
language	string, requeridos, predefinição: en O parâmetro language especifica em qual idioma a lista de categorias deve ser retornada.
maxresults	string, opcional predefinição: 10, max 50

Corpo de solicitação

Não forneça um corpo de solicitação ao chamar este método.

Resposta

A tabela a seguir define as propriedades que aparecem no resultado da busca:

title	string Título da webstory
description	string A descrição das webstories, com no máximo 280 caracteres
language	string A linguagem da história, código de linguagem de 2 letras.
url	string O URL completo da história da web
channelinfo	ChannelInfo Informações sobre o canal/criador que possui a história na web.
category	StoryCategory Informações sobre a categoria à qual a história da web pertence.

Se for bem-sucedido, este método retorna um corpo de resposta com a seguinte estrutura:

{
  "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."
    }
  ]
}