Документация
Project-X CMS версия 1.1.0
Последние обновления
2025-11-27
- Обновление документации для v1.1.0
- Обновлены все документы до версии 1.1.0
- Добавлены новые разделы в документацию для администраторов:
- API Key Management - управление API ключами через админ-панель
- WordPress Integration - интеграция плагина CF7 с REST API
- Расширена документация для разработчиков:
- Подробное описание REST API (v1.1.0)
- Инструкции по использованию Project-X CF7 Integration плагина
- Примеры кода для интеграции
- Обновлены все даты и версии документов на 1.1.0 (27 ноября 2025)
- Обновлено описание системы в system/overview.md
2025-11-27
- REST API и система управления API ключами (Фаза 14-15)
- Реализирована полнофункциональная система управления API ключами в админ-панеле
- Создан Model\ApiKey с методами для генерации, валидации и управления ключами
- Реализовано SHA-256 криптографическое хеширование для безопасного хранения ключей
- Создана админ-панель с тремя таблицами:
- api_keys - основная таблица ключей со всеми параметрами
- api_key_usage_logs - полное логирование всех запросов
- api_rate_limit_counters - счетчики для контроля rate limiting
- Добавлены 4 индекса для оптимизации производительности запросов
- Реализована поддержка IP whitelist для ограничения источников запросов
- Реализована фильтрация ендпоинтов с поддержкой wildcard-паттернов
- Поддерживаются гибкие rate limits: per-hour и per-day на каждый ключ
- Добавлена поддержка expiration date для автоматического истечения ключей
- Реализован полный audit trail для отозвания ключей
- ApiKeyManagementController с 8 основными методами:
- index() - список всех ключей с фильтрацией и статистикой
- view($id) - детальный просмотр ключа с логами использования за 30 дней
- editForm($id) и edit($id) - редактирование параметров ключа
- deactivate/activate/revoke - управление статусом ключа
- delete($id) - удаление ключа со всеми логами
- statistics() - аналитика использования (топ пользователи, топ ендпоинты, графики)
- Создано 4 view шаблона:
- index.php - список ключей с таблицей DataTables и модальным окном создания
- view.php - детальная информация и логи использования
- edit.php - форма редактирования всех параметров ключа
- statistics.php - система аналитики на уровне всех ключей
- Добавлено меню-пункт "API Key Management" в админ-панель для Admin и Developer ролей
- Реализована система permissions: доступ только для Admin и Developer
- Добавлено 60+ новых ключей локализации на 3 языках (Ukrainian, Russian, English)
- ApiRegistrationController с поддержкой публичных API ендпоинтов
- POST /api/auth/register - создание запроса на регистрацию пользователя через API
- Поддерживает Bearer Token аутентификацию
- Поддерживает X-API-Key header аутентификацию
- Проверка IP whitelist источника запроса
- Проверка прав ключа на доступ к ендпоинту
- Проверка rate limiting перед обработкой
- Валидация всех полей формы регистрации
- Возвращает JSON с статусом и ID запроса
- GET /api/auth/registration-status - получение статуса запроса на регистрацию
- Поддерживает Bearer Token и X-API-Key аутентификацию
- Возвращает текущий статус и метаданные запроса
- GET /api/auth/check-email - проверка доступности email адреса
- Быстрая проверка существования email в системе
- Поддерживает аутентификацию по API ключу
- Полная документация всех ендпоинтов в /docs/v1.1.0/API_DOCUMENTATION.md
- SHA-256 хеширование обеспечивает что сырой ключ никогда не хранится в БД
- Rate limiting предотвращает брутфорс и злоупотребление API
- IP whitelist позволяет ограничить источники запросов
- Endpoint filtering контролирует доступ к конкретным ендпоинтам
- Полное логирование всех запросов для аудита и мониторинга
- Bearer Token и X-API-Key поддержка двух способов аутентификации
- Система отозвания ключей с audit trail кто и когда отозвал ключ
- Поддержка expiration date для автоматического истечения ключей
- Migration_20251127_001_CreateApiKeysTable содержит:
- Создание всех 3 таблиц с правильными типами данных и ограничениями
- PostgreSQL trigger для автоматического обновления updated_at
- Создание 7 индексов для оптимизации производительности
- Корректные FOREIGN KEY со ссылками на users и CASCADE удалением
- PostgreSQL комментарии для документирования схемы
- Методы up() и down() для миграции и откаты
- Успешно выполнена на PostgreSQL базе данных
- Создан файл /docs/v1.1.0/API_DOCUMENTATION.md (572 строки)
- Полное руководство по использованию API для разработчиков
- Секции: аутентификация, API ключи, регистрация, rate limiting, безопасность
- Примеры запросов на PHP, JavaScript, Python, Bash
- Полная документация всех ендпоинтов с request/response форматами
- Коды ошибок и их описания
- Инструкции админ-панели для управления ключами
2024-11-21
- Реализована полнофункциональная система документации проекта
- Создан контроллер DocsController с поддержкой парсинга Markdown
- Реализована система поиска по всей документации
- Добавлен контроль доступа к документам на основе ролей пользователей
- Создана структура документации по разделам и функциональности
- Написаны подробные руководства для всех ролей пользователей
- Добавлена поддержка синтаксис-хайлайтинга для кодовых блоков
- Реализована система версионирования документов через changelog
- Создана техническая документация по архитектуре и безопасности
- Интегрирована документация в главное меню системы
- Добавлена навигация по документам через хлебные крошки
- Реализована боковая панель с быстрой навигацией по разделам
2024-11-20
- Реализирован модуль System Logs Viewer для просмотра системных логов
- Добавлена возможность фильтрации логов по уровню серьезности
- Реализована функция скачивания и удаления log-файлов
- Добавлены языковые строки для системы логирования (34 записи на 3 языках)
- Обновлена документация по RBAC в справочнике проекта
- Добавлены вспомогательные функции форматирования размера файлов
- Реализована цветовая кодировка уровней логирования
2024-11-19
- Добавлена динамическая дата в подвал всех страниц системы
- Созданы страницы Политики конфиденциальности на 3 языках (RU, UK, EN)
- Созданы страницы Условий использования на 3 языках (RU, UK, EN)
- Реализирован контроллер PagesController для управления статическими страницами
- Обновлены шаблоны dashboadr.php и auth.php с динамическим годом в подвале
- Созданы ссылки на политику и условия в подвал страниц
- Создан новый шаблон app.php для публичных страниц
2024-11-18
- Удален доступ роли Partner к функциям создания и редактирования контента
- Создана страница ошибки 403.php для отображения отказа в доступе
- Обновлен ContentController для ограничения всех методов только для администраторов
- Реализована система проверки прав доступа на уровне контроллера
2024-11-17
- Реализована комплексная система контроля доступа на основе ролей (RBAC)
- Добавлены методы canAccessSection() и canPerformAction() в класс Auth
- Создана матрица прав доступа для 11 основных разделов системы
- Обновлено меню панели управления с динамической видимостью пунктов
- Определена иерархия ролей: Admin > Developer > Moderator > Partner > Client
- Документировано управление правами доступа в справочнике .claude
2024-11-16
- Обновлен интерфейс модерации заказов в зависимости от статуса
- Изменена логика отображения кнопок действий для различных статусов заказа
- Скрыты кнопки "Одобрить" и "Уточнить" для заказов в статусе "Выполняется"
- Добавлена кнопка "Завершена" для заказов в обработке