Справочник для подключения ваших сайтов и приложений к КАСКАД 360. Платформа поставляется в готовом виде — исходный код для интеграции не нужен. Начните с установки, затем откройте нужный раздел API.
Здесь собраны публичные API — методы, которые вы вызываете из своего сайта, личного кабинета или сервиса интеграции.
Входит: вход и регистрация пользователей, отправка почты, работа с данными и файлами, методы расширений, интерактивный справочник OpenAPI.
Не входит: служебные API первичной установки и внутренние операции админ-панели. Методы сторонних расширений смотрите в их описании или в GET /api/openapi.json после установки расширения.
| Раздел | О чём |
|---|---|
| Общие соглашения | Форматы ответов, ключи и токены, порты, ограничения запросов |
| Авторизация пользователей | Регистрация, вход, профиль, смена пароля, двухфакторная аутентификация |
| Отправка почты | Отправка писем через API-ключ платформы |
| Работа с данными | Чтение и изменение данных через API-ключ |
| Файлы | Загрузка и скачивание файлов |
| API расширений | Как подключённые модули открывают свои методы |
| OpenAPI и метрики | Swagger UI, файл спецификации, метрики Prometheus |
| Сводный список | Таблица всех публичных методов ядра |
| Установка | Первый запуск и настройка через админ-панель |
| Журнал версий | Изменения по релизам |
GET /api/openapi.jsonGET /api/docs/public — можно открыть в браузере и посмотреть все методыСовет: если вы только начинаете, прочитайте общие соглашения, затем раздел, который нужен вашему приложению (чаще всего — авторизация).