Основы uAPI

Документация uAPI по модулям

Во всех PHP примерах запроса используется PHP модуль uAPI
Материалы | Категории | Комментарии
Главная > Документация > Модуль "Новости сайта", материалы
 

[GET] Все материалы модуля


Расшифровка переменных ответа

  • page – [Число] – Номер текущей страницы
  • pages_list – [Число] – Общее количество страниц в модуле
  • per_page – [Число] – Количество материалов на страницу
  • news – [Массив] – Первый полученный материал
    • other3 – [Строка] – Дополнительное поле 3
    • reads – [Число] – Количество просмотров материала
    • other5 – [Строка] – Дополнительное поле 5
    • other1 – [Строка] – Дополнительное поле 1
    • rate_num – [Число] – Количество голосов (рейтинг)
    • author – [Строка] – Полное имя автора материала
    • comments – [Строка] – Позволить оставлять комментарии? (yes/no)
    • rating – [Число] – Рейтинг материала (Общая сумма рейтинга/на количество голосов)
    • add_date – [Строка] – Время добавления материала
    • rate_sum – [Число] – Общая сумма рейтинга
    • category – [Массив] – О категории материала
      • url – [Строка] – Ссылка на категорию материала
      • access2add – [Массив] – Права на добавление материалов в категорию
      • name – [Строка] – Название категории материала
      • id – [Число] – ID категории материала
      • description – [Строка] – Описание категории материала
      • image – [Строка] – Ссылка на изображение категории
    • id – [Число] – ID полученного материала
    • ontop – [Строка] – Показывать материал всегда сверху? (yes/no)
    • other4 – [Строка] – Дополнительное поле 4
    • other2 – [Строка] – Дополнительное поле 2
    • pending – [Строка] – В ожидани ли активации материал? (yes/no)
    • entry_url – [Строка] – Полная ссылка на материал
    • message – [Строка] – Полное описание материала
    • description – [Строка] – Краткое описание материала [если включено краткое описание]
    • title – [Строка] – Название материала
    • hgu_title – [Строка] – ЧПУ материала
  • total_news – [Число] – Общее количество материалов в модуле

Особенности

1) Чтобы получить данные материалов со страницы 2, достаточно добавить к URL параметр &page=N (где N – номер страницы)
2) Сколько материалов будет выдано за запрос – зависит от настроек модуля (Панель управления → Новости сайта → Настройки модуля → Количество материалов на главной странице).

<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/news', array( // без параметров )); print_r($response); // Получаем ответ curl -i -X GET -G --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" http://yoursite.ucoz.ru/uapi/news
{ "page":1, "pages_list":"1..32", "per_page":"1", "news":[ { "other3":"", "reads":20, "other5":"", "avatar":"", "other1":"", "rate_num":0, "author":"Dmitry_DM", "comments":"yes", "rating":"0.00", "add_date":"2016-03-26 16:23", "rate_sum":0, "category":{ "url":"http://yoursite.ucoz.ru/category/hello", "name":"Категория", "id":1, "description":"39_e" }, "id":"61", "ontop":"no", "other4":"", "other2":"", "pending":"no", "entry_url":"http://yoursite.ucoz.ru/news/test/2016-03-26-61", "message":"<p>аыва</p>", "title":"тест", "hgu_title":"test" }, { // второй материал }, { // третий материал } ], "total_news":32 } { "page":1, "pages_list":"1..32", "per_page":"1", "news":[ { "other3":"", "reads":20, "other5":"", "avatar":"", "other1":"", "rate_num":0, "author":"Dmitry_DM", "comments":"yes", "rating":"0.00", "add_date":"2016-03-26 16:23", "rate_sum":0, "category":{ "url":"http://yoursite.ucoz.ru/category/hello", "name":"Категория", "id":1, "description":"39_e" }, "id":"61", "ontop":"no", "other4":"", "other2":"", "pending":"no", "entry_url":"http://yoursite.ucoz.ru/news/test/2016-03-26-61", "message":"<p>аыва</p>", "title":"тест", "hgu_title":"test" }, { //второй материал }, { //третий материал } ], "total_news":32 }
// для особенности 1 <?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/news', array( 'page' => '2' )); print_r($response); // Получаем ответ curl -i -X GET -G --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" http://yoursite.ucoz.ru/uapi/news&page=2
 

[GET] определенный материал


Расшифровка переменных ответа

  • other3 – [Строка] – Дополнительное поле 3
  • reads – [Число] – Количество просмотров материала
  • other5 – [Строка] – Дополнительное поле 5
  • other1 – [Строка] – Дополнительное поле 1
  • rate_num – [Число] – Количество голосов (рейтинг)
  • author – [Строка] – Полное имя автора материала
  • comments – [Строка] – Позволить оставлять комментарии? (yes/no)
  • rating – [Число] – Рейтинг материала (Общая сумма рейтинга/на количество голосов)
  • add_date – [Строка] – Время добавления материала
  • rate_sum – [Число] – Общая сумма рейтинга
      • category – [Массив] – О категории материала
    • url – [Строка] – Ссылка на категорию материала
    • access2add – [Массив] – Права на добавление материалов в категорию
    • name – [Строка] – Название категории материала
    • id – [Число] – ID категории материала
    • description – [Строка] – Описание категории материала
    • image – [Строка] – Ссылка на изображение категории
  • id – [Число] – ID полученного материала
  • ontop – [Строка] – Показывать материал всегда сверху? (yes/no)
  • other4 – [Строка] – Дополнительное поле 4
  • other2 – [Строка] – Дополнительное поле 2
  • pending – [Строка] – В ожидани ли активации материал? (yes/no)
  • entry_url – [Строка] – Полная ссылка на материал
  • message – [Строка] – Полное описание материала
  • description – [Строка] – Краткое описание материала [если включено краткое описание]
  • title – [Строка] – Название материала
  • hgu_title – [Строка] – ЧПУ материала
  • prev_entry_url - [Строка] - Полная ссылка на предыдущий материал
  • next_entry_url - [Строка] - Полная ссылка на следующий материал

Особенности

1) В переменных description и message переносы строк автоматически меняются на \n (в случае, если перенос строки был сделан без html-тега <br />)
2) В переменных description и message если там есть html-тег переноса <br /> – будет осуществлен и визуальный перенос строки, без вывода <br /> (то есть html-тег воспроизведется)
3) Переменные access2category и access2add могут иметь другой вид, если права установлены для всех групп пользователей
4) Если материал входит в более 1 категории, то о каждой категории, в которые входит материал, будет показана информация в GET-запросе

<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/news', array( 'id' => 'АЙДИМАТЕРИАЛА' )); print_r($response); // Получаем ответ curl -i -X GET -G --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "id=АЙДИМАТЕРИАЛА" http://youresite.ucoz.ru/uapi/news
{ "other3":"", "reads":20, "other5":"", "avatar":"", "other1":"", "rate_num":0, "author":"Dmitry_DM", "comments":"yes", "rating":"0.00", "add_date":"2016-03-26 16:23", "rate_sum":0, "category":{ "url":"http://yoursite.ucoz.ru/category/hello", "name":"Категория", "id":1, "description":"39_e" }, "id":"61", "ontop":"no", "other4":"", "other2":"", "pending":"no", "entry_url":"http://yoursite.ucoz.ru/news/test/2016-03-26-61", "message":"<p>аыва</p>", "title":"тест", "hgu_title":"test", "prev_entry_url":"https://yoursite.ucoz.ru/news/test/2016-03-26-60", "next_entry_url":"https://yoursite.ucoz.ru/news/test/2016-03-26-62", } { "other3":"", "reads":20, "other5":"", "avatar":"", "other1":"", "rate_num":0, "author":"Dmitry_DM", "comments":"yes", "rating":"0.00", "add_date":"2016-03-26 16:23", "rate_sum":0, "category":{ "url":"http://yoursite.ucoz.ru/category/hello", "name":"Категория", "id":1, "description":"39_e" }, "id":"61", "ontop":"no", "other4":"", "other2":"", "pending":"no", "entry_url":"http://yoursite.ucoz.ru/news/test/2016-03-26-61", "message":"<p>аыва</p>", "title":"тест", "hgu_title":"test", "prev_entry_url":"https://yoursite.ucoz.ru/news/test/2016-03-26-60", "next_entry_url":"https://yoursite.ucoz.ru/news/test/2016-03-26-62", }
 

[GET] За определенную дату


Расшифровка переменных ответа

  • page – [Число] – Номер текущей страницы
  • pages_list – [Число] – Общее количество страниц в модуле
  • per_page – [Число] – Количество материалов на страницу
      •  news – [Массив] – Первый полученный материал
    • other3 – [Строка] – Дополнительное поле 3
    • reads – [Число] – Количество просмотров материала
    • other5 – [Строка] – Дополнительное поле 5
    • other1 – [Строка] – Дополнительное поле 1
    • rate_num – [Число] – Количество голосов (рейтинг)
    • author – [Строка] – Полное имя автора материала
    • comments – [Строка] – Позволить оставлять комментарии? (yes/no)
    • rating – [Число] – Рейтинг материала (Общая сумма рейтинга/на количество голосов)
    • add_date – [Строка] – Время добавления материала
    • rate_sum – [Число] – Общая сумма рейтинга
        • category – [Массив] – О категории материала
      • url – [Строка] – Ссылка на категорию материала
      • access2add – [Массив] – Права на добавление материалов в категорию
      • name – [Строка] – Название категории материала
      • id – [Число] – ID категории материала
      • description – [Строка] – Описание категории материала
      • image – [Строка] – Ссылка на изображение категории
    • id – [Число] – ID полученного материала
    • ontop – [Строка] – Показывать материал всегда сверху? (yes/no)
    • other4 – [Строка] – Дополнительное поле 4
    • other2 – [Строка] – Дополнительное поле 2
    • pending – [Строка] – В ожидани ли активации материал? (yes/no)
    • entry_url – [Строка] – Полная ссылка на материал
    • message – [Строка] – Полное описание материала
    • description – [Строка] – Краткое описание материала [если включено краткое описание]
    • title – [Строка] – Название материала
    • hgu_title – [Строка] – ЧПУ материала
  • total_news – [Число] – Общее количество материалов в модуле

Особенности

1) Формат yyyy-mm-dd подразумевает расшифровку Год-Месяц-День
2) Если нужны материалы за определенный год, то достаточно сделать запрос с параметром 'date' => '2015', например

<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/news', array( 'date' => '2016-03-26' //формат yyyy-mm-dd )); print_r($response); // Получаем ответ curl -i -X GET -G --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "date=2016-03-26" http://youresite.ucoz.ru/uapi/news
{ "page":1, "pages_list":"1", "per_page":"5", "news":[ { "other3":"", "reads":20, "other5":"", "avatar":"", "other1":"", "rate_num":0, "author":"Dmitry_DM", "comments":"yes", "rating":"0.00", "add_date":"2016-03-26 16:23", "rate_sum":0, "category":{ "url":"http://yoursite.ucoz.ru/category/hello", "name":"Категория", "id":1, "description":"39_e" }, "id":"61", "ontop":"no", "other4":"", "other2":"", "pending":"no", "entry_url":"http://yoursite.ucoz.ru/news/test/2016-03-26-61", "message":"

аыва

", "title":"тест", "hgu_title":"test" }, { //второй материал }, { //третий материал } ], "total_news":3 } { "page":1, "pages_list":"1", "per_page":"5", "news":[ { "other3":"", "reads":20, "other5":"", "avatar":"", "other1":"", "rate_num":0, "author":"Dmitry_DM", "comments":"yes", "rating":"0.00", "add_date":"2016-03-26 16:23", "rate_sum":0, "category":{ "url":"http://yoursite.ucoz.ru/category/hello", "name":"Категория", "id":1, "description":"39_e" }, "id":"61", "ontop":"no", "other4":"", "other2":"", "pending":"no", "entry_url":"http://yoursite.ucoz.ru/news/test/2016-03-26-61", "message":"

аыва

", "title":"тест", "hgu_title":"test" }, { //второй материал }, { //третий материал } ], "total_news":3 }
 

[POST] Добавить материал


Расшифровка переменных запроса

  • end2br_msg – [Строка] – Статус опции "Заменять теги переноса на <br />" для полного описания материала (yes/no)
  • comments – [Строка] – Позволить оставлять комментарии? (yes/no)
      • Опция кастомного времени добавления сработает только в случае, если в настройках модуля установлена галочка "Включить возможность выбирать дату добавления материала"
    • ya – [Число] – Год добавления
    • ma – [Число] – Месяц добавления (Например, Февраль – 2)
    • da – [Число] – День добавления
    • ha – [Число] – Час добавления
    • mia – [Число] – Минута добавления
  • end2br_desc – [Строка] – Статус опции "Заменять теги переноса на <br />" для краткого описания материала (yes/no)
  • ontop – [Строка] – Показывать материал всегда сверху? (yes/no)
  • pending – [Строка] – В ожидани ли активации материал? (yes/no)
  • description – [Строка] – Краткое описание материала
  • message – [Строка] – Полное описание материала
  • title – [Строка] – Название материала
  • hgu_title – [Строка] – ЧПУ материала
  • file1 – [Файл] – Изображение материала (file2, file3..file20)
  • other1 – [Строка] – Дополнительное поле 1
  • other2 – [Строка] – Дополнительное поле 2
  • other3 – [Строка] – Дополнительное поле 3
  • other4 – [Строка] – Дополнительное поле 4
  • other5 – [Строка] – Дополнительное поле 5

Особенности

1) HGU (ЧПУ) нельзя установить при добавлении материала
2) Все обязательные параметры исключительно определяются в Панели управления: Новости сайта – Настройки модуля

<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->post('/news', array( 'category' => '1', 'title' => 'Название материала', 'description' => 'Краткое описание материала', 'message' => 'Полное описание материала' )); print_r($response); // Получаем ответ curl -i -X POST --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "category=3" --data-urlencode "title=Новое название" --data-urlencode "description=Краткое описание" --data-urlencode "message=Полное описание" --data "end2br_desc=1&includehtml_desc=no" http://yoursite.ucoz.ru/uapi/news
{ "end2br_msg":"no", "comments":"yes", "add_date":"2014-11-25 23:34", "end2br_desc":"no", "ontop":"no", "includehtml_desc":"yes", "subscribe":"no", "pending":"no", "description":"Краткое описание материала", "message":"Полное описание материала", "who_add":"uapitest003", "title":"Название материала", "includehtml_msg":"yes", "hgu_title":"nazvanie_materiala" } { "end2br_msg":"no", "comments":"yes", "add_date":"2014-11-25 23:34", "end2br_desc":"no", "ontop":"no", "includehtml_desc":"yes", "subscribe":"no", "pending":"no", "description":"Краткое описание материала", "message":"Полное описание материала", "who_add":"uapitest003", "title":"Название материала", "includehtml_msg":"yes", "hgu_title":"nazvanie_materiala" }
 

[POST] Добавить тег к материалу



Обратите внимание, что именно таким образом (с помощью POST-запроса) осуществляется добавление, редактирование и удаление тегов к материалу.
1) Если вам требуется удалить теги, достаточно отправить пустой запрос
2) Если вам требуется отредактировать теги, сделайте полный запрос с теми тегами, которые должны остаться
3) Если требуется добавить новые теги, необходимо ввести список существующих + новые теги

Теги необходимо перечислять через запятую

Ответ сервера не предполагает возврата данных о материале – только сообщение об операции

<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->post('/news/tags', array( 'category' => '1', 'title' => 'Название материала', 'description' => 'Краткое описание материала', 'message' => 'Полное описание материала' )); print_r($response); // Получаем ответ curl -i -X POST --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "category=3" --data-urlencode "title=Новое название" --data-urlencode "description=Краткое описание" --data-urlencode "message=Полное описание" --data-urlencode "author=Дмитрий Неизвестный" --data-urlencode "link2source=http://ucoz.ru/" --data-urlencode "author_email=api@api.ru" --data "end2br_desc=1&includehtml_desc=no" http://yoursite.ucoz.ru/uapi/news
{ "success":{ "msg":"Данные по тегам материала обновлены" } } { "success":{ "msg":"Данные по тегам материала обновлены" } }
 

[PUT] Отредактировать материал


Расшифровка переменных запроса

  • end2br_msg – [Строка] – Статус опции "Заменять теги переноса на <br />" для полного описания материала (yes/no)
  • comments – [Строка] – Позволить оставлять комментарии? (yes/no)
  • add_date – [Строка] – Время добавления материала
  • end2br_desc – [Строка] – Статус опции "Заменять теги переноса на <br />" для краткого описания материала (yes/no)
  • ontop – [Строка] – Показывать материал всегда сверху? (yes/no)
  • pending – [Строка] – В ожидани ли активации материал? (yes/no)
  • description – [Строка] – Краткое описание материала
  • message – [Строка] – Полное описание материала
  • title – [Строка] – Название материала
  • hgu_title – [Строка] – ЧПУ материала
  • other1 – [Строка] – Дополнительное поле 1
  • other2 – [Строка] – Дополнительное поле 2
  • other3 – [Строка] – Дополнительное поле 3
  • other4 – [Строка] – Дополнительное поле 4
  • other5 – [Строка] – Дополнительное поле 5

Особенности

1) Если отсылается запрос с пустым параметром – то это означает удаление значения параметра
2) Если при запросе вы не указали какой-либо параметр – он останется со своим прежним значением

<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->put('/news', array( 'id' => '188', 'title' => 'Новое название материала', 'description' => 'Новое краткое описание материала', 'message' => 'Новое полное описание материала', 'author_site' => 'Новый веб-сайт автора', 'author_email' => 'Новый email автора', 'author' => 'Новое имя автора', 'link2source' => 'Новый источник материала' )); print_r($response); // Получаем ответ curl -i -X PUT --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "id=3" --data-urlencode "title=Новое название" http://yoursite.ucoz.ru/uapi/news
{ "other3":"", "end2br_msg":"no", "other5":"", "other1":"", "comments":"yes", "show_attach":"no", "end2br_desc":"no", "id":61, "category":{ "url":"http://yoursite.ucoz.ru/category/hello", "name":"Категория", "id":1, "description":"39_e" }, "other4":"", "ontop":"no", "includehtml_desc":"yes", "subscribe":"no", "other2":"", "pending":"no", "description":"", "message":"

аыва

", "who_add":"Dmitry_DM", "title":"new", "uto":"no", "includehtml_msg":"yes", "hgu_title":"test" } { "other3":"", "end2br_msg":"no", "other5":"", "other1":"", "comments":"yes", "show_attach":"no", "end2br_desc":"no", "id":61, "category":{ "url":"http://yoursite.ucoz.ru/category/hello", "name":"Категория", "id":1, "description":"39_e" }, "other4":"", "ontop":"no", "includehtml_desc":"yes", "subscribe":"no", "other2":"", "pending":"no", "description":"", "message":"

аыва

", "who_add":"Dmitry_DM", "title":"new", "uto":"no", "includehtml_msg":"yes", "hgu_title":"test" }
 

[DELETE] Удалить материал



Обратите внимание, что удаление материала происходит навсегда, его возврат невозможен.

Ответ сервера не предполагает возврата данных о материале – только сообщение об операции

<?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->delete('/news/posts', array( 'id' => '1' )); print_r($response); // Получаем ответ url -i -X DELETE --data-urlencode "oauth_consumer_key=ЗНАЧЕНИЕ" --data-urlencode "oauth_nonce=значение" --data-urlencode "oauth_signature_method=HMAC-SHA1" --data-urlencode "oauth_timestamp=значение" --data-urlencode "oauth_version=1.0" --data-urlencode "oauth_token=значение" --data-urlencode "auth_signature=значение" --data "ID=1" http://yoursite.ucoz.ru/uapi/news/posts
{ "success":{ "msg":"Материал удалён" } } { "success":{ "msg":"Материал удалён" } }

Яндекс.Метрика