Elpub API

Version 0.2

JSON API

Обращение к API реализовано посредством GET запросов.

Адрес API http://api.elpub.ru/elpub/

Примечания

• многоязычные поля возвращаются в виде массива с элементами вида:
  • locale - код языка
  • setting_value - значение поля для этого языка
• все методы содержат в ответе параметр baseUrl
• все методы требуют параметров jabbr и jid

Методы

• journal
• issueList
• issue
• article
• search

journal

Описывает основную информацию о журнале.

Параметры:

• jabbr - аббревиатура названия журнала, берётся из настроек приложения
• jid - id журнала, берётся из настроек приложения

Возвращает объект со следующими полями:

• baseUrl - базовый url сайта, обязательный
• about_page - ссылка на страницу "о журнале", обязательный
• banners - html-код модуля баннеров
• cover - адрес каритнки с обложкой, обязательный, многоязчное поле
• onlineISSN, необязательный
• printISSN, необязательный
• current_issue - id текущего выпуска, обязательный
• title - название, многоязчное поле
• description - описание, многоязчное поле
• aimsAndScopes - цели журнала, многоязчное поле
• publisher - издатель, многоязчное поле
• publisher - редактор, многоязчное поле
• access - описание политики доступа, многоязычное поле
• years - начальный и конечный годы архива, массив:
  • start - первый год
  • end - последний год
  • last_issue - id последнего выпуска (по дате), обязательный
  • contacts - контакты, многоязчное поле

issueList

Возвращает список выпусков журнала

Параметры:

• jabbr - аббревиатура названия журнала, берётся из настроек приложения
• jid - id журнала, берётся из настроек приложения

Возвращает:

• issues - список журналов:
  • id - id выпуска, обязательный
  • title - название выпуска, многоязчное поле
  • filename - ссылка на обложку, многоязчное поле
  • volume - том
  • issue - номер
  • year - год
• baseUrl - базовый url сайта, обязательный

issue

Возвращает подробную информацию по выпуску

Параметры:

• jabbr - аббревиатура названия журнала, берётся из настроек приложения
• jid - id журнала, берётся из настроек приложения
• issue - id выпуска

Возвращает:

• volume - том
• issue - номер выпуска
• year - год
• filename - ссылка на обложку, многоязчное поле
• sections - список разделов выпуска:
  • id - id секции
  • title - название раздела, многоязчное поле
  • articles - список статей в разделе:
  • id - идентификатор статьи
  • title - название статьи, многоязчное поле
  • authors - авторы статьи (строкой), многоязчное поле
  • files - файлы статьи (как правило, pdf), многоязчное поле
• onlineISSN, необязательный
• printISSN, необязательный
• baseUrl - базовый url сайта, обязательный

article

Возвращает подробную информацию по статье

Параметры:

• jabbr - аббревиатура названия журнала, берётся из настроек приложения
• jid - id журнала, берётся из настроек приложения
• article - id статьи

Возвращает:

• id - идентификатор статьи
• title - название, многоязчное поле
• authors - авторы статьи - массив
  • id - идентификатор автора
  • name - имя, многоязчное поле
  • affiliation - адресные данные, многоязчное поле
• files - файлы статьи (как правило, pdf), многоязчное поле
• authors_short - авторы статьи (строкой), многоязчное поле
• abstract - аннотация к статье, многоязчное поле
• doi
• url - ссылка на статью
• citations - библиографические ссылки статьи, многоязчное поле (ВАЖНО: setting_value содержит, не текстовое значение, а список, чтобы можно было отделять цитаты)
• issue - выпуск
  • id - id выпуска, обязательный
  • title - название выпуска, многоязчное поле
  • filename - ссылка на обложку, многоязчное поле
  • volume - том
  • issue - номер
  • year - год
• jTitle - название журнала, многоязчное поле
• baseUrl - базовый url сайта, обязательный

search

Поиск

Параметры:

• jabbr - аббревиатура названия журнала, берётся из настроек приложения
• jid - id журнала, берётся из настроек приложения
• query - поисковый запрос

Возвращает:

• results - список результатов поиска
  • title - название статьи
  • id - id статьи
  • authors - строка авторов
  • highlight - строка, содержащая найденый отрывок
• baseUrl - базовый url сайта, обязательный

checkPassword

Авторизация пользователя

Параметры:

• jabbr - аббревиатура названия журнала, берётся из настроек приложения
• jid - id журнала, берётся из настроек приложения
• login - логин пользователя
• hash - md5 hash от строки <login><password>

Возвращает:

• result - число, 1 - в случае успеха, 0 - в случае ошибки, обязательный
• baseUrl - базовый url сайта, обязательный

Примеры:

Общее инфо по журналу http://api.elpub.ru/elpub/journal?jabbr=rmt

Список выпусков http://api.elpub.ru/elpub/issueList?jabbr=rmt

Список статей в выпуске http://api.elpub.ru/elpub/issue?jabbr=rmt&issue=100

Статья http://api.elpub.ru/elpub/article?article=1435&jabbr=rmt

Поиск http://api.elpub.ru/elpub/search?query=test&jabbr=rmt

TO DO:

similar - метод, возвращающий похожие статьи