Основы uAPI

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

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

[GET] Получить вопросы


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

  • total_faqs – [Число] – Общее количество вопросов в модуле
  •   faqs – [Массив] – Вопросы в модуле
    • answer – [Строка] – Ответ на вопрос
    • subject – [Строка] – Тема вопроса
    • rate_num – [Число] – Количество голосов (рейтинг)
    • pending – [Строка] – В ожидани ли активации материал? (yes/no)
    • author_email – [Строка] – Email автора материала
    • author – [Строка] – Полное имя автора материала
    • description_type=(html|bb|plain) – [Строка] – Краткое описание материала
    • rating – [Число] – Рейтинг материала (Общая сумма рейтинга/на количество голосов)
    • who_add – [Строка] – Никнейм пользователя, добавивший материал
    • rate_sum – [Число] – Общая сумма рейтинга
    • sort –
    •   category – [Массив] – О категории
      • faqs_count – [Строка] – Общее количество вопросов в категории
      • name – [Строка] – Название категории
      • url – [Строка] – Ссылка на категорию материала
      • id – [Число] – ID категории материала
      • description – [Строка] – Описание категории материала
      • hgu_title – [Строка] – ЧПУ категории
      • image – [Строка] – Ссылка на изображение категории
    • id – [Число] – ID полученного материала
    • hgu_title – [Строка] – ЧПУ материала
<?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('/faq', 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/faq
{ "total_faqs":1, "faqs":[ { "answer":"newone3", "subject":"newone", "rate_num":0, "pending":"no", "author_email":"", "author":"", "description":"newone2", "rating":"0.00", "who_add":"Dmitry", "rate_sum":0, "sort":0, "category":{ "faqs_count":"1", "name":"Катгория1", "url":"http://yoursite.ucoz.ru/faq/1-1", "id":1, "description":null, "hgu_title":null }, "id":3, "hgu_title":"newone" }, { //идет вопрос, например, с ID4 }, { //идет вопрос, например, с ID5 } ] } { "total_faqs":1, "faqs":[ { "answer":"newone3", "subject":"newone", "rate_num":0, "pending":"no", "author_email":"", "author":"", "description":"newone2", "rating":"0.00", "who_add":"Dmitry", "rate_sum":0, "sort":0, "category":{ "faqs_count":"1", "name":"Катгория1", "url":"http://yoursite.ucoz.ru/faq/1-1", "id":1, "description":null, "hgu_title":null }, "id":3, "hgu_title":"newone" }, { //идет вопрос, например, с ID4 }, { //идет вопрос, например, с ID5 } ] }
 

[POST] Добавить вопрос


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

  • includehtml_desc – [Строка] – Включить HTML-теги для краткого описания материала? (yes/no)
  • end2br_msg – [Строка] – Статус опции "Заменять теги переноса на <br />" для полного описания материала (yes/no)
  • answer – [Строка] – Ответ на вопрос
  • subject – [Строка] – Тема вопроса
  • pending – [Строка] – В ожидани ли активации материал? (yes/no)
  • author_email – [Строка] – Email автора материала
  • author – [Строка] – Полное имя автора материала
  • description_type=(html|bb|plain) – [Строка] – Краткое описание материала
  • who_add – [Строка] – Никнейм пользователя, добавивший материал
  • add_date – [Строка] – Время добавления материала
  • sort –
  • end2br_desc – [Строка] – Статус опции "Заменять теги переноса на <br />" для краткого описания материала (yes/no)
  • includehtml_msg – [Строка] – Включить HTML-теги для полного описания материала? (yes/no)
  • hgu_title – [Строка] – ЧПУ материала
<?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('/faq', array( 'question' => 'Мой вопрос из API', 'subject' => 'Название вопроса' )); 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-urlencode "question=Мой вопрос из API" --data-urlencode "subject=Название вопроса" http://yoursite.ucoz.ru/uapi/faq
{ "includehtml_desc":"yes", "end2br_msg":"no", "answer":null, "subject":"Название вопроса", "pending":"no", "author_email":null, "author":null, "description":null, "who_add":"Dmitry", "add_date":"2015-01-20 03:38", "sort":0, "end2br_desc":"no", "includehtml_msg":"yes", "hgu_title":"nazvanie_voprosa" } { "includehtml_desc":"yes", "end2br_msg":"no", "answer":null, "subject":"Название вопроса", "pending":"no", "author_email":null, "author":null, "description":null, "who_add":"Dmitry", "add_date":"2015-01-20 03:38", "sort":0, "end2br_desc":"no", "includehtml_msg":"yes", "hgu_title":"nazvanie_voprosa" }
 

[PUT] Редактор вопроса


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

  • includehtml_desc – [Строка] – Включить HTML-теги для краткого описания материала? (yes/no)
  • end2br_msg – [Строка] – Статус опции "Заменять теги переноса на <br />" для полного описания материала (yes/no)
  • answer – [Строка] – Ответ на вопрос
  • subject – [Строка] – Тема вопроса
  • pending – [Строка] – В ожидани ли активации материал? (yes/no)
  • author_email – [Строка] – Email автора материала
  • author – [Строка] – Полное имя автора материала
  • description_type=(html|bb|plain) – [Строка] – Краткое описание материала
  • who_add – [Строка] – Никнейм пользователя, добавивший материал
  • sort –
  • end2br_desc – [Строка] – Статус опции "Заменять теги переноса на <br />" для краткого описания материала (yes/no)
      •   category – [Массив] – О категории
    • faqs_count – [Строка] – Общее количество вопросов в категории
    • name – [Строка] – Название категории материала
    • url – [Строка] – Ссылка на категорию материала
    • id – [Число] – ID категории материала
    • description – [Строка] – Описание категории материала
    • hgu_title – [Строка] – ЧПУ категории
  • includehtml_msg – [Строка] – Включить HTML-теги для полного описания материала? (yes/no)
  • hgu_title – [Строка] – ЧПУ материала
<?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('/faq', array( 'id' => '3', 'question' => 'Изменил вопрос по API', 'subject' => 'Измененное название' )); 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-urlencode "id=3" --data-urlencode "question=Изменил вопрос по API" --data-urlencode "subject=Измененное название" http://yoursite.ucoz.ru/uapi/faq
{ "includehtml_desc":"yes", "end2br_msg":"no", "answer":"newone3", "subject":"Измененное название", "pending":"no", "author_email":"", "author":"", "description":"newone2", "add_date":"2015-01-20 03:45", "sort":0, "end2br_desc":"no", "category":{ "faqs_count":"1", "name":"Катгория1", "url":"http://yoursite.ucoz.ru/faq/1-1", "id":1, "description":"\n", "hgu_title":null }, "includehtml_msg":"yes", "hgu_title":"newone" } { "includehtml_desc":"yes", "end2br_msg":"no", "answer":"newone3", "subject":"Измененное название", "pending":"no", "author_email":"", "author":"", "description":"newone2", "add_date":"2015-01-20 03:45", "sort":0, "end2br_desc":"no", "category":{ "faqs_count":"1", "name":"Катгория1", "url":"http://yoursite.ucoz.ru/faq/1-1", "id":1, "description":"\n", "hgu_title":null }, "includehtml_msg":"yes", "hgu_title":"newone" }
 

[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('/faq/question', array( 'id' => '1' )); print_r($response); //Получаем ответ curl -i -X DELETE -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=1" http://yoursite.ucoz.ru/uapi/faq/question
{ "success":{ "msg":"Материал удалён" } } { "success":{ "msg":"Материал удалён" } }
 

[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('/faq/tags', 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=значение" --data-urlencode "id=1" http://yoursite.ucoz.ru/uapi/faq/tags
{ "tags":[ "тег1", "тег2", "тег3" ] { "tags":[ "тег1", "тег2", "тег3" ]

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