REST API

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

О плагине в общем

Плагин является промежуточным звеном между разработчиком и сайтом на базе Флайнекс. Запросы на приемный контроллер плагина осуществляются по средствам HTTP протокола с помощью методов GET, POST и DELETE. Запрос инициализирует некие действия на стороне сервера со сохранением или получением данных из базы данных, после чего данные формируется в массив и ответом отправляются разработчику в JSON формате. Таким образом разработчик взаимодействует с проектом, получая и добавляя в него нужную информацию.

Админ панель

Плагин не имеет менеджера в админ панели, но он создает секцию конфигураций, в который админ может указать необходимые ключи для работы тех или иных методов API, к примеру для работы с PUSH-уведомлениями, необходимо указать данные FireBase аккаунта. Секция конфигураций REST API плагина будет расширятся со временем.

Документация

Мы работаем над документацией в данный момент, ссылка на неё будет опубликована по мере готовности.