Описание использования базового API
Описание использования базового API
Материал добавлен: 14 Декабря 2022
Материал обновлен: 14 Декабря 2022
ОБЩАЯ ИНФОРМАЦИЯ
Базовое API предствляет собой интерфейс получения данных со страниц пользовательского сайта.
Это GET-only интерфейс, который позволяет только получать данные (страницы) модулей сайта, т.е. фактически работает с правами гостя (неавторизированного пользователя).
На данный момент он доступен в 11 модулях: blog, board, dir, gb, load, news, photo, publ, stuff, forum, index. Включение возможности использования API проводится в панеле управления сайтом в разделе “Настройки” - “Общие настройки” - “Использовать API”
По умолчанию его использование отключено.
КАК ИСПОЛЬЗОВАТЬ
Формат данных, которые отдаются API - XML-RPC. Все обращения (запросы) к интерфейсу выполняются посредством GET-запросов. Использовать данную функцию можно следующим образом:
http://SITE_ADDRESS/api/MODULENAME/ANYRELPATH
где:
- SITE_ADDRESS - адрес сайта пользователя, на котором используется API;
- MODULENAME – модуль сайта;
- ANYRELPATH – любая страница модуля, для которой разрешено использование API;
т.е. фактически, для использования интерфейса (если он активирован для сайта) достаточно вписать префикс /api/ между адресом сайта и именем модуля.
Пример использования:
Для получения, например, страницы:
http://blog.ucoz.ru/blog/ucoz_2010/2011-01-01-172
достаточно выполнить GET-запрос на:
http://blog.ucoz.ru/api/blog/ucoz_2010/2011-01-01-172
Пример использования api сторонними приложениям или скриптом:
http://phpexample.ucoz.net/publ/otobrazhenie_kontenta_po_kriteriju/1-1-0-10
ОПИСАНИЕ ВОЗВРАЩАЕМЫХ ДАННЫХ
API отдает данные для следующих типов страниц моделей сайта:
| Типы страниц | Модуль |
|---|---|
| страница рейтинга материала | blog, board, dir, load, news, photo, publ |
| страница материалов пользователя | blog, board, dir, load, news, photo, publ, stuff |
| страница конкретного материала | blog, board, dir, load, news, photo, publ, stuff |
| страница материалов за день | blog, news |
| страница материалов за месяц | blog, news |
| страница материалов из категории (альбома) | blog, board, dir, load, news, photo, publ, stuff |
| главная страница модуля | blog, board, dir, load, news, photo, publ, stuff, gb, forum |
| страница списка тем с постами пользователя, страница конкретного поста, страница с последними постами в теме, страница тем с поледними постами, страница списка участников, страница темы, страница форумов |
forum |
| страница информации о пользователе, история репутации, список пользователей, история предупреждений, страница комментариев пользователя, страница материалов пользователя, список онлайн пользователей, список неактивных материалов |
index |
Для страницы с материалом возвращается структура в теге
<struct>
со списком полей: именем поля name
<name>
и значением value
<value>
для страниц с несколькими записями (материалами) возвращается массив структур для каждой записи (материала) в теге
<array>
| Имя поля | Значение |
|---|---|
| BANCHANGE_NAME | пользователь, установивший предупреждение |
| BANCHANGE_PROFILE | профиль пользователя, установившего предупреждение |
| BANCHANGE_REASON | причина предупреждения |
| BANCHANGE_TIME | время предупреждения |
| BANCHANGE_VALUE | повышен или понижен уровень предупреждений (-1/0/1) |
| BRIEF | краткое описание материала |
| CATEGORY_NAME | имя категории материала |
| CATEGORY_URL | ссылка на страницу категории материала |
| COMMENTS_NUM | количество коментариев |
| COMMENTS_URL | ссылка на страницу с коментариями |
| COMMENT_ANSWER | ответ на комментарий |
| COMMENT_DATE | дата комментария |
| COMMENT_LINK | ссылка на комментарий |
| COMMENT_MESSAGE | текст коментария |
| COMMENT_RATE | рейтинг коментария |
| COMMENT_TIME | время коментария |
| COMMENT_USERIP | IP адрес автора коментария |
| DATE | дата создания материала |
| ENTRY_URL | ссылка на страницу материала |
| FORUM_DESCR | описание раздела форума |
| FORUM_LINK | ссылка на раздел форума |
| FORUM_NAME | название раздела форума |
| IMAGEX | изображения материала (где Х - номер изображения) |
| LASTPOST_AUTHOR | автор последнего поста |
| LASTPOST_AUTHORPROFILE | профиль автора последнего поста |
| LASTPOST_LINK | ссылка на последний пост |
| LASTPOST_TIME | время последнего поста |
| LASTTOPIC_LINK | ссылка на последнюю тему форума |
| LASTTOPIC_NAME | название последней темы форума |
| LOADS_NUM | количество загрузок материала |
| MATERIAL_ID | идентификатор материала для конкретного модуля |
| MESSAGE | текст или краткое описание материала |
| OTHERX | дополнительные поля (где Х - номер дополнительного поля) |
| PHOTO_HEIGHT | высота изображения |
| PHOTO_SIZE | размер изображения |
| PHOTO_URL | ссылка на изображение |
| PHOTO_WIDTH | ширина изображения |
| POST_DATE | дата поста |
| POST_DIRECTURL | ссылка на пост |
| POST_ID | идентификатор поста |
| POST_MESSAGE | текст поста |
| POST_NUMBER | порядковый номер поста |
| POST_TIME | время поста |
| POST_TIMESTAMP | время поста в формате timestamp |
| RATED | количество оценок материала |
| RATING | рейтинг материала |
| READS_NUM | количество прочтений материала |
| REPCHANGE_ANSWER | ответ на сообщение при смене репутации |
| REPCHANGE_ID | идентификатор сообщения о смене репутации |
| REPCHANGE_NAME | имя автора, изменившего репутацию |
| REPCHANGE_PROFILE | профиль автора, изменившего репутацию |
| REPCHANGE_REASON | причина изменения репутации |
| REPCHANGE_REF | ссылка на страницу, где была изменена репутация |
| REPCHANGE_TIME | время смены репутации |
| REPCHANGE_VALUE | повышение/понижение репутации (-1/0/1) |
| REPLIES_NUM | количестово ответов |
| RUNS_NUM | количество запусков приложения |
| TIME | время создания материала |
| TIMESTAMP | время создания материала в формате timestamp |
| TITLE | заголовок (тема, название) материала |
| TOPIC_DESCR | описание темы форума |
| TOPIC_LINK | ссылка на тему |
| TOPIC_NAME | название темы |
| TOPIC_NUMS | количество тем |
| TOPIC_PAGESNUM | количество страниц в теме |
| UNACTIVEBLOG_LINK | ссылка на страницу неактивных материалов в модуле blog |
| UNACTIVEBLOG_NUM | количество неактивных материалов в модуле blog |
| UNACTIVEBOARD_LINK | ссылка на страницу неактивных материалов в модуле board |
| UNACTIVEBOARD_NUM | количество неактивных материалов в модуле board |
| UNACTIVEDIR_LINK | ссылка на страницу неактивных материалов в модуле dir |
| UNACTIVEDIR_NUM | количество неактивных материалов в модуле dir |
| UNACTIVEFAQ_LINK | ссылка на страницу неактивных материалов в модуле faq |
| UNACTIVEFAQ_NUM | количество неактивных материалов в модуле faq |
| UNACTIVEGB_LINK | ссылка на страницу неактивных материалов в модуле gb |
| UNACTIVEGB_NUM | количество неактивных материалов в модуле gb |
| UNACTIVELOAD_LINK | ссылка на страницу неактивных материалов в модуле load |
| UNACTIVELOAD_NUM | количество неактивных материалов в модуле load |
| UNACTIVENEWS_LINK | ссылка на страницу неактивных материалов в модуле news |
| UNACTIVENEWS_NUM | количество неактивных материалов в модуле news |
| UNACTIVEPHOTO_LINK | ссылка на страницу неактивных материалов в модуле photo |
| UNACTIVEPHOTO_NUM | количество неактивных материалов в модуле photo |
| UNACTIVEPUBL_LINK | ссылка на страницу неактивных материалов в модуле publ |
| UNACTIVEPUBL_NUM | количество неактивных материалов в модуле publ |
| UNACTIVESTUFF_LINK | ссылка на страницу неактивных материалов в модуле stuff |
| UNACTIVESTUFF_NUM | количество неактивных материалов в модуле stuff |
| USERBLOGENTRIES_LINK | ссылка на страницу материалов пользователя в модуле blog |
| USERBLOGENTRIES_NUM | количество материалов пользователя в модуле blog |
| USERBOARDENTRIES_LINK | ссылка на страницу материалов пользователя в модуле board |
| USERBOARDENTRIES_NUM | количество материалов пользователя в модуле board |
| USERCOMMENTENTRIES_LINK | ссылка на страницу коментариев пользователя |
| USERCOMMENTENTRIES_NUM | количество коментариев пользователя |
| USERDIRENTRIES_LINK | ссылка на страницу материалов пользователя в модуле dir |
| USERDIRENTRIES_NUM | количество материалов пользователя в модуле dir |
| USERFORUMENTRIES_LINK | ссылка на страницу материалов пользователя в модуле forum |
| USERFORUMENTRIES_NUM | количество материалов пользователя в модуле forum |
| USERLOADENTRIES_LINK | ссылка на страницу материалов пользователя в модуле load |
| USERLOADENTRIES_NUM | количество материалов пользователя в модуле load |
| USERNEWSENTRIES_LINK | ссылка на страницу материалов пользователя в модуле news |
| USERNEWSENTRIES_NUM | количество материалов пользователя в модуле news |
| USERPHOTOENTRIES_LINK | ссылка на страницу материалов пользователя в модуле photo |
| USERPHOTOENTRIES_NUM | количество материалов пользователя в модуле photo |
| USERPUBLENTRIES_LINK | ссылка на страницу материалов пользователя в модуле publ |
| USERPUBLENTRIES_NUM | количество материалов пользователя в модуле publ |
| USERSTUFFENTRIES_LINK | ссылка на страницу материалов пользователя в модуле stuff |
| USERSTUFFENTRIES_NUM | количество материалов пользователя в модуле stuff |
| USER_AGE | возраст пользователя сайта |
| USER_AOL | AOL пользователя сайта |
| USER_AVATAR | аватар пользователя сайта |
| USER_AWARDS | количество наград пользователя сайта |
| USER_BANNEDTILL | дата разблокировки пользователя сайта |
| USER_BANRATING | рейтинг предупреждений пользователя сайта |
| USER_BIRTHDAY | дата рождения пользователя сайта |
| USER_CITY | город проживания пользователя сайта |
| USER_COUNTRY | страна проживания пользователя сайта |
| USER_EMAIL | электронная почта пользователя сайта |
| USER_GENDER | пол пользователя сайта |
| USER_GROUPID | идентификатор группы пользователя сайта |
| USER_GROUPNAME | название группы пользователя сайта |
| USER_HOMEPAGE | домашняя страница пользователя сайта |
| USER_ICQ | ICQ пользователя сайта |
| USER_ID | идентификатор пользователя сайта/автора материала |
| USER_IPADDRESS | IP адрес пользователя сайта |
| USER_ISVERIFIEDEMAIL | проверен ли электронная почта пользователя сайта |
| USER_LASTVISIT | дата последнего посещениая пользователя |
| USER_LOGTIMESTAMP | время последней авторизации пользователя сайта в формате timestamp |
| USER_MSN | MSN пользователя сайта |
| USER_NAME | имя пользователя сайта/автора материала (логин) |
| USER_POSTSNUM | количество сообщений пользователя сайта |
| USER_PROFILE | профиль пользователя сайта |
| USER_RANK | ранк пользователя сайта |
| USER_RANKNAME | название ранка пользователя сайта |
| USER_REGDATE | дата регистрации пользователя |
| USER_REGTIMESTAMP | время регистрации пользователя сайта в формате timestamp |
| USER_REPUTATION | репутация пользователя сайта |
| USER_SIGNATURE | подпись пользователя сайта |
| USER_STATUS | статус пользователя сайта |
| USER_UNETID | UNET идентификатор пользователя сайта |
| USER_UNETPROFILE | UNET профиль пользователя сайта |
| USER_USERNAME | полное имя пользователя сайта/автора материала |
| USER_YAHOO | YAHOO пользователя сайта |
| USER_ZODIAC | знак зодиака пользователя сайта |
| VIEWS_NUM | количество просмотров материала |
ДОПОЛНИТЕЛЬНАЯ ИНФОРМАЦИЯ
В ближайшее время возможность использования API будет добавлена еще в несколько других модулей системы. По мере добавления здесь будет изменяться и добавляться информация о его использовании.
ПОЛНАЯ ТАБЛИЦА СООТВЕТСТВИЯ ПОЛЕЙ СТРАНИЦАМ И МОДУЛЯМ
| Модуль | Страница (URL) | Поля |
|---|---|---|
|
blog
|
страница рейтинга материала (http://USER_SITE/api/blog/*-*-*-*-14-*-*) |
строка вида: A.B/C, где A.B – средний рейтинг (A – целая часть, B десятичная дробь), C – количество оценок |
| страница материалов пользователя (http://USER_SITE/api/blog/*-*-*-*-17-*-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
| страница конкретного материала (http://USER_SITE/api/blog/a-b-c-d-*-*-*) |
MATERIAL_ID TITLE BRIEF MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP IMAGEX (где Х - номер изображения) OTHERX (где Х - номер дополнительного поля) |
|
| страница материалов за день (http://USER_SITE/api/blog/a-b-c-*-*-*-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
| страница материалов за месяц (http://USER_SITE/api/blog/a-b-*-*-*-*-*) |
MATERIAL_ID TITLE ENTRY_URL COMMENTS_NUM COMMENTS_URL USER_NAME TIME TIMESTAMP |
|
| страница материалов из категории (http://USER_SITE/api/blog/a-*-b-*-*-*-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
| главная страница модуля (http://USER_SITE/api/blog/) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
|
board
|
страница рейтинга материала (http://USER_SITE/api/board/*-*-*-*-3-*-*-*-*) |
строка вида: A.B/C, где A.B – средний рейтинг (A – целая часть, B десятичная дробь), C – количество оценок |
| страница материалов пользователя (http://USER_SITE/api/board/*-*-*-*-17-*-*-*-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
| страница конкретного материала (http://USER_SITE/api/board/*-*-*-a-*-*-*-*-*) |
MATERIAL_ID TITLE BRIEF MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP SCREEN_URL FILE_URL AUTHOR_NAME AUTHOR_EMAIL AUTHOR_SITE AUTHOR_PHONE PLACED_TILL IMAGEX (где Х - номер изображения) OTHERX (где Х - номер дополнительного поля) |
|
| страница материалов из категории (http://USER_SITE/api/board/a-*-*-*-*-*-*-*-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
| главная страница модуля (http://USER_SITE/api/board/) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
|
dir
|
страница рейтинга материала (http://USER_SITE/api/dir/*-*-*-*-3-*-*-*) |
строка вида: A.B/C, где A.B – средний рейтинг (A – целая часть, B десятичная дробь), C – количество оценок |
| страница материалов пользователя (http://USER_SITE/api/dir/*-*-*-*-17-*-*-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
| страница конкретного материала (http://USER_SITE/api/dir/*-*-*-a-*-*-*-*) |
MATERIAL_ID TITLE BRIEF MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP SITE_URL SCREEN_URL FILE_URL AUTHOR_NAME AUTHOR_EMAIL AUTHOR_SITE IMAGEX (где Х - номер изображения) OTHERX (где Х - номер дополнительного поля) |
|
| страница материалов из категории (http://USER_SITE/api/dir/a-*-*-*-*-*-*-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
| главная страница модуля (http://USER_SITE/api/dir/) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
|
forum
|
страница форумов (http://USER_SITE/api/forum/a-*-*-*-*-*) |
FORUM_NAME FORUM_DESCR FORUM_LINK TOPIC_NUMS REPLIES_NUM LASTTOPIC_NAME LASTTOPIC_LINK LASTPOST_AUTHOR LASTPOST_AUTHORPROFILE LASTPOST_LINK LASTPOST_TIME |
| страница списка тем с постами пользователя (http://USER_SITE/api/forum/*-*-*-3-*-*) |
TOPIC_NAME TOPIC_DESCR TOPIC_LINK TOPIC_PAGESNUM FORUM_NAME FORUM_LINK REPLIES_NUM VIEWS_NUM USER_NAME USER_PROFILE LASTPOST_TIME LASTPOST_LINK LASTPOST_AUTHOR LASTPOST_AUTHORPROFILE |
|
| страница конкретного поста (http://USER_SITE/api/forum/*-*-*-16-*-*) |
POST_ID POST_NUMBER POST_MESSAGE POST_DATE POST_TIME POST_TIMESTAMP POST_DIRECTURL USER_NAME USER_USERNAME USER_ID USER_GROUPID USER_PROFILE USER_AVATAR USER_GROUPNAME USER_RANKNAME USER_REPUTATION USER_BANRATING USER_SIGNATURE USER_STATUS USER_AWARDS USER_POSTSNUM USER_IPADDRESS |
|
| страница с последними постами в теме (http://USER_SITE/api/forum/*-*-*-17-*-*) |
строка вида http://USER_SITE/forum/*-*-*#* | |
| страница тем с поледними постами (http://USER_SITE/api/forum/*-*-*-34-*-*) |
TOPIC_NAME TOPIC_DESCR TOPIC_LINK TOPIC_PAGESNUM FORUM_NAME FORUM_LINK REPLIES_NUM VIEWS_NUM USER_NAME USER_PROFILE LASTPOST_TIME LASTPOST_LINK LASTPOST_AUTHOR LASTPOST_AUTHORPROFILE PARENT_FORUM_NAME PARENT_FORUM_LINK LASTPOST_TIMESTAMP LASTPOST_ID |
|
| страница списка участников (http://USER_SITE/api/forum/*-*-*-35-*-*) |
USER_PROFILE USER_UNETPROFILE USER_GROUPNAME USER_GROUPID USER_RANKNAME USER_REGDATE USER_LASTVISIT USER_BIRTHDAY USER_ICQ USER_AOL USER_MSN USER_YAHOO USER_COUNTRY USER_STATE USER_CITY USER_GENDER USER_POSTSNUM USER_USERNAME USER_AVATAR |
|
| страница темы (http://USER_SITE/api/forum/*-*-*-42-*-*) |
POST_ID POST_NUMBER POST_MESSAGE POST_DATE POST_TIME POST_TIMESTAMP POST_DIRECTURL USER_NAME USER_USERNAME USER_ID USER_GROUPID USER_PROFILE USER_AVATAR USER_GROUPNAME USER_RANKNAME USER_REPUTATION USER_BANRATING USER_SIGNATURE USER_STATUS USER_AWARDS USER_POSTSNUM USER_IPADDRESS |
|
| главная страница модуля (http://USER_SITE/api/forum/) |
FORUM_NAME FORUM_DESCR FORUM_LINK TOPIC_NUMS REPLIES_NUM LASTTOPIC_NAME LASTTOPIC_LINK LASTPOST_AUTHOR LASTPOST_AUTHORPROFILE LASTPOST_LINK LASTPOST_TIME |
|
|
gb
|
главная страница модуля (http://USER_SITE/api/gb/) |
MATERIAL_ID MESSAGE USER_NAME USER_ID DATE TIME TIMESTAMP |
|
load
|
страница рейтинга материала (http://USER_SITE/api/load/*-*-*-*-3-*-*-*) |
строка вида: A.B/C, где A.B – средний рейтинг (A – целая часть, B десятичная дробь), C – количество оценок |
| страница материалов пользователя (http://USER_SITE/api/load/*-*-*-*-17-*-*-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM LOADS_NUM DATE TIME TIMESTAMP |
|
| страница конкретного материала (http://USER_SITE/api/load/*-*-*-a-*-*-*-*) |
MATERIAL_ID TITLE BRIEF MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM LOADS_NUM DATE TIME TIMESTAMP VERSION SCREEN_URL LICENCE INTERFACE_LNG FILE_URL RFILE_URL RFILE_SIZE AUTHOR_NAME AUTHOR_EMAIL AUTHOR_SITE SOURCE_URL DOCPAGE_URL IMAGEX (где Х - номер изображения) OTHERX (где Х - номер дополнительного поля) |
|
| страница материалов из категории (http://USER_SITE/api/load/a-*-*-*-*-*-*-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM LOADS_NUM DATE TIME TIMESTAMP |
|
| главная страница модуля (http://USER_SITE/api/load/) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM LOADS_NUM DATE TIME TIMESTAMP |
|
|
news
|
страница рейтинга материала (http://USER_SITE/api/news/*-*-*-*-15-*-*) |
строка вида: A.B/C, где A.B – средний рейтинг (A – целая часть, B десятичная дробь), C – количество оценок |
| страница материалов пользователя (http://USER_SITE/api/news/*-*-*-*-17-*-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
| страница конкретного материала (http://USER_SITE/api/news/a-b-c-d-*-*-*) |
MATERIAL_ID TITLE BRIEF MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP IMAGEX (где Х - номер изображения) OTHERX (где Х - номер дополнительного поля) |
|
| страница материалов за день (http://USER_SITE/api/news/a-b-c-*-*-*-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
| страница материалов за месяц (http://USER_SITE/api/news/a-b-*-*-*-*-*) |
MATERIAL_ID TITLE ENTRY_URL COMMENTS_NUM COMMENTS_URL USER_NAME TIME TIMESTAMP |
|
| страница материалов из категории (http://USER_SITE/api/news/a-*-b-*-*-*-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
| главная страница модуля (http://USER_SITE/api/news/) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
|
photo
|
страница рейтинга материала (http://USER_SITE/api/photo/*-*-*-13-*-*-*-*) |
строка вида: A.B/C, где A.B – средний рейтинг (A – целая часть, B десятичная дробь), C – количество оценок |
| страница материалов пользователя (http://USER_SITE/api/photo/*-*-*-17-*-*-*-*) |
MATERIAL_ID TITLE MESSAGE PHOTO_URL PHOTO_HEIGHT PHOTO_WIDTH PHOTO_SIZE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
| страница конкретного материала (http://USER_SITE/api/photo/*-*-a-*-*-*-*-*) |
MATERIAL_ID TITLE MESSAGE PHOTO_URL PHOTO_HEIGHT PHOTO_WIDTH PHOTO_SIZE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP OTHERX (где Х - номер дополнительного поля) |
|
| страница материалов из альбома (http://USER_SITE/api/photo/a-*-*-*-*-*-*-*) |
MATERIAL_ID TITLE MESSAGE PHOTO_URL PHOTO_HEIGHT PHOTO_WIDTH PHOTO_SIZE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
| главная страница модуля (http://USER_SITE/api/photo/) |
MATERIAL_ID TITLE MESSAGE PHOTO_URL PHOTO_HEIGHT PHOTO_WIDTH PHOTO_SIZE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
|
publ
|
страница рейтинга материала (http://USER_SITE/api/publ/*-*-*-*-3-*) |
строка вида: A.B/C, где A.B – средний рейтинг (A – целая часть, B десятичная дробь), C – количество оценок |
| страница материалов пользователя (http://USER_SITE/api/publ/*-*-*-*-17-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
| страница конкретного материала (http://USER_SITE/api/publ/*-*-*-a-*-*) |
MATERIAL_ID TITLE BRIEF MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP AUTHOR_EMAIL AUTHOR_SITE SOURCE IMAGEX (где Х - номер изображения) OTHERX (где Х - номер дополнительного поля) |
|
| страница материалов из категории (http://USER_SITE/api/publ/a-*-*-*-*-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
| главная страница модуля (http://USER_SITE/api/publ/) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM DATE TIME TIMESTAMP |
|
|
stuff
|
страница материалов пользователя (http://USER_SITE/api/stuff/*-*-*-*-17-*-*-*-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM RUNS_NUM DATE TIME TIMESTAMP |
| страница конкретного материала (http://USER_SITE/api/stuff/*-*-*-a-*-*-*-*-*) |
MATERIAL_ID TITLE BRIEF MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM RUNS_NUM DATE TIME TIMESTAMP SCREEN_URL SCREEN_SIZE FILE_URL FILE_SIZE AUTHOR_NAME AUTHOR_EMAIL AUTHOR_SITE SWF_LINK SWF_LINK_DIRECT PLAYZONE_W PLAYZONE_H LINK_PC LINK_MAC LINK_MOBILE IMAGEX (где Х - номер изображения) OTHERX (где Х - номер дополнительного поля) |
|
| страница материалов из категории (http://USER_SITE/api/stuff/a-*-*-*-*-*-*-*-*) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM RUNS_NUM DATE TIME TIMESTAMP |
|
| главная страница модуля (http://USER_SITE/api/stuff/) |
MATERIAL_ID TITLE MESSAGE ENTRY_URL CATEGORY_NAME CATEGORY_URL COMMENTS_NUM COMMENTS_URL USER_NAME USER_ID RATING RATED READS_NUM RUNS_NUM DATE TIME TIMESTAMP |
|
|
index
|
страница информации о пользователе (http://USER_SITE/api/index/8-*-*-*-*) |
USER_ID USER_PROFILE USER_GROUPID USER_GROUPNAME USER_USERNAME USER_NAME USER_GENDER USER_EMAIL USER_ISVERIFIEDEMAIL USER_HOMEPAGE USER_COUNTRY USER_CITY USER_ICQ USER_AOL USER_MSN USER_YAHOO USER_BIRTHDAY USER_ZODIAC USER_AGE USER_IPADDRESS USER_BANNEDTILL USER_RANK USER_RANKNAME USER_REPUTATION USER_AWARDS USER_REGTIMESTAMP USER_LOGTIMESTAMP USER_STATUS USER_UNETPROFILE USER_UNETID |
| история репутации (http://USER_SITE/api/index/9-*-*-*-*) |
REPCHANGE_ID REPCHANGE_ANSWER REPCHANGE_VALUE REPCHANGE_NAME REPCHANGE_PROFILE REPCHANGE_REF REPCHANGE_TIME REPCHANGE_REASON |
|
| список пользователей (http://USER_SITE/api/index/15-*-*-*-*) |
USER_PROFILE USER_UNETPROFILE USER_GROUPNAME USER_GROUPID USER_RANKNAME USER_REGDATE USER_LASTVISIT USER_BIRTHDAY USER_ICQ USER_AOL USER_MSN USER_YAHOO USER_COUNTRY USER_STATE USER_CITY USER_GENDER USER_POSTSNUM USER_USERNAME USER_AVATAR |
|
| история предупреждений (http://USER_SITE/api/index/21-*-*-*-*) |
BANCHANGE_VALUE BANCHANGE_NAME BANCHANGE_PROFILE BANCHANGE_TIME BANCHANGE_REASON |
|
| страница коментариев пользователя (http://USER_SITE/api/index/34-*-*-*-*) |
COMMENT_MESSAGE COMMENT_DATE COMMENT_TIME COMMENT_LINK COMMENT_RATE COMMENT_ANSWER COMMENT_USERIP |
|
| страница материалов пользователя (http://USER_SITE/api/index/46-*-*-*-*) |
USERFORUMENTRIES_NUM USERFORUMENTRIES_LINK USERCOMMENTENTRIES_NUM USERCOMMENTENTRIES_LINK USERBLOGENTRIES_NUM USERBLOGENTRIES_LINK USERNEWSENTRIES_NUM USERNEWSENTRIES_LINK USERPUBLENTRIES_NUM USERPUBLENTRIES_LINK USERLOADENTRIES_NUM USERLOADENTRIES_LINK USERDIRENTRIES_NUM USERDIRENTRIES_LINK USERBOARDENTRIES_NUM USERBOARDENTRIES_LINK USERPHOTOENTRIES_NUM USERPHOTOENTRIES_LINK USERSTUFFENTRIES_NUM USERSTUFFENTRIES_LINK |
|
| список онлайн пользователей (http://USER_SITE/api/index/62-*-*-*-*) |
USER_ID USER_NAME USER_AGE USER_PROFILE |
|
| список неактивных материалов (http://USER_SITE/api/index/85-*-*-*-*) |
UNACTIVEPHOTO_NUM UNACTIVEPHOTO_LINK UNACTIVEBLOG_NUM UNACTIVEBLOG_LINK UNACTIVENEWS_NUM UNACTIVENEWS_LINK UNACTIVEPUBL_NUM UNACTIVEPUBL_LINK UNACTIVELOAD_NUM UNACTIVELOAD_LINK UNACTIVEDIR_NUM UNACTIVEDIR_LINK UNACTIVEBOARD_NUM UNACTIVEBOARD_LINK UNACTIVESTUFF_NUM UNACTIVESTUFF_LINK UNACTIVEFAQ_NUM UNACTIVEFAQ_LINK UNACTIVEGB_NUM UNACTIVEGB_LINK |
ОБНОВЛЕНИЯ
[13.05.2011]
Добавлена возможность использовать ключ (API key) для базового API.
Данная возможность позволяет разрешить использование API только для тех, кто знает ключ. Для всех остальных API не будет работать.Включить эту возможность можно в панели управления в разделе “Настройки” > “Общие настройки” > “Использовать API key”. Ключ генерируется автоматически.
Если вы захотите изменить уже существующий ключ, то отключите и включите заново эту опцию, затем сохраните изменения.
Использовать API при наличии ключа нужно посредством GET-запроса следующим образом:
http://SITE_ADDRESS/api/MODULENAME/ANYRELPATH?apikey=APIKEY
Описание использования базового API