Основы uAPI

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

Во всех PHP примерах запроса используется PHP модуль uAPI
Сообщения и опросы | Форум и темы | Модераторские функции
Главная > Документация uAPI > Модуль "Форум", форум и темы
 

[GET] Форумы


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

        access – [Массив] – Доступ к форуму
    • reply – [Массив] – Какие группы имеют право добавлять ответы в темы
    • add – [Массив] – Какие группы имеют право создавать темы в темы форума
    • read – [Массив] – Какие группы имеют право читать темы форума
  • private – [Строка] – Установлен ли пароль для форума? (yes/no)
  • moderators – [Массив] – Массив никнеймов модераторов форума
  • name – [Строка] – Название форума
      •   rules – [Массив] – Правила форума
    • caption – [Строка] – Заголовок правил форума
    • description – [Строка] – Текст правил форума
  • description – [Строка] – Описание форума
  • state – [Строка] – Текущий статус форума (Активен/Закрыт/Отключен)
  • link2newmsg – [Строка] – URL адрес иконки "Есть новые сообщения"
  • noincrement – [Строка] – Не прибавлять пользователям количество сообщений (yes/no)
  • url – [Строка] – Ссылка на форум
  • noatall – [Строка] – Темы форума не должны выводиться в ленточном варианте форума (yes/no)
  • link2nomsg – [Строка] – URL адрес иконки "Нет новых сообщений"
  • id – [Строка] – ID форума
<?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('/forum', 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/forum
[ { "access":{ "reply":[ "Все группы" ], "add":[ "Все группы" ], "read":[ "Все группы" ] }, "private":"yes", "moderators":[ "Dmitry_DM" ], "name":"Test forum", "rules":{ "caption":"ref", "description":"fdsf" }, "description":"Test forum description", "state":"Активен", "link2newmsg":"есть", "noincrement":"yes", "url":"http://yoursite.ucoz.ru/forum/2", "noatall":"yes", "link2nomsg":"есть", "id":2 }, { //информация о втором форуме }, { //информация о третьем форуме } ] [ { "access":{ "reply":[ "Все группы" ], "add":[ "Все группы" ], "read":[ "Все группы" ] }, "private":"yes", "moderators":[ "Dmitry_DM" ], "name":"Test forum", "rules":{ "caption":"ref", "description":"fdsf" }, "description":"Test forum description", "state":"Активен", "link2newmsg":"есть", "noincrement":"yes", "url":"http://yoursite.ucoz.ru/forum/2", "noatall":"yes", "link2nomsg":"есть", "id":2 }, { //информация о втором форуме }, { //информация о третьем форуме } ]
 

[GET] Определенный форум


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

        access – [Массив] – Доступ к форуму
    • reply – [Массив] – Какие группы имеют право добавлять ответы в темы
    • add – [Массив] – Какие группы имеют право создавать темы в темы форума
    • read – [Массив] – Какие группы имеют право читать темы форума
  • private – [Строка] – Установлен ли пароль для форума? (yes/no)
  • moderators – [Массив] – Массив никнеймов модераторов форума
  • name – [Строка] – Название форума
      •   rules – [Массив] – Правила форума
    • caption – [Строка] – Заголовок правил форума
    • description – [Строка] – Текст правил форума
  • description – [Строка] – Описание форума
  • state – [Строка] – Текущий статус форума (Активен/Закрыт/Отключен)
  • link2newmsg – [Строка] – URL адрес иконки "Есть новые сообщения"
  • noincrement – [Строка] – Не прибавлять пользователям количество сообщений (yes/no)
  • url – [Строка] – Ссылка на форум
  • noatall – [Строка] – Темы форума не должны выводиться в ленточном варианте форума (yes/no)
  • link2nomsg – [Строка] – URL адрес иконки "Нет новых сообщений"
  • id – [Строка] – ID форума
<?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('/forum', 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-urlencode "id=АЙДИФОРУМА" http://yoursite.ucoz.ru/uapi/forum
[ { "access":{ "reply":[ "Все группы" ], "add":[ "Все группы" ], "read":[ "Все группы" ] }, "private":"yes", "moderators":[ "Dmitry_DM" ], "name":"Test forum", "rules":{ "caption":"ref", "description":"fdsf" }, "description":"Test forum description", "state":"Активен", "link2newmsg":"есть", "noincrement":"yes", "url":"http://yoursite.ucoz.ru/forum/2", "noatall":"yes", "link2nomsg":"есть", "id":2 } ] [ { "access":{ "reply":[ "Все группы" ], "add":[ "Все группы" ], "read":[ "Все группы" ] }, "private":"yes", "moderators":[ "Dmitry_DM" ], "name":"Test forum", "rules":{ "caption":"ref", "description":"fdsf" }, "description":"Test forum description", "state":"Активен", "link2newmsg":"есть", "noincrement":"yes", "url":"http://yoursite.ucoz.ru/forum/2", "noatall":"yes", "link2nomsg":"есть", "id":2 } ]
 

[GET] Список тем


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

       topics – [Строка] – Информация о темах
    • closed – [Строка] – Закрыта ли тема для новых сообщений? (yes/no)
    • reads – [Число] – Количество просмотров темы
    • forum_id – [Число] – ID форума, где создана тема
    • name – [Строка] – Название темы
    • author – [Строка] – Никнейм пользователя, который создал тему
    • description – [Строка] – Описание темы
    • url – [Строка] – Ссылка на тему
    • id – [Строка] – ID темы
    • posts – [Число] – Количество сообщений в теме
    • firstontop – [Строка] – Первое сообщение темы сделать шапкой (показывать на всех страницах) (yes/no)
    • ontop – [Строка] – Тема всегда сверху (yes/no)
  • total_topics – [Число] – Общее количество тем
  • page – [Число] – Номер текущей страницы
  • pages_list – [Строка] – Список страниц с темами (переключатели)
  • per_page – [Число] – Количество тем на страницу
<?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('/forum/topic', 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/forum/topic
{ "topics":[ { "closed":"yes", "reads":1, "forum_id":"2", "name":"Название темы", "author":"Dmitry_DM", "description":"Описание темы", "url":"http://yoursite.ucoz.ru/forum/2-9-1", "id":"9", "posts":0, "firstontop":"yes", "ontop":"yes" }, { //вторая тема }, { //третья тема } ], "total_topics":1, "page":1, "pages":"1", "per_page":"25" } { "topics":[ { "closed":"yes", "reads":1, "forum_id":"2", "name":"Название темы", "author":"Dmitry_DM", "description":"Описание темы", "url":"http://yoursite.ucoz.ru/forum/2-9-1", "id":"9", "posts":0, "firstontop":"yes", "ontop":"yes" }, { //вторая тема }, { //третья тема } ], "total_topics":1, "page":1, "pages":"1", "per_page":"25" }
 

[POST] Добавить новую тему


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

  • closed – [Строка] – Закрыта ли тема для новых сообщений? (yes/no)
  • name – [Строка] – Название темы
  • smiles – [Строка] – Разрешены ли смайлы в теме? (yes/no)
  • author – [Строка] – Никнейм пользователя, который создал тему
  • description – [Строка] – Описание темы
  • message – [Строка] – Текст темы
  • add_date – [Строка] – Дата добавления темы
  • end2br – [Строка] – Заменять переносы строки на html тег br (yes/no)
  • signature – [Строка] – Опция " Включить подпись" (yes/no)
  • id – [Строка] – ID темы
  • ontop – [Строка] – Тема всегда сверху (yes/no)
  • firstontop – [Строка] – Первое сообщение темы сделать шапкой (показывать на всех страницах) (yes/no)
  • firstontop – [Строка] – Первое сообщение темы сделать шапкой (показывать на всех страницах) (yes/no)
  • includehtml – [Строка] – Разрешить HTML в сообщении (yes/no)
<?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('/forum/topic', array( 'forum_id' => '2', 'name' => 'Название из API', 'message' => 'Текст из API' )); 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 "forum_id=2" --data-urlencode "name=Название из API" --data-urlencode "message=Текст из API" http://yoursite.ucoz.ru/uapi/forum/topic
{ "closed":"no", "name":"Название из API", "smiles":"yes", "author":"Dmitry_DM", "description":null, "message":"Текст из API", "add_date":"2015-01-23 16:45", "end2br":"yes", "signature":"yes", "id":12, "ontop":"no", "firstontop":"no", "includehtml":"yes" } { "closed":"no", "name":"Название из API", "smiles":"yes", "author":"Dmitry_DM", "description":null, "message":"Текст из API", "add_date":"2015-01-23 16:45", "end2br":"yes", "signature":"yes", "id":12, "ontop":"no", "firstontop":"no", "includehtml":"yes" }
 

[PUT] Изменить/Перенести тему


Возможные передаваемые параметры

  • topic_id – [Число] – ID темы
  • newforum_id – [Число] – ID форума, куда необходимо перенести тему
  • name – [Строка] – Новое название темы
  • description – [Строка] – Новое описание темы
<?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('/forum/topic', array( 'topic_id' => '12', 'name' => 'Новое Название из API', 'newforum_id' => '2' )); 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 "topic_id=12" --data-urlencode "name=Новое Название из API" --data-urlencode "newforum_id=2" http://yoursite.ucoz.ru/uapi/forum/topic
{ "success":{ "msg":"Изменения сохранены" } } { "success":{ "msg":"Изменения сохранены" } }
{{ "success":{ "msg":"Тема 'Новое Название из API' перенесена в новый форум 'Test forum'" } } {{ "success":{ "msg":"Тема 'Новое Название из API' перенесена в новый форум 'Test forum'" } }
 

[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('/forum/topic', array( 'topic_id' => '12' )); print_r($response); //Получаем ответ curl -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 "topic_id=12" http://yoursite.ucoz.ru/uapi/forum/topic
{ "success":{ "msg":"Тема удалена" } } { "success":{ "msg":"Тема удалена" } }

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