Документация API Flute
Это документация по API для Flute CMS.
⚠️
Для работы API необходимо установить отдельный модуль Flute CMS API .
Содержание
- Основные эндпоинты - базовые эндпоинты и информация о статусе API
- Пользователи - управление пользователями
- Роли - управление ролями пользователей
- Разрешения - управление разрешениями
- API-ключи - управление API-ключами
- Страницы - управление страницами
- Серверы - управление серверами
- Валюты - управление валютами
- Платежные шлюзы - управление платежными шлюзами
- Счета на оплату - управление счетами на оплату
- Элементы навигации - управление элементами навигационной панели
- Социальные сети - управление социальными сетями
Аутентификация
Для доступа к API необходимо использовать API-ключ, который передается в заголовке X-API-Key.
X-API-Key: ваш-api-ключКаждый API-ключ имеет определенные разрешения, которые ограничивают доступ к различным эндпоинтам API.
Ошибки
При возникновении ошибок API возвращает соответствующий HTTP-код ответа и JSON-объект с описанием ошибки.
{
"error": {
"code": "invalid_api_key",
"message": "Недействительный API-ключ"
}
}Версионирование
Текущая версия API: 1.0.0
Для проверки версии API можно использовать эндпоинт /api/status.