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

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


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

        sites – [Массив] – Информация о материалах модуля
    • other3 – [Строка] – Значение поля "Дополнительное поле 3"
    • reads – [Число] – Количество просмотров материала
    • other5 – [Строка] – Значение поля "Дополнительное поле 5"
    • comments_url – [Строка] – Ссылка на страницу материала с комментариями
    • other1 – [Строка] – Значение поля "Дополнительное поле 1"
    • rate_num – [Число] – Количество голосов (рейтинг)
    • author_email – [Строка] – Email автора материала
    • author – [Строка] – Полное имя автора материала
    • comments – [Строка] – Позволить оставлять комментарии? (yes/no)
    • rating – [Число] – Рейтинг материала (Общая сумма рейтинга/на количество голосов)
    • add_date – [Строка] – Время добавления материала
    • rate_sum – [Число] – Общая сумма рейтинга
      • categories – [Массив] – О категории материала
      • access2upload – Группы, имеющие возможность скачивать файлы
      • url – [Строка] – Ссылка на категорию материала
      • access2add – [Массив] – Права на добавление материалов в категорию
      • name – [Строка] – Название категории материала
      • access2category – [Массив] – Право на просмотр категории материала
      • id – [Число] – ID категории материала
      • description – [Строка] – Описание категории материала
    • id – [Число] – ID полученного материала
    • ontop – [Строка] – Показывать материал всегда сверху? (yes/no)
    • author_site – [Строка] – Ссылка на сайт автора
    • subscribe – [Строка] – Включена ли подписка на комментарии (уведомления) (yes/no)
    • other2 – [Строка] – Значение поля "Дополнительное поле 2"
    • pending – [Строка] – В ожидани ли активации материал? (yes/no)
    • link2site – [Строка] – Значение поля "Ссылка на сайт"
    • description_type=(html|bb|plain) – [Строка] – Краткое описание материала
    • message_type=(html|bb|plain) – [Строка] – Полное описание материала
    • entry_url – [Строка] – Полная ссылка на материал
    • who_add – [Строка] – Никнейм пользователя, добавивший материал
    • redirects – [Число] – Количество переходов на сайт
    • sort
    • comments_num – [Число] – Количество добавленных комментариев к материалу
    • title – [Строка] – Название материала
    • hgu_title – [Строка] – ЧПУ материала
  • page – [Число] – Количество страниц комментариев
  • pages_list – [Массив] – Возможные страницы в переключателе комментариев
  • per_page – [Число] – Количество комментариев на 1 страницу
  • total_sites – [Число] – Общее количество материалов в модуле

Особенности

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('/dir', 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/dir
{ "sites":[ { "other3":"допполе3", "reads":0, "other5":"допполе5", "comments_url":"http://yoursite.ucoz.ru/dir/avtomobili/nazvanie_sajta/1-1-0-13#comments", "other1":"допполе1", "rate_num":0, "author_email":"myemail", "author":"полноеимя", "comments":"yes", "rating":"0.00", "add_date":"2015-01-21 07:05", "rate_sum":0, "category":{ "access2upload":[ "Все группы" ], "url":"http://yoursite.ucoz.ru/dir/avtomobili/1", "access2add":[ "Все группы" ], "name":"Автомобили", "access2category":[ "Все группы" ], "id":1, "description":"" }, "id":13, "ontop":"no", "other4":"допполе4", "author_site":"http://mywebsite", "subscribe":"yes", "other2":"допполе2", "pending":"no", "link2site":"http://ссылканасайт", "description_type=bb":"описание сайта", "message_type=html":"полный текст описания", "entry_url":"http://yoursite.ucoz.ru/dir/avtomobili/nazvanie_sajta/1-1-0-13", "who_add":"Dmitry", "redirects":0, "sort":0, "comments_num":0, "title":"Название сайта", "hgu_title":"nazvanie_sajta" }, { //информация о втором материале }, { //информация о третьем материале } ], "page":1, "pages":"1", "per_page":"1", "total_sites":1 } { "sites":[ { "other3":"допполе3", "reads":0, "other5":"допполе5", "comments_url":"http://yoursite.ucoz.ru/dir/avtomobili/nazvanie_sajta/1-1-0-13#comments", "other1":"допполе1", "rate_num":0, "author_email":"myemail", "author":"полноеимя", "comments":"yes", "rating":"0.00", "add_date":"2015-01-21 07:05", "rate_sum":0, "category":{ "access2upload":[ "Все группы" ], "url":"http://yoursite.ucoz.ru/dir/avtomobili/1", "access2add":[ "Все группы" ], "name":"Автомобили", "access2category":[ "Все группы" ], "id":1, "description":"" }, "id":13, "ontop":"no", "other4":"допполе4", "author_site":"http://mywebsite", "subscribe":"yes", "other2":"допполе2", "pending":"no", "link2site":"http://ссылканасайт", "description_type=bb":"описание сайта", "message_type=html":"полный текст описания", "entry_url":"http://yoursite.ucoz.ru/dir/avtomobili/nazvanie_sajta/1-1-0-13", "who_add":"Dmitry", "redirects":0, "sort":0, "comments_num":0, "title":"Название сайта", "hgu_title":"nazvanie_sajta" }, { //информация о втором материале }, { //информация о третьем материале } ], "page":1, "pages":"1", "per_page":"1", "total_sites":1 }
 

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


      sites – [Массив] – Информация о материалах модуля
  • other3 – [Строка] – Значение поля "Дополнительное поле 3"
  • reads – [Число] – Количество просмотров материала
  • other5 – [Строка] – Значение поля "Дополнительное поле 5"
  • comments_url – [Строка] – Ссылка на страницу материала с комментариями
  • other1 – [Строка] – Значение поля "Дополнительное поле 1"
  • rate_num – [Число] – Количество голосов (рейтинг)
  • author_email – [Строка] – Email автора материала
  • author – [Строка] – Полное имя автора материала
  • comments – [Строка] – Позволить оставлять комментарии? (yes/no)
  • rating – [Число] – Рейтинг материала (Общая сумма рейтинга/на количество голосов)
  • add_date – [Строка] – Время добавления материала
  • rate_sum – [Число] – Общая сумма рейтинга
    • categories – [Массив] – О категории материала
    • access2upload – Группы, имеющие возможность скачивать файлы
    • url – [Строка] – Ссылка на категорию материала
    • access2add – [Массив] – Права на добавление материалов в категорию
    • name – [Строка] – Название категории материала
    • access2category – [Массив] – Право на просмотр категории материала
    • id – [Число] – ID категории материала
    • description – [Строка] – Описание категории материала
  • id – [Число] – ID полученного материала
  • ontop – [Строка] – Показывать материал всегда сверху? (yes/no)
  • author_site – [Строка] – Ссылка на сайт автора
  • subscribe – [Строка] – Включена ли подписка на комментарии (уведомления) (yes/no)
  • other2 – [Строка] – Значение поля "Дополнительное поле 2"
  • pending – [Строка] – В ожидани ли активации материал? (yes/no)
  • link2site – [Строка] – Значение поля "Ссылка на сайт"
  • description_type=(html|bb|plain) – [Строка] – Краткое описание материала
  • message_type=(html|bb|plain) – [Строка] – Полное описание материала
  • entry_url – [Строка] – Полная ссылка на материал
  • who_add – [Строка] – Никнейм пользователя, добавивший материал
  • redirects – [Число] – Количество переходов на сайт
  • sort
  • comments_num – [Число] – Количество добавленных комментариев к материалу
  • title – [Строка] – Название материала
  • hgu_title – [Строка] – ЧПУ материала

Особенности

1) В переменных description и message переносы строк автоматически меняются на \n (в случае, если перенос строки был сделан без html-тега <br />)
2) В переменных description и message если там есть html-тег переноса <br /> – будет осуществлен и визуальный перенос строки, без вывода <br /> (то есть html-тег воспроизведется)
3) Переменные access2category и access2add могут иметь другой вид, если права установлены для всех групп пользователей
4) Если у материала категория входит в раздел – то раздел никак не будет получен в GET-запросе
5) Если материал входит в более 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('/dir', array( 'id' => 'АЙДМАТЕРИАЛА' )); print_r($response); //Получаем ответ url -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://youresite.ucoz.ru/uapi/dir
{ "sites":[ { "other3":"допполе3", "reads":0, "other5":"допполе5", "comments_url":"http://yoursite.ucoz.ru/dir/avtomobili/nazvanie_sajta/1-1-0-13#comments", "other1":"допполе1", "rate_num":0, "author_email":"myemail", "author":"полноеимя", "comments":"yes", "rating":"0.00", "add_date":"2015-01-21 07:05", "rate_sum":0, "category":{ "access2upload":[ "Все группы" ], "url":"http://yoursite.ucoz.ru/dir/avtomobili/1", "access2add":[ "Все группы" ], "name":"Автомобили", "access2category":[ "Все группы" ], "id":1, "description":"" }, "id":13, "ontop":"no", "other4":"допполе4", "author_site":"http://mywebsite", "subscribe":"yes", "other2":"допполе2", "pending":"no", "link2site":"http://ссылканасайт", "description_type=bb":"описание сайта", "message_type=html":"полный текст описания", "entry_url":"http://yoursite.ucoz.ru/dir/avtomobili/nazvanie_sajta/1-1-0-13", "who_add":"Dmitry", "redirects":0, "sort":0, "comments_num":0, "title":"Название сайта", "hgu_title":"nazvanie_sajta" } } { "sites":[ { "other3":"допполе3", "reads":0, "other5":"допполе5", "comments_url":"http://yoursite.ucoz.ru/dir/avtomobili/nazvanie_sajta/1-1-0-13#comments", "other1":"допполе1", "rate_num":0, "author_email":"myemail", "author":"полноеимя", "comments":"yes", "rating":"0.00", "add_date":"2015-01-21 07:05", "rate_sum":0, "category":{ "access2upload":[ "Все группы" ], "url":"http://yoursite.ucoz.ru/dir/avtomobili/1", "access2add":[ "Все группы" ], "name":"Автомобили", "access2category":[ "Все группы" ], "id":1, "description":"" }, "id":13, "ontop":"no", "other4":"допполе4", "author_site":"http://mywebsite", "subscribe":"yes", "other2":"допполе2", "pending":"no", "link2site":"http://ссылканасайт", "description_type=bb":"описание сайта", "message_type=html":"полный текст описания", "entry_url":"http://yoursite.ucoz.ru/dir/avtomobili/nazvanie_sajta/1-1-0-13", "who_add":"Dmitry", "redirects":0, "sort":0, "comments_num":0, "title":"Название сайта", "hgu_title":"nazvanie_sajta" } }
//для особенности 3 "access2add":[ "Все группы" ], //для особенности 3 "access2category":[ "Все группы" ], //для особенности 3 "access2add":[ "Все группы" ], //для особенности 3 "access2category":[ "Все группы" ],
 

[GET] из определенной категории


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

        sites – [Массив] – Информация о материалах модуля
    • other3 – [Строка] – Значение поля "Дополнительное поле 3"
    • reads – [Число] – Количество просмотров материала
    • other5 – [Строка] – Значение поля "Дополнительное поле 5"
    • comments_url – [Строка] – Ссылка на страницу материала с комментариями
    • other1 – [Строка] – Значение поля "Дополнительное поле 1"
    • rate_num – [Число] – Количество голосов (рейтинг)
    • author_email – [Строка] – Email автора материала
    • author – [Строка] – Полное имя автора материала
    • comments – [Строка] – Позволить оставлять комментарии? (yes/no)
    • rating – [Число] – Рейтинг материала (Общая сумма рейтинга/на количество голосов)
    • add_date – [Строка] – Время добавления материала
    • rate_sum – [Число] – Общая сумма рейтинга
      • categories – [Массив] – О категории материала
      • access2upload – Группы, имеющие возможность скачивать файлы
      • url – [Строка] – Ссылка на категорию материала
      • access2add – [Массив] – Права на добавление материалов в категорию
      • name – [Строка] – Название категории материала
      • access2category – [Массив] – Право на просмотр категории материала
      • id – [Число] – ID категории материала
      • description – [Строка] – Описание категории материала
    • id – [Число] – ID полученного материала
    • ontop – [Строка] – Показывать материал всегда сверху? (yes/no)
    • author_site – [Строка] – Ссылка на сайт автора
    • subscribe – [Строка] – Включена ли подписка на комментарии (уведомления) (yes/no)
    • other2 – [Строка] – Значение поля "Дополнительное поле 2"
    • pending – [Строка] – В ожидани ли активации материал? (yes/no)
    • link2site – [Строка] – Значение поля "Ссылка на сайт"
    • description_type=(html|bb|plain) – [Строка] – Краткое описание материала
    • message_type=(html|bb|plain) – [Строка] – Полное описание материала
    • entry_url – [Строка] – Полная ссылка на материал
    • who_add – [Строка] – Никнейм пользователя, добавивший материал
    • redirects – [Число] – Количество переходов на сайт
    • sort
    • comments_num – [Число] – Количество добавленных комментариев к материалу
    • title – [Строка] – Название материала
    • hgu_title – [Строка] – ЧПУ материала
  • page – [Число] – Количество страниц комментариев
  • pages_list – [Массив] – Возможные страницы в переключателе комментариев
  • per_page – [Число] – Количество комментариев на 1 страницу
  • total_sites – [Число] – Общее количество материалов в модуле
    • categories – [Массив] – О категории материала
    • access2upload – Группы, имеющие возможность скачивать файлы
    • url – [Строка] – Ссылка на категорию материала
    • access2add – [Массив] – Права на добавление материалов в категорию
    • name – [Строка] – Название категории материала
    • access2category – [Массив] – Право на просмотр категории материала
    • id – [Число] – ID категории материала
    • description – [Строка] – Описание категории материала

Особенности

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('/dir', array( 'category' => 'АЙДИКАТЕГОРИИ' )); 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 "category=АЙДИКАТЕГОРИИ" http://youresite.ucoz.ru/uapi/dir
{ "sites":[ { "other3":"допполе3", "reads":0, "other5":"допполе5", "comments_url":"http://yoursite.ucoz.ru/dir/avtomobili/nazvanie_sajta/1-1-0-13#comments", "other1":"допполе1", "loads":0, "rate_num":0, "author_email":"myemail", "author":"полноеимя", "comments":"yes", "rating":"0.00", "add_date":"2015-01-21 07:05", "rate_sum":0, "id":13, "ontop":"no", "other4":"допполе4", "author_site":"http://mywebsite", "subscribe":"yes", "other2":"допполе2", "pending":"no", "link2site":"http://ссылканасайт", "description_type=bb":"описание сайта", "message_type=html":"полный текст описания", "entry_url":"http://yoursite.ucoz.ru/dir/avtomobili/nazvanie_sajta/1-1-0-13", "who_add":"Dmitry", "redirects":0, "sort":0, "comments_num":0, "title":"Название сайта", "hgu_title":"nazvanie_sajta" } ], "page":1, "pages":"1", "per_page":"20", "total_sites":1, "category":{ "access2upload":[ "Все группы" ], "url":"http://yoursite.ucoz.ru/dir/avtomobili/1", "access2add":[ "Все группы" ], "name":"Автомобили", "access2category":[ "Все группы" ], "id":1, "description":"" } } { "sites":[ { "other3":"допполе3", "reads":0, "other5":"допполе5", "comments_url":"http://yoursite.ucoz.ru/dir/avtomobili/nazvanie_sajta/1-1-0-13#comments", "other1":"допполе1", "loads":0, "rate_num":0, "author_email":"myemail", "author":"полноеимя", "comments":"yes", "rating":"0.00", "add_date":"2015-01-21 07:05", "rate_sum":0, "id":13, "ontop":"no", "other4":"допполе4", "author_site":"http://mywebsite", "subscribe":"yes", "other2":"допполе2", "pending":"no", "link2site":"http://ссылканасайт", "description_type=bb":"описание сайта", "message_type=html":"полный текст описания", "entry_url":"http://yoursite.ucoz.ru/dir/avtomobili/nazvanie_sajta/1-1-0-13", "who_add":"Dmitry", "redirects":0, "sort":0, "comments_num":0, "title":"Название сайта", "hgu_title":"nazvanie_sajta" } ], "page":1, "pages":"1", "per_page":"20", "total_sites":1, "category":{ "access2upload":[ "Все группы" ], "url":"http://yoursite.ucoz.ru/dir/avtomobili/1", "access2add":[ "Все группы" ], "name":"Автомобили", "access2category":[ "Все группы" ], "id":1, "description":"" } }
//для особенности 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('/dir', array( 'category' => 'АЙДИКАТЕГОРИИ', 'page' => '2' )); print_r($response); //Получаем ответ //для особенности 1 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 "category=АЙДИКАТЕГОРИИ" http://youresite.ucoz.ru/uapi/dir?page=2
 

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


Параметры для запроса

  • other3 – [Строка] – Значение поля "Дополнительное поле 3"
  • file1 – [Файл] – Изображение материала (в случае, если нужно несколько, то file2, file3)
  • end2br_msg – [Строка] – Статус опции "Заменять теги переноса на <br />" для полного описания материала (yes/no)
  • other5 – [Строка] – Значение поля "Дополнительное поле 5"
  • other1 – [Строка] – Значение поля "Дополнительное поле 1"
  • author_email – [Строка] – Email автора материала
  • author – [Строка] – Полное имя автора материала
  • filters – [Массив] – В какие фильтры входит материал
  • comments – [Строка] – Позволить оставлять комментарии? (yes/no)
  • end2br_desc – [Строка] – Статус опции "Заменять теги переноса на <br />" для краткого описания материала (yes/no)
    • categories – [Массив] – О категории материала
    • access2upload – Группы, имеющие возможность скачивать файлы
    • url – [Строка] – Ссылка на категорию материала
    • access2add – [Массив] – Права на добавление материалов в категорию
    • name – [Строка] – Название категории материала
    • access2category – [Массив] – Право на просмотр категории материала
    • id – [Число] – ID категории материала
    • description – [Строка] – Описание категории материала
  • other4 – [Строка] – Значение поля "Дополнительное поле 4"
  • ontop – [Строка] – Показывать материал всегда сверху? (yes/no)
  • includehtml_desc – [Строка] – Включить HTML-теги для краткого описания материала? (yes/no)
  • author_site – [Строка] – Ссылка на сайт автора
  • author_site – [Строка] – Ссылка на сайт автора
  • subscribe – [Строка] – Включена ли подписка на комментарии (уведомления) (yes/no)
  • other2 – [Строка] – Значение поля "Дополнительное поле 2"
  • pending – [Строка] – В ожидани ли активации материал? (yes/no)
  • link2site – [Строка] – Значение поля "Ссылка на сайт"
  • description_type=(html|bb|plain) – [Строка] – Краткое описание материала
  • message_type=(html|bb|plain) – [Строка] – Полное описание материала
  • who_add – [Строка] – Никнейм пользователя, добавивший материал
  • till_date – [Строка] – До какого числа объявление активно (timestamp)
  • sort
  • title – [Строка] – Название материала
  • includehtml_msg – [Строка] – Включить HTML-теги для полного описания материала? (yes/no)
  • hgu_title – [Строка] – ЧПУ материала

Особенности

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('/dir', array( 'category' => '1', 'title' => 'API – Название материала', 'description' => 'API – Краткое описание материала', 'file1' => '@dm.png' )); 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=1" --data-urlencode "title=API – Новое название" --data-urlencode "description=API – Краткое описание" http://yoursite.ucoz.ru/uapi/dir
{ "other3":null, "files":[ { "small":"http://yoursite.ucoz.ru/_dr/0/s57172723.jpg", "full_height":1200, "full_width":1000, "small_height":150, "small_width":125, "full":"http://yoursite.ucoz.ru/_dr/0/57172723.jpg" } ], "end2br_msg":"no", "other5":null, "other1":null, "author_email":"Email автора", "author":null, "comments":"yes", "end2br_desc":"no", "category":{ "access2upload":[ "Все группы" ], "url":"http://yoursite.ucoz.ru/dir/avtomobili/1", "access2add":[ "Все группы" ], "name":"Автомобили", "access2category":[ "Все группы" ], "id":1, "description":"" }, "other4":null, "ontop":"no", "includehtml_desc":"yes", "author_site":"http://Веб-сайт автора", "subscribe":"no", "other2":null, "pending":"no", "link2site":null, "description_type=bb":"API – Краткое описание материала", "message_type=html":"Полное описание материала", "who_add":"Dmitry", "sort":"", "title":"API – Название материала", "includehtml_msg":"yes", "hgu_title":"nazvanie_materiala" } { "other3":null, "files":[ { "small":"http://yoursite.ucoz.ru/_dr/0/s57172723.jpg", "full_height":1200, "full_width":1000, "small_height":150, "small_width":125, "full":"http://yoursite.ucoz.ru/_dr/0/57172723.jpg" } ], "end2br_msg":"no", "other5":null, "other1":null, "author_email":"Email автора", "author":null, "comments":"yes", "end2br_desc":"no", "category":{ "access2upload":[ "Все группы" ], "url":"http://yoursite.ucoz.ru/dir/avtomobili/1", "access2add":[ "Все группы" ], "name":"Автомобили", "access2category":[ "Все группы" ], "id":1, "description":"" }, "other4":null, "ontop":"no", "includehtml_desc":"yes", "author_site":"http://Веб-сайт автора", "subscribe":"no", "other2":null, "pending":"no", "link2site":null, "description_type=bb":"API – Краткое описание материала", "message_type=html":"Полное описание материала", "who_add":"Dmitry", "sort":"", "title":"API – Название материала", "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('/dir/tags', array( 'id' => '1', 'tags' => 'тег1,тест2', )); 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 "id=1" --data-urlencode "tags=тег1,тест2" http://yoursite.ucoz.ru/uapi/dir
{ "success":{ "msg":"Данные по тегам материала обновлены" } } { "success":{ "msg":"Данные по тегам материала обновлены" } }
 

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


Параметры для запроса

  • other3 – [Строка] – Значение поля "Дополнительное поле 3"
  • file1 – [Файл] – Изображение материала (в случае, если нужно несколько, то file2, file3)
  • end2br_msg – [Строка] – Статус опции "Заменять теги переноса на <br />" для полного описания материала (yes/no)
  • other5 – [Строка] – Значение поля "Дополнительное поле 5"
  • other1 – [Строка] – Значение поля "Дополнительное поле 1"
  • author_email – [Строка] – Email автора материала
  • author – [Строка] – Полное имя автора материала
  • filters – [Массив] – В какие фильтры входит материал
  • comments – [Строка] – Позволить оставлять комментарии? (yes/no)
  • end2br_desc – [Строка] – Статус опции "Заменять теги переноса на <br />" для краткого описания материала (yes/no)
    • categories – [Массив] – О категории материала
    • access2upload – Группы, имеющие возможность скачивать файлы
    • url – [Строка] – Ссылка на категорию материала
    • access2add – [Массив] – Права на добавление материалов в категорию
    • name – [Строка] – Название категории материала
    • access2category – [Массив] – Право на просмотр категории материала
    • id – [Число] – ID категории материала
    • description – [Строка] – Описание категории материала
  • other4 – [Строка] – Значение поля "Дополнительное поле 4"
  • ontop – [Строка] – Показывать материал всегда сверху? (yes/no)
  • includehtml_desc – [Строка] – Включить HTML-теги для краткого описания материала? (yes/no)
  • author_site – [Строка] – Ссылка на сайт автора
  • author_site – [Строка] – Ссылка на сайт автора
  • subscribe – [Строка] – Включена ли подписка на комментарии (уведомления) (yes/no)
  • other2 – [Строка] – Значение поля "Дополнительное поле 2"
  • pending – [Строка] – В ожидани ли активации материал? (yes/no)
  • link2site – [Строка] – Значение поля "Ссылка на сайт"
  • description_type=(html|bb|plain) – [Строка] – Краткое описание материала
  • message_type=(html|bb|plain) – [Строка] – Полное описание материала
  • who_add – [Строка] – Никнейм пользователя, добавивший материал
  • till_date – [Строка] – До какого числа объявление активно (timestamp)
  • sort
  • title – [Строка] – Название материала
  • includehtml_msg – [Строка] – Включить HTML-теги для полного описания материала? (yes/no)
  • hgu_title – [Строка] – ЧПУ материала

Особенности

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('/dir', array( 'id' => '1', 'title' => 'API – Новое Название материала', 'description' => 'API – Новое Краткое описание материала', 'file1' => '@dm.png' )); print_r($response); //Получаем ответ url -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=1" --data-urlencode "title=API – Новое Название материала" --data-urlencode "description=API – Новое Краткое описание материала" http://yoursite.ucoz.ru/uapi/dir
{ "other3":null, "files":[ { "small":"http://yoursite.ucoz.ru/_dr/0/s57172723.jpg", "full_height":1200, "full_width":1000, "small_height":150, "small_width":125, "full":"http://yoursite.ucoz.ru/_dr/0/57172723.jpg" } ], "end2br_msg":"no", "other5":null, "other1":null, "author_email":"Email автора", "author":null, "comments":"yes", "end2br_desc":"no", "category":{ "access2upload":[ "Все группы" ], "url":"http://yoursite.ucoz.ru/dir/avtomobili/1", "access2add":[ "Все группы" ], "name":"Автомобили", "access2category":[ "Все группы" ], "id":1, "description":"" }, "other4":null, "ontop":"no", "includehtml_desc":"yes", "author_site":"http://Веб-сайт автора", "subscribe":"no", "other2":null, "pending":"no", "link2site":null, "description_type=bb":"API – Новое Краткое описание материала", "message_type=html":"Полное описание материала", "who_add":"Dmitry", "sort":"", "title":"API – Новое Название материала", "includehtml_msg":"yes", "hgu_title":"nazvanie_materiala" } { "other3":null, "files":[ { "small":"http://yoursite.ucoz.ru/_dr/0/s57172723.jpg", "full_height":1200, "full_width":1000, "small_height":150, "small_width":125, "full":"http://yoursite.ucoz.ru/_dr/0/57172723.jpg" } ], "end2br_msg":"no", "other5":null, "other1":null, "author_email":"Email автора", "author":null, "comments":"yes", "end2br_desc":"no", "category":{ "access2upload":[ "Все группы" ], "url":"http://yoursite.ucoz.ru/dir/avtomobili/1", "access2add":[ "Все группы" ], "name":"Автомобили", "access2category":[ "Все группы" ], "id":1, "description":"" }, "other4":null, "ontop":"no", "includehtml_desc":"yes", "author_site":"http://Веб-сайт автора", "subscribe":"no", "other2":null, "pending":"no", "link2site":null, "description_type=bb":"API – Новое Краткое описание материала", "message_type=html":"Полное описание материала", "who_add":"Dmitry", "sort":"", "title":"API – Новое Название материала", "includehtml_msg":"yes", "hgu_title":"nazvanie_materiala" }
 

[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('/dir/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/dir/posts
{ "success":{ "msg":"Материал удалён" } } { "success":{ "msg":"Материал удалён" } }

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