Руководство по использованию API сайта

API Интернет-портала Самарского университета предоставляет простой и удобный интерфейс для получения новостей университета в форматах JSON и XML для использования в вашем приложении или на сайте. Для этого на http://ssau.ru/api/news/ необходимо отправить HTTP GET запрос с необходимыми параметрами.

Список доступных параметров


Параметр

 

Тип

 

id

ID

int

Возвращает новость по идентификатору.

Значение по умолчанию: не определено.

q

Название

str

Используется для поиска новостей, название которых содержит определенную подстроку. Регистр символов при поиске не учитывается.

Значение по умолчанию: не определено.

limit

Лимит

int

limit определяет максимальное количество новостей в наборе результатов.

index определяет индекс первого результата в возращаемом наборе, т.е. используется для сдвига выборки соответствующих запросу результатов

Параметры index и limit могут использоваться как вместе, так и по отдельности.


Например, чтобы запросить второй десяток результатов (с 11 по 20), установите параметр max-results равным 10, а параметр start-index11.

Значения по умолчанию: index: 0, limit: 10. Максимальное значение limit = 50.

index

Индекс

int

date-start

Дата публикации (мин.)

str (YYYY-MM-DD)

date-start и date-end ограничивают поиск новостей, включая в набор только результаты, которые были опубликованы в какой-либо определенный промежуток времени.

date-start определяет начало этого периода, date-end - его конец.

Эти параметры могут использоваться как вместе, так и по отдельности.

Значения по умолчанию не определены.

date-end

Дата публикации (макс.)

str (YYYY-MM-DD)

type

Тип новости

str (all, news, announcements, sitenews)

Используется для включения в выборку только новостей определенного типа. Допустимые значения: all - все типы, news - новости, announcements - объявления, sitenews - новости портала.

Значение по умолчанию: all

tags

Теги

str

Тег или несколько тегов, разделенных запятыми. В тегах, содержащих пробелы, их следует заменять на _ (символ нижнего подчеркивания).

Значение по умолчанию: не определено.

lang

Язык

str (ru,en)

Используется для поиска новостей на определенном языке.

Доступные языки: ru - русский, en - английский.

Значение по умолчанию: ru

slideshow

Слайдшоу

bool

При значении true запрос будет возвращать только новости, для которых было включено отображение в слайдшоу на главной странице сайта университета.

Значение по умолчанию: false

xml

XML

bool

Этот параметр со значением true используется в том случае, если результаты необходимо получить в формате XML.

Значение по умолчанию: false.


Примеры запросов:


http://ssau.ru/api/news/&q=СГАУ&index=0&limit=10&date-start=2014-10-01&date-end=2016-12-01&type=all&lang=ru&tags=Олимпиада
Возвращает последние 10 русскоязычных новостей, объявлений и новостей портала с тегом “Олимпиада”, содержащих в заголовке подстроку “СГАУ”, даты публикации которых ограничены периодом с 1 октября 2014 года до 1 декабря 2015 года.

http://ssau.ru/api/news/&q=СГАУ&index=0&limit=10&date-start=2014-10-01&date-end=2016-12-01&type=all&lang=ru&tags=Олимпиада&xml=true
Этот запрос вернет тот же набор результатов, но в формате XML.

http://ssau.ru/api/news/&id=11111
Возвращает новость с id равным 11111.

Структура ответа сервера:


JSON [ { "id":"11113", "title":"В СГАУ завершилась первая олимпиада по бизнес-процессам", "descr":" Победили студенты из Москвы и Йошкар-Олы", "pubText":"
Мероприятие организовала и провела кафедра менеджмента СГАУ. В ней приняли участие команды из Астрахани, Йошкар-Олы, Москвы и Самары.

СГАУ выставил две команды, в составе которых вошли Никита Безгин и Денис Бугаев, Анастасия Милордова и Айнура Ташпанова. Олимпиада проходила на базе компьютерной деловой игры «БИЗНЕС-КУРС: Максимум».]]>", "pubDate":"2014-12-17 13:24:26", "pic":"http://ssau.ru/uploads/2a0fae03646faddd6ceb3b378b792f1b.jpg", "type":"Новость", "slideshow":"0", "slide":"", "tags":"Олимпиада,кафедра_менеджмента", "url":"http://ssau.ru/news/11113-V-SGAU-zavershilas-pervaya-olimpiada-po-biznes-processam" }, { "id":"11103", "title":"В СГАУ впервые пройдёт студенческая олимпиада по бизнес-процессам", "descr":"Олимпиада проводится на базе компьютерной деловой игры «БИЗНЕС-КУРС: Максимум»", "pubText":"
Олимпиада проводится на базе компьютерной деловой игры «БИЗНЕС-КУРС: Максимум» версия 1.4.

Мероприятие состоится 16-17 декабря 2014 года.

О своём участии заявили команды из Самары, Москвы, Йошкар-Олы, Астрахани.

Организаторы олимпиады: профессор Е.А. Ефимова, доцент Г.Б. Свиридова, старший преподаватель Н.В. Шекина.

Председатель жюри - профессор Н.Н. Османкин, заместитель председателя жюри - декан ФЭУ О.В. Павлов.
]]>", "pubDate":"2014-12-15 10:52:59", "pic":"http://ssau.ru/uploads/be7b84be7a893070f687d2ad955ce908.jpg", "type":"Объявление", "slideshow":"0", "slide":"", "tags":"Олимпиада,Факультет_экономики_и_управления", "url":"http://ssau.ru/news/11103-V-SGAU-vpervye-proydet-studencheskaya-olimpiada-po-biznes-processam" } ]


XML <?xml version="1.0" encoding="UTF-8"?> <items> <item> <id>11113</id> <title>В СГАУ завершилась первая олимпиада по бизнес-процессам</title> <descr> Победили студенты из Москвы и Йошкар-Олы</descr> <pubText><![CDATA[16 декабря состоялась I межрегиональная студенческая олимпиада «Управление изменениями и организационное поведение в бизнесе».<br />]]></pubText> <pubDate>2014-12-17 13:24:26</pubDate> <pic>http://ssau.ru/uploads/2a0fae03646faddd6ceb3b378b792f1b.jpg</pic> <type>Новость</type> <slideshow>0</slideshow> <slide></slide> <tags>Олимпиада,кафедра_менеджмента</tags> <url>http://ssau.ru/news/11113-V-SGAU-zavershilas-pervaya-olimpiada-po-biznes-processam</url> </item> <item> <id>11103</id> <title>В СГАУ впервые пройдёт студенческая олимпиада по бизнес-процессам</title> <descr>Олимпиада проводится на базе компьютерной деловой игры «БИЗНЕС-КУРС: Максимум»</descr> <pubText><![CDATA[Кафедра менеджмента факультета экономики и управления СГАУ проводит I межрегиональную студенческую олимпиаду «Управление изменениями и организационное поведение в бизнесе».<br /> ]]></pubText> <pubDate>2014-12-15 10:52:59</pubDate> <pic>http://ssau.ru/uploads/be7b84be7a893070f687d2ad955ce908.jpg</pic> <type>Объявление</type> <slideshow>0</slideshow> <slide></slide> <tags>Олимпиада,Факультет_экономики_и_управления</tags> <url>http://ssau.ru/news/11103-V-SGAU-vpervye-proydet-studencheskaya-olimpiada-po-biznes-processam</url> </item> </items>

Поля результатов запроса:


id

Идентификатор новости

title

Заголовок

descr

Описание

pubText

Текст новости в HTML

pubDate

Дата и время публикации (YYYY-MM-DD hh:mm:ss)

pic

Изображение-миниатюра (thumbnail)

type

Тип новости (Новость, объявление, новость портала)

slideshow

Слайдшоу (0 по умолчанию, 1 - если новость отображалась в слайдшоу на главной странице сайта)

slide

Путь к прикрепленному слайду (для новостей, которые отображались в слайдшоу на главной странице сайта

tags

Список тегов, разделенных запятыми

url

Ссылка на новость