Основы uAPI

page – [Число] – Номер текущей страницы
pages_list – [Число] – Общее количество страниц в модуле
per_page – [Число] – Количество материалов на страницу
blogs – [Массив] – Первый полученный материал
- 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 – [Строка] – ЧПУ материала
- meta_title - [Строка] - Meta Title
- meta_description - [Строка] - Meta Description
- meta_keywords - [Строка] - Meta Keywords
total_blog – [Число] – Общее количество материалов в модуле

Особенности

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

<?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('/blog', array(
    // без параметров
));
print_r($response); // Получаем ответ
?>

{
    "page":1,
    "pages_list":"1..32",
    "per_page":"1",
    "blogs":[
        {
            "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/blog/test/2016-03-26-61",
            "message":"Текст",
            "title":"тест",
            "hgu_title":"test",
            "meta_title":"Название материала",
            "meta_description":"Описание материала",
            "meta_keywords":"ключ1, ключ2, ключ3"
        }, {
            //второй материал
        }, {
            //третий материал
        }
    ],
    "total_blog":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('/blog', array(
    'page' => '2'
));
print_r($response); // Получаем ответ

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

Обязательный параметр: ID (айди материала)

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

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 – [Строка] – ЧПУ материала
meta_title - [Строка] - Meta Title
meta_description - [Строка] - Meta Description
meta_keywords - [Строка] - Meta Keywords
prev_entry_url - [Строка] - Полная ссылка на предыдущий материал
next_entry_url - [Строка] - Полная ссылка на следующий материал

Особенности

В переменных description и message переносы строк автоматически меняются на \n (в случае, если перенос строки был сделан без html-тега )
В переменных description и message если там есть html-тег переноса – будет осуществлен и визуальный перенос строки, без вывода (то есть html-тег воспроизведется)
Переменные access2category и access2add могут иметь другой вид, если права установлены для всех групп пользователей
Если материал входит в более 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('/blog', array(
    'id' => 'АЙДИМАТЕРИАЛА'
));
print_r($response); // Получаем ответ

{
    "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":"https://yoursite.ucoz.ru/blog/test/2016-03-26-61",
    "message":"Текст",
    "title":"тест",
    "hgu_title":"test",
    "meta_title":"Название материала",
    "meta_description":"Описание материала",
    "meta_keywords":"ключ1, ключ2, ключ3",
    "prev_entry_url":"https://yoursite.ucoz.ru/blog/test/2016-03-26-60",
    "next_entry_url":"https://yoursite.ucoz.ru/blog/test/2016-03-26-62",
}

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

Обязательные параметры: date (год-месяц-день)

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

page – [Число] – Номер текущей страницы
pages_list – [Число] – Общее количество страниц в модуле
per_page – [Число] – Количество материалов на страницу
blogs – [Массив] – Первый полученный материал
- 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 – [Строка] – ЧПУ материала
- meta_title - [Строка] - Meta Title
- meta_description - [Строка] - Meta Description
- meta_keywords - [Строка] - Meta Keywords
total_blog – [Число] – Общее количество материалов в модуле

Особенности

Формат yyyy-mm-dd подразумевает расшифровку Год-Месяц-День
Если нужны материалы за определенный год, то достаточно сделать запрос с параметром '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('/blog', array(
    'date' => '2016-03-26' //формат yyyy-mm-dd
));
print_r($response); // Получаем ответ

{
    "page":1,
    "pages_list":"1",
    "per_page":"5",
    "blogs":[
        {
            "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/blog/test/2016-03-26-61",
            "message":"Текст",
            "title":"тест",
            "hgu_title":"test",
            "meta_title":"Название материала",
            "meta_description":"Описание материала",
            "meta_keywords":"ключ1, ключ2, ключ3"
        }, {
            // второй материал
        }, {
            // третий материал
        }
    ],
    "total_blog":3
}

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

Обязательные параметры: зависит от настроек модуля

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

end2br_msg – [Строка] – Статус опции "Заменять теги переноса на " для полного описания материала (yes/no)
comments – [Строка] – Позволить оставлять комментарии? (yes/no)
add_date – [Строка] – Время добавления материала
end2br_desc – [Строка] – Статус опции "Заменять теги переноса на " для краткого описания материала (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
meta_title - [Строка] - Meta Title
meta_description - [Строка] - Meta Description
meta_keywords - [Строка] - Meta Keywords

Особенности

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

<?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('/blog', array(
    'category'    => '1',
    'title'       => 'Название материала',
    'description' => 'Краткое описание материала',
    'message'     => 'Полное описание материала'
));
print_r($response); // Получаем ответ

{
    "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",
    "meta_title":"Название материала",
    "meta_description":"Описание материала",
    "meta_keywords":"ключ1, ключ2, ключ3"
}

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

Обязательные параметры: ID материала

Обратите внимание, что именно таким образом (с помощью POST-запроса) осуществляется добавление, редактирование и удаление тегов к материалу.

Если вам требуется удалить теги, достаточно отправить пустой запрос
Если вам требуется отредактировать теги, сделайте полный запрос с теми тегами, которые должны остаться
Если требуется добавить новые теги, необходимо ввести список существующих + новые теги

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

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

<?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('/blog/tags', array(
    'id'   => '1',
    'tags' => 'тег1,тест2',
));
print_r($response); // Получаем ответ

{
    "success":{
        "msg":"Данные по тегам материала обновлены"
    }
}

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

Обязательные параметры: ID материала

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

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

Особенности

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

<?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('/blog', array(
    'id'               => '188',
    'title'            => 'Новое название материала',
    'description'      => 'Новое краткое описание материала',
    'message'          => 'Новое полное описание материала',
    'author_site'      => 'Новый веб-сайт автора',
    'author_email'     => 'Новый email автора',
    'author'           => 'Новое имя автора',
    'link2source'      => 'Новый источник материала',
    'meta_title'       => 'Название материала',
    'meta_description' => 'Описание материала',
    'meta_keywords'    => 'ключ1, ключ2, ключ3'
));
print_r($response); // Получаем ответ

{
    "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] Удалить материал

Обязательные параметры: 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->delete('/blog/posts', array(
    'id' => '1'
));
print_r($response); // Получаем ответ

{
    "success":{
        "msg":"Материал удалён"
    }
}