Для интеграции контента Докусферы с Вашим сайтом Вы можете использовать специальный API (Интерфейс программирования приложений).
Адрес API сервера: http://leb.nlr.ru/ws/api
Из набора переменных формируется строка запроса, которая добавляется к адресу сервера.
Набор возможных переменных
- method (строка) - Обязательный параметр, определяющий что Вы хотите получить от API сервера.
- id (число) - Идентификатор документа.
- scope (строка) - Область выборки для getList. При использовании с getSearchResults позволяет проводить поиск среди коллекций или меток. Принимает значения collection или tag.
- sid (число) - Идентификатор коллекции или метки. Используется вместе со scope.
- s (строка) - Сортировка документов. Возможные значения: views - по количеству просмотров; discussed - по количеству коментариев; liked - по рейтигу; favorites - по закладкам на документы; pubyear - по году публикации; alphAU - по алфавиту авторов; alphTL - по алфавиту заглавий; random - случайном порядке. При сортировке коллекций может быть alph - по алфавиту, docs - по количеству документов.
- t (строка) - Временной интервал. Возможные значения: today - за последние 24 часа; month - за месяц.
- lid (число) - Идентификатор языка документа. Выводит записи только с этим языком. Может быть получен из запроса getLanguages.
- oid (число) - Идентификатор владельца документа. Выводит записи, принадлежащие только этому владельцу. Например РНБ - 1.
- rid (число) - Идентификатор рубрикатора. Выводит записи только из этого рубрикатора. Может быть получен из запроса getCollections.
- vac (число) - Уровень доступа к документу. 1 - полный, 2 - ограниченный, 3 - только из ВЧЗ.
- mtp (число) - Медиатип документа. 1 - текст, 2 - изображение, 2 - аудио.
- py1 (число) - Выводить документы с годом издания большк заданного
- py2 (число) - Выводить документы с годом издания меньше заданного
- pp (число) - Количество страниц в документе. 1 - маленькие, 2 - средние, 3 - большие.
- ipp (число) - Документов на странице. Не может быть больше 100.
- page (число) - Страница
- letter (строка) - Первая буква названия коллекции в кодировке UTF-8.
- query (строка) - Поисковая строка в UTF-8. Правила формирования можно прочитать на странице поиска
- ssort (строка) - Сортировка результатов поиска. Может принимать значения: rel - по релевантности; au - по алфавиту авторов; date - по дате.
- cid (число) - Идентификатор коллекции для ограничения области поиска документов. Может быть получен из запроса getCollections.
Возможные методы API и дополнительные параметры
getCollections - Получение списка коллекций.
http://leb.nlr.ru/ws/api/?method=getCollections
Структура ответа сервера
http://leb.nlr.ru/ws/api/?method=getComments
Структура ответа сервера
http://leb.nlr.ru/ws/api/?method=getDoc
Структура ответа сервера
http://leb.nlr.ru/ws/api/?method=getLanguages
Структура ответа сервера
getList - Получение списка документов.
http://leb.nlr.ru/ws/api/?method=getList
Структура ответа сервера
http://leb.nlr.ru/ws/api/?method=getRubricator
Структура ответа сервера
http://leb.nlr.ru/ws/api/?method=getSearchResults
Структура ответа сервера
http://leb.nlr.ru/ws/api/?method=getTags
Структура ответа сервера
http://leb.nlr.ru/ws/api/?method=getCollections
Структура ответа сервера
- oid
- s =(alph|docs)
- letter
- ipp
- page
http://leb.nlr.ru/ws/api/?method=getComments
Структура ответа сервера
- id - обязательный параметр
- ipp
- page
http://leb.nlr.ru/ws/api/?method=getDoc
Структура ответа сервера
- id - обязательный параметр
http://leb.nlr.ru/ws/api/?method=getLanguages
Структура ответа сервера
getList - Получение списка документов.
http://leb.nlr.ru/ws/api/?method=getList
Структура ответа сервера
- scope =(collection|tag)
- sid
- s =(views|discussed|liked|favorites|pubyear|alphAU|alphTL|random)
- t =(today|month)
- lid
- oid
- vac =(1|2|3)
- mtp =(1|2|3)
- rid
- pp =(1|2|3)
- ipp
- page
http://leb.nlr.ru/ws/api/?method=getRubricator
Структура ответа сервера
- rid - обязательный параметр
http://leb.nlr.ru/ws/api/?method=getSearchResults
Структура ответа сервера
- query - обязательный параметр
- scope =(collection|tag)
- ssort =(rel|au|date)
- cid
- lid
- oid
- vac =(1|2|3)
- mtp =(1|2|3)
- py1
- py2
- pp =(1|2|3)
- ipp
- page
http://leb.nlr.ru/ws/api/?method=getTags
Структура ответа сервера
- oid
Примеры запросов
http://leb.nlr.ru/ws/api/?method=getList&t=today&s=views - самые читаемые документы за последние сутки
http://leb.nlr.ru/ws/api/?method=getCollections&letter=П - список коллекций на букву П
http://leb.nlr.ru/ws/api/?method=getSearchResults&query=Петербург - поиск документов по слову Петербург
