Module API

Описание

Предоставляет единую точку входа для всех вызовов API.

Авторизует клиентов по токену (если таков передается).

Предоставляет возможность получить токен по логину и паролю.

Настройки

Глобальных настроек нет

Использование

Поместите реализацию REST контроллера в директорию

modules/api/controllers

Теперь ваш ресурс доступен по адресу

/api/{$resource}/{$id}

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

/api/{$resource}/{$id}/{$relation}/{$relationId}

Для доступа к ресурсам актуальными являются правила ACL

Модуль API предоставляет контроллер login.php, который аутентифицирует пользователя по логину и паролю и возвращает в ответе token, который нужно передавать во всех последующих запросах к АПИ

Авторизация пользователя осуществляется по token

Типичный пример использования

• создаем REST controller, например для модуля pages

modules/api/controllers/pages.php

• посылаем POST запрос на /api/login с параметрами login и password
• получаем в ответе token
• посылаем GET запрос на /api/pages/?token={$token}
• получаем в ответе список страниц