WebMCR

API

Благодаря нашему интерфейсу API, разработчик приложения сможет обращаться к его методам посредством HTTP запросов и получать в ответ актуальную информацию с нашего сервиса в удобном JSON формате.

Большинство методов принимают POST запросы, а некоторые из них, содержат еще и подпись для доступа к закрытым методам.

API позволит получать информацию о дополнениях и их версиях, новостях, тегах, оповещениях и прочего. Полный список вы можете посмотреть в меню.

Мы так же подготовили в качестве наглядного примера схему импорта для Postman, которую вы можете скачать отсюда

Для чего можно использовать API?

Самое главное - это, конечно, автоматизация процесса получения необходимой информации с наименьшими затратами времени.

Предположим, у вас есть приложение со счётчиком продаж вашего дополнения. Чтобы счётчик менялся, вы можете либо отправлять регулярно запрос на получение кол-ва продаж, либо получать событие по факту продажи.

Для быстрого старта, вы можете использовать нашу SDK написанную на языке PHP.

Установка SDK через пакетный менеджер

Для установки вы можете воспользоваться пакетным менеджером Composer.

Bash
composer require webmcr/sdk-official-site

Подключите класс автозагрузки, который идет в комплекте с пакетным менеджером, если он еще не подключен

PHP
<?php include('./vendor/autoload.php');

Ручная установка

Для ручной установки, скачиваем исходный код отсюда. Перемещаем содержимое папки src в нужную вам директорию.

Подключаем файлы в вашем приложении

PHP
<?php include('./SiteSDKException.php'); include('./SiteSDK.php');

Работа с SDK

Подключите пространство имён и создайте объект класса SiteSDK

PHP
use webmcr\sitesdk\SiteSDKException; use webmcr\sitesdk\SiteSDK; $interfaceKey = '123456'; // Ключ интерфейса $notificationsKey = '654321'; // Ключ оповещений $sdk = new SiteSDK($interfaceKey, $notificationsKey);

В SDK имеются все методы для работы с API сайта, которые описаны в меню. Для обращения к ним, используйте символ нижнего подчеркивания "_" в качестве разделителя.

Например, если вам необходим метод /extensions/list/, вы можете обратиться к нему через объект $sdk так:

PHP
$list = $sdk->extensions_list(); // $list = $sdk->extensions_list([], true); // Вызов сигнатурного метода с пустым набором параметров

Если вам необходим метод с подписью (:sign), то в качестве второго аргумента, вы можете передать true, для активации вызова сигнатурного метода.

Исходящие запросы отправляются с вашего устройства на наше API. Абсолютное большинство отправок запросов происходит методом POST.

Многие из запросов необходимо производить с использованием подписи.

Отправка подписанных запросов

Запросы такого вида производятся с помощью добавления в конце URL адреса логина пользователя и секретного ключа интерфейса, который можно получить в настройках профиля в виде хэша md5 с разделителем "-".

Пример подписи запроса на языке PHP:

PHP
<?php $username = 'test'; $secret = md5("my_super_secret_key"); $sign = "{$username}-{$secret}"; $url = "https://api.webmcr.ru/extensions/list/{$sign}"; $params = ['sort' => ['by' => 'title', 'type' => 'desc']]; $c = curl_init($url); curl_setopt_array($c, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_AUTOREFERER => true, CURLOPT_FOLLOWLOCATION => true, CURLOPT_CONNECTTIMEOUT => 3, CURLOPT_SSL_VERIFYHOST => false, CURLOPT_SSL_VERIFYPEER => false, CURLOPT_POST => true, CURLOPT_POSTFIELDS => http_build_query($params), CURLOPT_TIMEOUT => 3, CURLOPT_MAXREDIRS => 2, CURLOPT_USERAGENT => '-' ]); $json = curl_exec($c); $error = curl_error($c); curl_close($c); $response = @json_decode($json, true); $result = is_array($response) ? $response : [ 'success' => false, 'message' => $error, 'code' => -1 ];

Пример ответа от сервера

JSON
{ "success": true, "message": "", "code": 0, "response": { "extensions": [ { "id": 1, "name": "example-extension", "title": "Example extension", "text_short": "My example extension", "images": { "large": "https://webmcr.ru/uploads/extensions/images/2022-05-16/large/f4ad85393ddcadabbc1b3536fc37ce37.webp", "medium": "https://webmcr.ru/uploads/extensions/images/2022-05-16/medium/f4ad85393ddcadabbc1b3536fc37ce37.webp", "small": "https://webmcr.ru/uploads/extensions/images/2022-05-16/small/f4ad85393ddcadabbc1b3536fc37ce37.webp", "original": "https://webmcr.ru/uploads/extensions/images/2022-05-16/original/f4ad85393ddcadabbc1b3536fc37ce37.webp" }, "likes": 1, "views": 2, "comments": 2, "price": 0, "oldprice": 0, "created": 1635709810, "updated": 1635787517 }, { "id": 2, "name": "test-super-extension", "title": "Test Super Extension", "text_short": "My super extension", "images": { "large": "https://webmcr.ru/uploads/extensions/images/2022-05-16/large/4d82800e7306fc617436aa6f55a88320.webp", "medium": "https://webmcr.ru/uploads/extensions/images/2022-05-16/medium/4d82800e7306fc617436aa6f55a88320.webp", "small": "https://webmcr.ru/uploads/extensions/images/2022-05-16/small/4d82800e7306fc617436aa6f55a88320.webp", "original": "https://webmcr.ru/uploads/extensions/images/2022-05-16/original/4d82800e7306fc617436aa6f55a88320.webp" }, "likes": 0, "views": 2, "comments": 0, "price": 0, "oldprice": 0, "created": 1635586455, "updated": 1635591035 } ], "page": 1, "pages": 2 } }

Входящие запросы отправляются на ваше устройство с нашего сервера. Запросы отправляются с помощью метода POST.

Для безопасности, следует производить проверку входящего запроса с помощью подписи.

Приём подписанных запросов

Запросы такого вида проверяются с помощью сортировки всех входящих параметров по их ключу и заменой ключа sign на свой, который можно получить в настройках профиля. После замены ключа, все параметры объединяются с разделителем ":" и хэшированием с помощью алгоритма SHA256.

Пример подписи запроса на языке PHP:

PHP
<?php if($_SERVER['REQUEST_METHOD'] != 'POST'){ exit('Invalid method'); } $params = $_POST; $secret = 'My secret key'; $hash = $params['sign']; $params['sign'] = $secret; ksort($params); $sign = hash('sha256', implode(':', $params)); if($sign !== $hash){ exit('Error sign'); }

POST /extensions/list/

Получение списка опубликованных дополнений

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

-

Параметры сортировки

sort[by]
- Сортировка по указанному полю. По умолчанию id
Допустимые значения:
  • id
    По ID дополнения
  • name
    По имени из адресной строки (пример: /extensions/example-name.1)
  • title
    По названию дополнения
  • price
    По цене
  • oldprice
    По старой цене
  • likes
    По кол-ву симпатий
  • views
    По кол-ву просмотров
  • comments
    По кол-ву комментариев
  • created
    По дате создания (в unixtime формате)
  • updated
    По дате последнего изменения (в unixtime формате)
sort[type]
- Порядок сортировки. По умолчанию asc
Допустимые значения:
  • asc
    Прямой порядок
  • desc
    Обратный порядок

Фильтры

filters[page]
- Порядковый номер страницы. По умолчанию 1
Допустимые значения: целые положительные числа
filters[limit]
- Кол-во выводимых на страницу результатов. По умолчанию 10.
Допустимые значения: целые положительные числа от 1 до 50
filters[min_price]
- Минимальная цена дополнения
Допустимые значения: не отрицательные числа с плавающей точкой
filters[max_price]
- Максимальная цена дополнения
Допустимые значения: не отрицательные числа с плавающей точкой
filters[search]
- Поиск по названиям дополнений
Допустимые значения: полнотекстовой строковый поиск длиной не менее 3х символов
filters[tags]
- массив имён тегов
Допустимые значения: массив тегов. Пример: ['tag1', 'tag2', 'tag3' ...]

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • name
    Имя из адресной строки (пример: /extensions/example-name.1)
  • title
    Название дополнения
  • text_short
    Краткая информация о дополнении в HTML формате
  • images
    Массив адресов разных форматов изображения дополнения
  • likes
    Кол-во симпатий
  • views
    Кол-во просмотров
  • comments
    Кол-во комментариев
  • price
    Цена дополнения
  • oldprice
    Старая цена дополнения
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /extensions/get/

Получение опубликованного дополнения по его идентификатору

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

id

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • name
    Имя из адресной строки (пример: /extensions/example-name.1)
  • title
    Название дополнения
  • text_short
    Краткая информация о дополнении в HTML формате
  • text
    Полное описание дополнения в HTML формате
  • images
    Массив адресов разных форматов изображения дополнения
  • screenshots
    Массив скриншотов дополнения
  • likes
    Кол-во симпатий
  • views
    Кол-во просмотров
  • comments
    Кол-во комментариев
  • price
    Цена дополнения
  • oldprice
    Старая цена дополнения
  • site
    Адрес сайта дополнения
  • tags
    Массив имён тегов дополнения
  • instructions
    Инструкции по дополненияю в HTML формате
  • rules
    Условия использования в HTML формате
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /extensions/list/:sign

Получение списка собственных дополнений

Внимание! Данный запрос вызывается с подписью

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

-

Параметры сортировки

sort[by]
- Сортировка по указанному полю. По умолчанию id
Допустимые значения:
  • id
    По ID дополнения
  • name
    По имени из адресной строки (пример: /extensions/example-name.1)
  • title
    По названию дополнения
  • status
    По статусу дополнения
  • price
    По цене
  • oldprice
    По старой цене
  • likes
    По кол-ву симпатий
  • views
    По кол-ву просмотров
  • comments
    По кол-ву комментариев
  • downloads
    По кол-ву скачиваний
  • sales
    По кол-ву продаж
  • max_downloads
    По максимальному кол-ву скачиваний
  • max_purchases
    По максимальному кол-ву продаж
  • created
    По дате создания (в unixtime формате)
  • updated
    По дате последнего изменения (в unixtime формате)
sort[type]
- Порядок сортировки. По умолчанию asc
Допустимые значения:
  • asc
    Прямой порядок
  • desc
    Обратный порядок

Фильтры

filters[page]
- Порядковый номер страницы. По умолчанию 1
Допустимые значения: целые положительные числа
filters[limit]
- Кол-во выводимых на страницу результатов. По умолчанию 10.
Допустимые значения: целые положительные числа от 1 до 50
filters[status]
- Статус дополнения. По умолчанию выводятся все сразу.
Допустимые значения: целые положительные числа от 0 до 5
filters[min_price]
- Минимальная цена дополнения
Допустимые значения: не отрицательные числа с плавающей точкой
filters[max_price]
- Максимальная цена дополнения
Допустимые значения: не отрицательные числа с плавающей точкой
filters[search]
- Поиск по названиям дополнений
Допустимые значения: полнотекстовой строковый поиск длиной не менее 3х символов
filters[tags]
- массив имён тегов
Допустимые значения: массив тегов. Пример: ['tag1', 'tag2', 'tag3' ...]

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • name
    Имя из адресной строки (пример: /extensions/example-name.1)
  • title
    Название дополнения
  • status
    Статус дополнения
  • text_short
    Краткая информация о дополнении в HTML формате
  • images
    Массив адресов разных форматов изображения дополнения
  • likes
    Кол-во симпатий
  • views
    Кол-во просмотров
  • comments
    Кол-во комментариев
  • downloads
    Кол-во скачиваний
  • sales
    Кол-во продаж
  • price
    Цена дополнения
  • oldprice
    Старая цена дополнения
  • max_downloads
    Максимальное кол-во скачиваний
  • max_purchases
    Максимальное кол-во продаж
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /extensions/get/:sign

Получение собственного дополнения по его идентификатору

Внимание! Данный запрос вызывается с подписью

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

id

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • name
    Имя из адресной строки (пример: /extensions/example-name.1)
  • title
    Название дополнения
  • status
    Статус дополнения
  • text_short
    Краткая информация о дополнении в HTML формате
  • text
    Полное описание дополнения в HTML формате
  • images
    Массив адресов разных форматов изображения дополнения
  • screenshots
    Массив скриншотов дополнения
  • likes
    Кол-во симпатий
  • views
    Кол-во просмотров
  • comments
    Кол-во комментариев
  • downloads
    Кол-во скачиваний
  • sales
    Кол-во продаж
  • price
    Цена дополнения
  • oldprice
    Старая цена дополнения
  • site
    Адрес сайта дополнения
  • tags
    Массив имён тегов дополнения
  • instructions
    Инструкции по дополненияю в HTML формате
  • rules
    Условия использования в HTML формате
  • max_downloads
    Максимальное кол-во скачиваний
  • max_purchases
    Максимальное кол-во продаж
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /extensions/versions/list/

Получение списка опубликованных версий дополнений

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

-

Параметры сортировки

sort[by]
- Сортировка по указанному полю. По умолчанию id
Допустимые значения:
  • id
    По ID версии
  • extension_id
    По ID дополнения
  • title
    По названию версии
  • created
    По дате создания (в unixtime формате)
  • updated
    По дате последнего изменения (в unixtime формате)
sort[type]
- Порядок сортировки. По умолчанию asc
Допустимые значения:
  • asc
    Прямой порядок
  • desc
    Обратный порядок

Фильтры

filters[page]
- Порядковый номер страницы. По умолчанию 1
Допустимые значения: целые положительные числа
filters[limit]
- Кол-во выводимых на страницу результатов. По умолчанию 10.
Допустимые значения: целые положительные числа от 1 до 100
filters[extensions]
- Массив идентификаторов дополнений
Допустимые значения: массив целых положительных чисел
filters[search]
- Поиск по названиям дополнений
Допустимые значения: полнотекстовой строковый поиск длиной не менее 3х символов

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • extension_id
    Идентификатор дополнения
  • title
    Название версии
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /extensions/versions/list/:sign

Получение списка собственных версий дополнений

Внимание! Данный запрос вызывается с подписью

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

-

Параметры сортировки

sort[by]
- Сортировка по указанному полю. По умолчанию id
Допустимые значения:
  • id
    По ID версии
  • extension_id
    По ID дополнения
  • title
    По названию версии
  • downloads
    По кол-ву скачиваний
  • created
    По дате создания (в unixtime формате)
  • updated
    По дате последнего изменения (в unixtime формате)
sort[type]
- Порядок сортировки. По умолчанию asc
Допустимые значения:
  • asc
    Прямой порядок
  • desc
    Обратный порядок

Фильтры

filters[page]
- Порядковый номер страницы. По умолчанию 1
Допустимые значения: целые положительные числа
filters[limit]
- Кол-во выводимых на страницу результатов. По умолчанию 10.
Допустимые значения: целые положительные числа от 1 до 100
filters[extensions]
- Массив идентификаторов дополнений
Допустимые значения: массив целых положительных чисел
filters[search]
- Поиск по названиям дополнений
Допустимые значения: полнотекстовой строковый поиск длиной не менее 3х символов

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • extension_id
    Идентификатор дополнения
  • downloads
    Кол-во скачиваний
  • title
    Название версии
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /extensions/tags/list/

Получение списка тегов дополнений

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

-

Параметры сортировки

sort[by]
- Сортировка по указанному полю. По умолчанию id
Допустимые значения:
  • id
    По ID тега
  • name
    По имени из адресной строки (пример: /tags/example-name.1)
  • title
    По названию тега
  • created
    По дате создания (в unixtime формате)
  • updated
    По дате последнего изменения (в unixtime формате)
sort[type]
- Порядок сортировки. По умолчанию asc
Допустимые значения:
  • asc
    Прямой порядок
  • desc
    Обратный порядок

Фильтры

filters[page]
- Порядковый номер страницы. По умолчанию 1
Допустимые значения: целые положительные числа
filters[limit]
- Кол-во выводимых на страницу результатов. По умолчанию 10.
Допустимые значения: целые положительные числа от 1 до 100
filters[search]
- Поиск по тегам
Допустимые значения: полнотекстовой строковый поиск длиной не менее 3х символов

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • name
    Имя из адресной строки (пример: /tags/example-name.1)
  • title
    Название тега
  • text
    Описание тега
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /extensions/sales/list/:sign

Получение списка собственных продаж дополнений

Внимание! Данный запрос вызывается с подписью

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

-

Параметры сортировки

sort[by]
- Сортировка по указанному полю. По умолчанию id
Допустимые значения:
  • id
    По ID версии
  • extension_id
    По ID дополнения
  • promo_id
    Используемый идентификатор промо-кода. По умолчанию 0
  • sum
    По стоимости покупки с учётом промо-кода
  • user_id
    По идентификатору покупателя
  • created
    По дате создания (в unixtime формате)
  • updated
    По дате последнего изменения (в unixtime формате)
sort[type]
- Порядок сортировки. По умолчанию asc
Допустимые значения:
  • asc
    Прямой порядок
  • desc
    Обратный порядок

Фильтры

filters[page]
- Порядковый номер страницы. По умолчанию 1
Допустимые значения: целые положительные числа
filters[limit]
- Кол-во выводимых на страницу результатов. По умолчанию 10.
Допустимые значения: целые положительные числа от 1 до 100
filters[min_sum]
- Минимальная сумма покупки
Допустимые значения: не отрицательные числа с плавающей точкой
filters[max_sum]
- Максимальная сумма покупки
Допустимые значения: не отрицательные числа с плавающей точкой
filters[promo_id]
- Идентификатор промо-кода. Если указать 0, то будут найдены все записи, где не использовался промо-код
Допустимые значения: не отрицательные целые числа
filters[extensions]
- Массив идентификаторов дополнений
Допустимые значения: массив целых положительных чисел

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • extension_id
    Идентификатор дополнения
  • sum
    Цена, которую заплатил пользователь с учётом промо-кода
  • user_id
    Идентификатор покупателя
  • promo_id
    Идентификатор промо-кода. Если не указан, возвращается 0
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /news/list/

Получение списка опубликованных новостей

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

-

Параметры сортировки

sort[by]
- Сортировка по указанному полю. По умолчанию id
Допустимые значения:
  • id
    По ID новости
  • name
    По имени из адресной строки (пример: /news/example-name.1)
  • title
    По названию новости
  • likes
    По кол-ву симпатий
  • views
    По кол-ву просмотров
  • comments
    По кол-ву комментариев
  • created
    По дате создания (в unixtime формате)
  • updated
    По дате последнего изменения (в unixtime формате)
sort[type]
- Порядок сортировки. По умолчанию asc
Допустимые значения:
  • asc
    Прямой порядок
  • desc
    Обратный порядок

Фильтры

filters[page]
- Порядковый номер страницы. По умолчанию 1
Допустимые значения: целые положительные числа
filters[limit]
- Кол-во выводимых на страницу результатов. По умолчанию 10.
Допустимые значения: целые положительные числа от 1 до 50
filters[search]
- Поиск по названиям новостей
Допустимые значения: полнотекстовой строковый поиск длиной не менее 3х символов
filters[tags]
- массив имён тегов
Допустимые значения: массив тегов. Пример: ['tag1', 'tag2', 'tag3' ...]

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • name
    Имя из адресной строки (пример: /news/example-name.1)
  • title
    Название новости
  • text_short
    Краткая информация о новости в HTML формате
  • images
    Массив адресов разных форматов изображения новости
  • likes
    Кол-во симпатий
  • views
    Кол-во просмотров
  • comments
    Кол-во комментариев
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /news/get/

Получение опубликованной новости по её идентификатору

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

id

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • name
    Имя из адресной строки (пример: /news/example-name.1)
  • title
    Название новости
  • text_short
    Краткая информация о новости в HTML формате
  • text
    Полное описание новости в HTML формате
  • images
    Массив адресов разных форматов изображения новости
  • likes
    Кол-во симпатий
  • views
    Кол-во просмотров
  • comments
    Кол-во комментариев
  • tags
    Массив имён тегов новости
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /news/list/:sign

Получение списка собственных новостей

Внимание! Данный запрос вызывается с подписью

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

-

Параметры сортировки

sort[by]
- Сортировка по указанному полю. По умолчанию id
Допустимые значения:
  • id
    По ID новости
  • name
    По имени из адресной строки (пример: /news/example-name.1)
  • title
    По названию новости
  • status
    По статусу новости
  • likes
    По кол-ву симпатий
  • views
    По кол-ву просмотров
  • comments
    По кол-ву комментариев
  • created
    По дате создания (в unixtime формате)
  • updated
    По дате последнего изменения (в unixtime формате)
sort[type]
- Порядок сортировки. По умолчанию asc
Допустимые значения:
  • asc
    Прямой порядок
  • desc
    Обратный порядок

Фильтры

filters[page]
- Порядковый номер страницы. По умолчанию 1
Допустимые значения: целые положительные числа
filters[limit]
- Кол-во выводимых на страницу результатов. По умолчанию 10.
Допустимые значения: целые положительные числа от 1 до 50
filters[status]
- Статус новости. По умолчанию выводятся все сразу.
Допустимые значения: целые положительные числа от 0 до 5
filters[search]
- Поиск по названиям новостей
Допустимые значения: полнотекстовой строковый поиск длиной не менее 3х символов
filters[tags]
- массив имён тегов
Допустимые значения: массив тегов. Пример: ['tag1', 'tag2', 'tag3' ...]

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • name
    Имя из адресной строки (пример: /news/example-name.1)
  • title
    Название новости
  • status
    Статус новости
  • text_short
    Краткая информация о новости в HTML формате
  • images
    Массив адресов разных форматов изображения новости
  • likes
    Кол-во симпатий
  • views
    Кол-во просмотров
  • comments
    Кол-во комментариев
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /news/get/:sign

Получение собственной новости по её идентификатору

Внимание! Данный запрос вызывается с подписью

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

id

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • name
    Имя из адресной строки (пример: /news/example-name.1)
  • title
    Название новости
  • status
    Статус новости
  • text_short
    Краткая информация о новости в HTML формате
  • text
    Полное описание новости в HTML формате
  • images
    Массив адресов разных форматов изображения новости
  • likes
    Кол-во симпатий
  • views
    Кол-во просмотров
  • comments
    Кол-во комментариев
  • tags
    Массив имён тегов новости
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /news/tags/list/

Получение списка тегов новостей

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

-

Параметры сортировки

sort[by]
- Сортировка по указанному полю. По умолчанию id
Допустимые значения:
  • id
    По ID тега
  • name
    По имени из адресной строки (пример: /tags/example-name.1)
  • title
    По названию тега
  • created
    По дате создания (в unixtime формате)
  • updated
    По дате последнего изменения (в unixtime формате)
sort[type]
- Порядок сортировки. По умолчанию asc
Допустимые значения:
  • asc
    Прямой порядок
  • desc
    Обратный порядок

Фильтры

filters[page]
- Порядковый номер страницы. По умолчанию 1
Допустимые значения: целые положительные числа
filters[limit]
- Кол-во выводимых на страницу результатов. По умолчанию 10.
Допустимые значения: целые положительные числа от 1 до 100
filters[search]
- Поиск по тегам
Допустимые значения: полнотекстовой строковый поиск длиной не менее 3х символов

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • name
    Имя из адресной строки (пример: /tags/example-name.1)
  • title
    Название тега
  • text
    Описание тега
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /notifications/list/:sign

Получение списка собственных оповещений

Внимание! Данный запрос вызывается с подписью

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

-

Параметры сортировки

sort[by]
- Сортировка по указанному полю. По умолчанию id
Допустимые значения:
  • id
    По ID оповещения
  • name
    По имени из адресной строки (пример: /notifications/example-name.1)
  • title
    По названию оповещения
  • status
    По статусу оповещения
  • created
    По дате создания (в unixtime формате)
  • updated
    По дате последнего изменения (в unixtime формате)
sort[type]
- Порядок сортировки. По умолчанию asc
Допустимые значения:
  • asc
    Прямой порядок
  • desc
    Обратный порядок

Фильтры

filters[page]
- Порядковый номер страницы. По умолчанию 1
Допустимые значения: целые положительные числа
filters[limit]
- Кол-во выводимых на страницу результатов. По умолчанию 10.
Допустимые значения: целые положительные числа от 1 до 100
filters[status]
- Статус оповещений. По умолчанию выводятся все сразу.
Допустимые значения: целые положительные числа от 0 до 5
filters[search]
- Поиск по названиям оповещений
Допустимые значения: полнотекстовой строковый поиск длиной не менее 3х символов

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • name
    Имя из адресной строки (пример: /notifications/example-name.1)
  • title
    Название оповещения
  • status
    Статус оповещения
  • url
    URL адрес оповещения
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /notifications/get/:sign

Получение собственного оповещения по его идентификатору

Внимание! Данный запрос вызывается с подписью

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

id

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • name
    Имя из адресной строки (пример: /notifications/example-name.1)
  • title
    Название оповещения
  • status
    Статус оповещения
  • url
    URL адрес оповещения
  • text
    Полное описание оповещения в HTML формате
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /requests/list/:sign

Получение списка собственных заявок на выплаты

Внимание! Данный запрос вызывается с подписью

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

-

Параметры сортировки

sort[by]
- Сортировка по указанному полю. По умолчанию id
Допустимые значения:
  • id
    По ID заявки
  • sum
    По сумме выплаты
  • method
    По названию метода выплаты
  • account
    По номеру счёта
  • status
    По статусу заявки
  • created
    По дате создания (в unixtime формате)
  • updated
    По дате последнего изменения (в unixtime формате)
sort[type]
- Порядок сортировки. По умолчанию asc
Допустимые значения:
  • asc
    Прямой порядок
  • desc
    Обратный порядок

Фильтры

filters[page]
- Порядковый номер страницы. По умолчанию 1
Допустимые значения: целые положительные числа
filters[limit]
- Кол-во выводимых на страницу результатов. По умолчанию 10.
Допустимые значения: целые положительные числа от 1 до 100
filters[status]
- Статус заявки. По умолчанию выводятся все сразу.
Допустимые значения: целые положительные числа от 0 до 5
filters[min_sum]
- Минимальная сумма заявки
Допустимые значения: не отрицательные числа с плавающей точкой
filters[max_sum]
- Максимальная сумма заявки
Допустимые значения: не отрицательные числа с плавающей точкой
filters[method]
- Название платежной системы
Допустимые значения: полное название платежной системы на латинице
filters[account]
- Номер счёта
Допустимые значения: строка

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • method
    Имя метода на латинице
  • account
    Номер счёта
  • sum
    Сумма платежа
  • status
    Статус дополнения
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /requests/get/:sign

Получение собственной заявки на выплату по её идентификатору

Внимание! Данный запрос вызывается с подписью

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

id

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • method
    Имя метода на латинице
  • account
    Номер счёта
  • sum
    Сумма платежа
  • possible_sum
    Сумма платежа с вычетом комиссии
  • status
    Статус дополнения
  • message
    Ответ администрации в случае каких-либо ошибок
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /promo/list/:sign

Получение списка собственных промо-кодов

Внимание! Данный запрос вызывается с подписью

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

-

Параметры сортировки

sort[by]
- Сортировка по указанному полю. По умолчанию id
Допустимые значения:
  • id
    По ID промо-кода
  • single
    По одноразовости использования кода
  • code
    По ключу промо-кода
  • discount
    По размеру скидки в процентах
  • status
    По статусу промо-кода
  • extension_id
    По идентификатору дополнения, к которому применим промо-код
  • expired
    По дате истечения (в unixtime формате)
  • created
    По дате создания (в unixtime формате)
  • updated
    По дате последнего изменения (в unixtime формате)
sort[type]
- Порядок сортировки. По умолчанию asc
Допустимые значения:
  • asc
    Прямой порядок
  • desc
    Обратный порядок

Фильтры

filters[page]
- Порядковый номер страницы. По умолчанию 1
Допустимые значения: целые положительные числа
filters[limit]
- Кол-во выводимых на страницу результатов. По умолчанию 10.
Допустимые значения: целые положительные числа от 1 до 100
filters[status]
- Статус промо-кода. По умолчанию выводятся все сразу.
Допустимые значения: целые положительные числа от 0 до 1
filters[discount]
- Размер скидки в процентах
Допустимые значения: не отрицательные числа с плавающей точкой
filters[extension_id]
- Идентификатор дополнения
Допустимые значения: не отрицательное целое число
filters[single]
- Одноразовый промо-код
Допустимые значения: 0 или 1
filters[code]
- Ключ промо-кода
Допустимые значения: строка

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • code
    Ключ промо-кода
  • discount
    Размер скидки в процентах
  • extension_id
    Идентификатор дополнения
  • status
    Статус промо-кода
  • single
    Является ли промо-код одноразовым
  • expired
    Дата истечения (в unixtime формате)
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /promo/get/:sign

Получение собственного промо-кода по его идентификатору

Внимание! Данный запрос вызывается с подписью

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

id

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • code
    Ключ промо-кода
  • discount
    Размер скидки в процентах
  • extension_id
    Идентификатор дополнения
  • users
    Список пользователей, для которых доступен промо-код
  • status
    Статус промо-кода
  • single
    Является ли промо-код одноразовым
  • expired
    Дата истечения (в unixtime формате)
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /cms/list/

Получение списка доступных систем управления (CMS)

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

-

Параметры сортировки

sort[by]
- Сортировка по указанному полю. По умолчанию id
Допустимые значения:
  • id
    По ID системы
  • title
    По названию системы
  • deprecated
    По состоянию устаревшести системы
  • created
    По дате создания (в unixtime формате)
  • updated
    По дате последнего изменения (в unixtime формате)
sort[type]
- Порядок сортировки. По умолчанию asc
Допустимые значения:
  • asc
    Прямой порядок
  • desc
    Обратный порядок

Фильтры

filters[page]
- Порядковый номер страницы. По умолчанию 1
Допустимые значения: целые положительные числа
filters[limit]
- Кол-во выводимых на страницу результатов. По умолчанию 10.
Допустимые значения: целые положительные числа от 1 до 100
filters[deprecated]
- Статус устаревшей системы
Допустимые значения: 0 или 1
filters[search]
- Поиск по названиям CMS
Допустимые значения: полнотекстовой строковый поиск длиной не менее 3х символов

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • title
    Название CMS
  • deprecated
    Статус устаревшей системы
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /cms/get/

Получение опубликованной системы (CMS) по её идентификатору

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

id

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • title
    Название CMS
  • deprecated
    Статус устаревшей системы
  • text
    Полное описание CMS в HTML формате
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /cms/versions/list/

Получение списка доступных версий CMS

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

-

Параметры сортировки

sort[by]
- Сортировка по указанному полю. По умолчанию id
Допустимые значения:
  • id
    По ID версии
  • cms_id
    По ID CMS
  • title
    По названию версии
  • deprecated
    По статусу устаревшести
  • created
    По дате создания (в unixtime формате)
  • updated
    По дате последнего изменения (в unixtime формате)
sort[type]
- Порядок сортировки. По умолчанию asc
Допустимые значения:
  • asc
    Прямой порядок
  • desc
    Обратный порядок

Фильтры

filters[page]
- Порядковый номер страницы. По умолчанию 1
Допустимые значения: целые положительные числа
filters[limit]
- Кол-во выводимых на страницу результатов. По умолчанию 10.
Допустимые значения: целые положительные числа от 1 до 100
filters[cms]
- Массив идентификаторов CMS
Допустимые значения: массив целых положительных чисел
filters[deprecated]
- Статус устаревшей версии
Допустимые значения: 0 или 1
filters[search]
- Поиск по названиям версий
Допустимые значения: полнотекстовой строковый поиск длиной не менее 3х символов

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • cms_id
    Идентификатор CMS
  • deprecated
    Статус устаревшей версии
  • title
    Название версии
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST /cms/versions/get/

Получение доступной версии CMS по её идентификатору

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

id

Возвращаемые поля

fields
- массив полей. По умолчанию возвращаются только идентификаторы записей (id)
Допустимые значения:
  • cms_id
    Идентификатор CMS
  • url
    URL адрес для скачивания версии
  • deprecated
    Статус устаревшей версии
  • title
    Название версии
  • created
    Дата создания (в unixtime формате)
  • updated
    Дата последнего изменения (в unixtime формате)

POST EVENT sale-extension

Получение события продажи дополнения

Внимание! Данный запрос приходит с внешнего сервера - это значит, что любой пользователь сможет отправить аналогичный запрос.
Чтобы проверить, что запрос пришел действительно с нашего сервера, следует проверять его подпись, как это описано в разделе входящие запросы

Пример входящего запроса:

JSON
{ "event": "sale-extension", "id": 1, "user": 1, "sum": 128.39, "promo": "12345-12345-12345", "sign": "6154b3d4348d00ccc99de392ea5fa8e48e66df8052be9c16f8835194f0da9132" }

Описание параметров

event
- Название входящего события
id
- Идентификатор проданного дополнения
user
- Идентификатор пользователя-покупателя
sum
- Стоимость, за которую пользователь купил дополнение (с учетом промо-кода)
promo
- Ключ используемого промо-кода
sign
- Подпись запроса

POST EVENT change-status-extension

Получение события изменения статуса вашего дополнения

Внимание! Данный запрос приходит с внешнего сервера - это значит, что любой пользователь сможет отправить аналогичный запрос.
Чтобы проверить, что запрос пришел действительно с нашего сервера, следует проверять его подпись, как это описано в разделе входящие запросы

Пример входящего запроса:

JSON
{ "event": "change-status-extension", "id": 1, "status": 1, "message": "", "sign": "550391645f5755d6e42e78933d47f74cdb3faeebb6b582ddbfdbf3f7a0a84ca4" }

Описание параметров

event
- Название входящего события
id
- Идентификатор дополнения
status
- Новый статус дополнения
Допустимые значения:
  • 0
    На модерации
  • 1
    Активно
  • 2
    Отклонено
message
- Сопровождающее сообщение модератора
sign
- Подпись запроса

POST EVENT change-status-new

Получение события изменения статуса вашей новости

Внимание! Данный запрос приходит с внешнего сервера - это значит, что любой пользователь сможет отправить аналогичный запрос.
Чтобы проверить, что запрос пришел действительно с нашего сервера, следует проверять его подпись, как это описано в разделе входящие запросы

Пример входящего запроса:

JSON
{ "event": "change-status-new", "id": 1, "status": 1, "message": "", "sign": "898002bec70c016ef967d2aaf1844c9bc10adea29d97b1f37e102d7a254059f0" }

Описание параметров

event
- Название входящего события
id
- Идентификатор новости
status
- Новый статус новости
Допустимые значения:
  • 0
    На модерации
  • 1
    Активно
  • 2
    Отклонено
message
- Сопровождающее сообщение модератора
sign
- Подпись запроса