URL:
https://recobox.ru/api/1.0/comments/add
Метод POST
Параметры | Тип | Описание |
---|---|---|
widget_id | число | обязателен, ID виджета, можно найти в настройках виджета. |
api_key | строка | обязателен, API ключ, можно найти в настройках виджета. |
channel | массив | обязателен, данные канала в который будут добавлены комментарии. |
channel.id | число | не обязателен, уникальный идентификатор канала из Recobox, если этот параметр указан, то остальные параметры канала игнорируются. |
channel.name | строка | не обязателен, уникальное название канала, если не указан то берется из url без домена. |
channel.url | строка | обязателен, url страница канала. |
channel.title | строка | не обязателен, название страницы канала, если не указан то заполняется из url. Обчно берется из тега title на странице если не используется API. |
comments | массив | обязателен, массив с комментариями. Не больше 200 комментариев за 1 запрос |
comments.id | число | обязателен, id комментария из вашей системы, должен быть уникальным в рамках виджета |
comments.parent_id | число | не обязателен, id родительского комментария из вашей системы |
comments.text | строка | обязателен, текст комментария |
comments.ip | ip адрес | обязателен, ip адрес автора комментария |
comments.status | строка | обязателен, статус комментария, возможны значения: pending - ожидает модерации, approved - одобрен, deleted - удален, spam - спам |
comments.created_at | число | обязателен, время создания комментария в секундах |
comments.media | массив | не обязателен, массив с url ссылками на медиа файлы |
comments.media.path | строка | путь к картинке или видео |
comments.media.type | строка | тип вложения, возможны значения: url - ссылка на изображение, video - ссылка на видео |
comments.user | массив | обязателен, массив с данными автора комментария |
comments.user.id | число | не обязателен, id пользователя зарегистрированного на вашем сайте. Если активирована опция SSO авторизации то пользователь сможет оставлять комментарии от своего имени |
comments.user.name | строка | обязателен, имя пользователя |
comments.user.email | строка | обязателен, email пользователя |
comments.user.avatar | строка | не обязателен, аватарка пользователя, для избежания искажения изображения рекомендуется размер не больше 50х50px |
comments.user.social_page | строка | не обязателен, страница на профиль пользователя |
Если не указан comments.user.id то пользователь будет создан с пометкой "анонимный", иначе как SSO пользователь.
Пример передаваемого массива:
$data = [ 'widget_id' => 10, 'api_key' => 'API_KEY', 'channel' => [ 'name' => 'comments-page', 'url' => 'http://test.ru/comments-page', 'title' => 'Страница с комментариями' ], 'comments' => [ [ 'id' => 123456, 'parent_id' => '123455', 'text' => 'Текст комментария...', 'ip' => '127.0.0.1', 'status' => 'approved', 'created_at' => 1335939007, 'media' => [ [ 'path' => 'http://test.ru/uploads/file1.jpg', 'type' => 'url' ], [ 'path' => 'https://www.youtube.com/watch?v=dr0IKNq3j2U', 'type' => 'video' ], ], 'user' => [ 'id' => 125846, 'name' => 'Иван', 'email' => 'ivan@recobox.ru', 'avatar' => 'http://test.ru/uploads/avatar.jpg', 'social_page' => 'http://test.ru/ivan_page' ] ] ] ]
Если выполнение метода завершилось ошибкой, то вернется массив:
[ 'result' => 'error', 'message' => 'текст ошибки' ]
Если ошибок не было:
[ 'result' => 'finish', 'channel' => [ // данные канала в который были добавлены новые комментарии ] ]
URL:
https://recobox.ru/api/1.0/channels/lists
Метод POST
Параметры | Тип | Описание |
---|---|---|
widget_id | число | обязателен, ID виджета, можно найти в настройках виджета. |
api_key | строка | обязателен, API ключ, можно найти в настройках виджета. |
offset | число | не обязателен, смещение списка каналов. |
limit | число | не обязателен, кол-во возвращаемых каналов, максимальное значение 200. |
URL:
https://recobox.ru/api/1.0/comments/lists
Метод POST
Параметры | Тип | Описание |
---|---|---|
widget_id | число | обязателен, ID виджета, можно найти в настройках виджета. |
api_key | строка | обязателен, API ключ, можно найти в настройках виджета. |
cid | число | обязателен если не указан cname , если указан cid то cname игнорируется. ID калана в системе Recobox. |
cname | строка | обязателен если не указан cid , если указан cid то cname игнорируется. Текстовый идентификатор канала в системе Recobox. |
offset | число | не обязателен, смещение списка комментариев. |
limit | число | не обязателен, кол-во возвращаемых комментариев, максимальное значение 200. |
URL:
https://recobox.ru/api/1.0/comments/status
Метод POST
Параметры | Тип | Описание |
---|---|---|
widget_id | число | обязателен, ID виджета, можно найти в настройках виджета. |
api_key | строка | обязателен, API ключ, можно найти в настройках виджета. |
ids | массив | обязателен, список ID значений комментариев из системы Recobox. |
status | строка | обязателен, новый статус комментариев, возможны значения: approved, deleted, spam, pending. |