Главная » Функционал » PHP и API » Описание использования базового API

Описание использования базового API

28.03.2011 в 18:21
Автор: Olsiva

ОБЩАЯ ИНФОРМАЦИЯ

Базовое 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_USERIPIP адрес автора коментария
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_AOLAOL пользователя сайта
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_ICQICQ пользователя сайта
USER_IDидентификатор пользователя сайта/автора материала
USER_IPADDRESSIP адрес пользователя сайта
USER_ISVERIFIEDEMAILпроверен ли электронная почта пользователя сайта
USER_LASTVISITдата последнего посещениая пользователя
USER_LOGTIMESTAMPвремя последней авторизации пользователя сайта в формате timestamp
USER_MSNMSN пользователя сайта
USER_NAMEимя пользователя сайта/автора материала (логин)
USER_POSTSNUMколичество сообщений пользователя сайта
USER_PROFILEпрофиль пользователя сайта
USER_RANKранк пользователя сайта
USER_RANKNAMEназвание ранка пользователя сайта
USER_REGDATEдата регистрации пользователя
USER_REGTIMESTAMPвремя регистрации пользователя сайта в формате timestamp
USER_REPUTATIONрепутация пользователя сайта
USER_SIGNATUREподпись пользователя сайта
USER_STATUSстатус пользователя сайта
USER_UNETIDUNET идентификатор пользователя сайта
USER_UNETPROFILEUNET профиль пользователя сайта
USER_USERNAMEполное имя пользователя сайта/автора материала
USER_YAHOOYAHOO пользователя сайта
USER_ZODIACзнак зодиака пользователя сайта
VIEWS_NUMколичество просмотров материала

ДОПОЛНИТЕЛЬНАЯ ИНФОРМАЦИЯ

В ближайшее время возможность использования API будет добавлена еще в несколько других модулей системы. По мере добавления здесь будет изменяться и добавляться информация о его использовании.


ПОЛНАЯ ТАБЛИЦА СООТВЕТСТВИЯ ПОЛЕЙ СТРАНИЦАМ И МОДУЛЯМ

ОБНОВЛЕНИЯ
  • [13.05.2011] Добавлена возможность использовать ключ (API key) для базового API.

    Данная возможность позволяет разрешить использование API только для тех, кто знает ключ. Для всех остальных API не будет работать.Включить эту возможность можно в панели управления в разделе “Настройки” > “Общие настройки” > “Использовать API key”. Ключ генерируется автоматически.

    Если вы захотите изменить уже существующий ключ, то отключите и включите заново эту опцию, затем сохраните изменения.

    Использовать API при наличии ключа нужно посредством GET-запроса следующим образом:

    http://SITE_ADDRESS/api/MODULENAME/ANYRELPATH?apikey=APIKEY

Рейтинг: 15  (помогла ли Вам эта инструкция: да / нет)          Просмотров: 88137          Комментариев: