Public API

HTTP API для интеграции ваших приложений с платформой КАСКАД 360. Все вызовы — по HTTPS к развёрнутому экземпляру; базовый путь методов ядра — /api/v1/….

Swagger: на работающей платформе откройте Swagger UI (/api/docs/public) или скачайте openapi.json.

Назначение и границы

Public API покрывает сценарии конечных пользователей (регистрация, вход, профиль) и доверенных сервисов (отправка почты, запросы к данным, файлы). Сюда не входят API первичной установки и внутренние методы админ-панели.

Схема вызова

Клиент (браузер или сервер) → HTTPS → API платформы → сервис (auth, mail, db, files, meta). Для пользовательских операций клиент хранит JWT; для серверных — API-ключ в заголовке X-API-Key.

Аутентификация

Три режима описаны в общих соглашениях и в модели платформы. Кратко: публичные auth-методы без токена; профиль и MFA — JWT; mail/db — ключ с scope.

Примеры ответов

Успех:

{ "success": true, "data": { "user_id": "…" } }

Ошибка:

{ "success": false, "error": { "code": "AUTH_INVALID_CREDENTIALS", "message": "…" } }

Сервисы

Auth — пользователи и JWT
Mail — исходящая почта
Database — запросы и транзакции
Files — модуль медиатеки (отдельная установка)
Расширения — /api/module/{имя}/…
Meta — OpenAPI, метрики, runtime-config

Готовые сценарии

Полный список методов — сводный индекс.