Smile )REST API


Umori.li предоставляет возможность внешним разработчикам программными средствами получать данные. Одним из способов такого взаимодействия является использование REST API, которое определяет набор функций, позволяющих совершать запросы и получать ответы. Взаимодействие происходит по протоколу HTTP.

Все вызовы методов API — это GET HTTP-запросы к URL http://www.umori.li/api с некоторым набором параметров.В ответ на запрос вы получаете его результат в формате JSON. Кодировка результата — UTF-8.

При использовании метода GET, данные запроса передаются в виде query-строки (после знака ?). Помните, что в случае GET-запроса, параметры должны быть закодированы с помощью URL encoding.

Получение источников данных

Для того чтобы получить перечень возможных источников данных с которых осуществляется сбор шуток, афоризмов, анекдотов и историй необходимо воспользоваться функцией sources

Параметры

Не заданы


Результат

Формат ответа для json-выдачи:

   [
      [
         {
            "site": SITE,
            "name": NAME,
            "url": URL,
            "parsel": PARSE_TAG,
            "encoding": ENCODING,
            "linkpar": PATH,
            "desc": DESC
         }
      ]
   ]
                       
SITE
Уникальное название источника данных (сайта в целом)- используется как параметр для get
NAME
Уникальное название источника данных (области информации на сайте)- используется как параметр для get
URL
HTTP-ссылка на источник данных
PARSE_TAG
Тэг по которому определяются данные для парсинга. Параметр необходим только для самостоятельного разбора данных из источника
ENCODING
Кодировка данных на стороне источника. Параметр необходим только для самостоятельного разбора данных из источника
PATH
Часть HTTP-ссылки в полном пути к данным для парсинга. Параметр необходим только для самостоятельного разбора данных из источника
DESC
Описание или название источника
   [
      [
         {
            "site": "bash.im",
            "name": "bash",
            "url": "http://bash.im",
            "parsel": ".text",
            "encoding": "windows-1251",
            "linkpar": "/quote/"
            "desc": "Цитатник Рунета"
         }
      ]
   ]
                           

Пример использования функции
   http://www.umori.li/api/sources
                           

Получение данных

Для получения данных из конкретного источника необходимо воспользоваться функцией get

Параметры
site
Уникальное название источника данных (сайта в целом)
name
Уникальное название источника данных (области информации на сайте)
num
Количество данных. По-умолчанию num=50

Результат

Формат ответа для json-выдачи:

   [
      {
         "site": SITE,
         "name": NAME,
         "desc": DESC,
         "link": LINK,
         "elementPureHtml": HTML_TEXT
      }
   ]
                       
SITE
Уникальное название источника данных (сайта в целом)- используется как параметр для get
NAME
Уникальное название источника данных (области информации на сайте)- используется как параметр для get
DESC
Описание или название источника
LINK
Часть HTTP-ссылки, добавляя которую к http://www.umori.li, можно получить прямую http-ссылку к данным
HTML_TEXT
Данные в текстовом формате с частью тегов для форматирования
   [
      {
         "site": "bash.im",
         "name": "bash",
         "desc": "Цитатник Рунета",
         "link": "/url.html?url=http%3A%2F%2Fbash.im%2Fquote%2F423692",
         "elementPureHtml": "Работаю в рекламе. Попросили клиента (ветеринарная клиника) прислать логотип фирмы. Прислали скан халата с логотипом..."
      }
   ]
                       

Пример использования функции
   http://www.umori.li/api/get?site=bash.im&name=bash&num=100
                           

Получение случайных данных

Для получения случайных данных из разных источника необходимо воспользоваться функцией random

Параметры
num
Количество данных. По-умолчанию num=50

Результат

Формат ответа для json-выдачи:

   [
      {
         "site": SITE,
         "name": NAME,
         "desc": DESC,
         "link": LINK,
         "elementPureHtml": HTML_TEXT
      }
   ]
                       
SITE
Уникальное название источника данных (сайта в целом)- используется как параметр для get
NAME
Уникальное название источника данных (области информации на сайте)- используется как параметр для get
DESC
Описание или название источника
LINK
Часть HTTP-ссылки, добавляя которую к http://www.umori.li, можно получить прямую http-ссылку к данным
HTML_TEXT
Данные в текстовом формате с частью тегов для форматирования
   [
      {
         "site": "shortiki.com",
         "name": "shortiki",
         "desc":"Шортики",
         "link": "/url.html?url=http%3A%2F%2Fshortiki.com%2Fshortik.php%3Fshortik%3D7058",
         "elementPureHtml": "Во время игры сборной России по футболу, комментатор выронил на себя кружку горячего чая. Так точно еще никто не описывал игру сборной России."
      }
   ]
                           

Пример использования функции
   http://www.umori.li/api/random?num=10