Взаимодействие PHP uCoz и API

Страница 1 из 1
1

Driver86

Дата: Среда, 2012-03-14, 01:55:53 | Сообщение # 1

CyberMan

Администраторы

Сообщений: 545

Репутация: 14

Не на форуме

API предствляет собой интерфейс получения данных со страниц uCoz-сайта. Формат данных, которые отдаются API - XML-RPC. Все обращения к интерфейсу выполняются посредством GET-запросов. Как это использовать - опишем в этой статье.

АPI uCoz предоставляется бесплатно, её нужно просто активировать в основных настройках сайта:

API предствляет собой интерфейс получения данных со страниц uCoz-сайта. Формат данных, которые отдаются API - http://ru.wikipedia.org/wiki/XML-RPC ">XML-RPC. Все обращения к интерфейсу выполняются посредством GET-запросов. Использовать данную функцию можно следующим образом:

Code

http://SITE_ADDRESS/api/MODULENAME/ANYRELPATH

SITE_ADDRESS - адрес сайта пользователя, на котором используется API;
MODULENAME – модуль сайта;
ANYRELPATH – любая страница модуля.

Фактически, для использования интерфейса (если он активирован для сайта) достаточно вписать префикс /api/ между адресом сайта и именем модуля.

Например, обратившись по этой ссылке - http://blog.ucoz.ru/api/blog/reliz_php_i_api_na_ucoz/2011-03-30-180 - мы получим XML-дерево элементов, структурированное отображение данных материала. Давайте рассмотрим, как это можно использовать.

Code

<?php
$context = stream_context_create(array('http' => array('method' => "GET", 'header' => "Content-Type: text/xml")));
$file = file_get_contents("http://blog.ucoz.ru/api/blog/", false, $context);
$response = xmlrpc_decode($file,"utf8");
if ($response && xmlrpc_is_fault($response))
{
  echo "Не могу получить данные, попробуйте позже";
  exit;
}
$lastmat=preg_replace("/\/blog\//i","/api/blog/",$response[0]['ENTRY_URL']);
$file = file_get_contents($lastmat, false, $context);
$response = xmlrpc_decode($file,"utf8");
if ($response && xmlrpc_is_fault($response))
{
  echo "Не могу получить данные, попробуйте позже";
  exit;
}
echo "<center><h1>".$response['TITLE']."</h1></center><br>
<div>".$response['MESSAGE']."</div>
Автор: ".$response['USER_NAME']."</p>
Источник: <a href='".$response['ENTRY_URL']."'>".$response['ENTRY_URL']."</a></p>";
?>

Приведённый выше скрипт обращается к официальному блогу uCoz, получает список статей, находит ссылку на последнюю запись и опять делает запрос на API, но уже для данной статьи. Результаты возвращаются в формате XML-RPC. Получив нужную статью скрипт выводит нам её заголовок, содержимое, автора и ссылку на источник. Думаю, со мной согласятся - довольно полезный скрипт.

Кстати, вот здесь - http://forum.ucoz.ru/board/api/10-1-0-91 - исчерпывающая информация по возвращаемым данным. На всякий случай выложу таблицу данных здесь, но учтите - со временем команда uCoz будет её пополнять.

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

Модуль	cтраница (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 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----)	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 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 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 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 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
	страница списка участников (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 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 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 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----)	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
	страница материалов из альбома (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 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 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 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 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

Прикрепления к сообщению: 7744504.png (6.1 Kb)

Взаимодействие PHP uCoz и API

Страница 1 из 1
1