REST API

* REST API не является официально заявленным функционалом, предназначается для веб-разработчиков, не входит в техподдержку и предоставляется в формате "как есть"

1) Доступны запросы GET, POST, PUT

• Функционал по POST и PUT запросам смотрите в соответствующих файлах RestBlog.php и RestProducts.php

2) тестирование

Для тестирования запросов используйте файл: 

fivecms/rest/test.php

Логин/пароль для входа в админку обязательно должны быть указаны в коде файла /fivecms/rest/test.php в строках:

$request->setUsername('test');
$request->setPassword('test');

Пример тестирования GET-запроса:

URL:

http://site.ru/fivecms/rest/products/?fields=name&join=variants

и далее нажимаете "Отправить"

в поле "Response" получаете JSON-ответ от сервера.

3) Основные параметры

Работа с товарами:

• Список товаров

/products/

• Список товаров по id

/products/1,2,3/

• Выбор полей

/products/?fields=id,name,body,position,created

и т.д. (полный список полей можно получить по запросу /products/)

• Присоединение связанных данных (изображения, варианты, категории, свойства)

/products/?join=images,variants,categories,features

• Сортировка

/products/?sort=name

• Страница и кол-во элементов на странице

/products/?page=5&limit=10

• Выборка по id категории:

/products/?category=5

• Выборка по id бренда:

/products/?brand=5

Работа с записями блога:

• Все записи блога

/blog/

• Список постов по id

/blog/1,2,3/

• Выбор полей

/blog/?fields=id,category,name,url,annotation,text

и т.д. (полный список полей можно получить по запросу /blog/)

• Присоединение связанных изображений

/blog/?join=images

• Выборка по id категории:

/blog/?category=5

• Сортировка

/blog/?sort=name

• Страница и кол-во элементов на странице

/blog/?page=5&limit=10

Работа с заказами:

• Все заказы

/orders/

• Список заказов по id

/orders/1,2,3/

• Выбор полей

/orders/?fields=id,paid,date

и т.д. (полный список полей можно получить по запросу /orders/)

• Присоединение товаров из заказа

/orders/?join=purchases

• Страница и кол-во элементов на странице

/orders/?page=5&limit=10

• Выборка по id статуса заказа

/orders/?status=1

4) Внесение изменений и Дополнительный функционал

Дополнительный функционал реализуется по аналогии с уже имеющимся.

У вас всего 3 файла-образца для изменений:

• fivecms/rest/RestBlog.php - блог
• fivecms/rest/RestProducts.php - товары
• fivecms/rest/RestOrders.php - заказы

UPD: обновлено 10.05.2023