Разделы документации
ОбзорБыстрый стартРедакции и возможностиМодели и поляРедактор контентаМедиатекаЛокализацияПубликация и работа командыAPI, SDK и генерация типовРасширения и инструментыРабочие проектыЗадания, вебхуки и наблюдаемостьАудит и управление даннымиСоветники и доверие к плагинамКорпоративный входПространства, квоты и масштабированиеCommerce и PortalПрава и безопасностьРазвёртывание и обновленияЛицензии и установка пакетовТекущие ограниченияПомощь и диагностикаДанные в кабинетеCore CMSDeveloper PlatformProduction UseWorkflowOperationsComplianceAI AssistantsPlugin TrustEnterprise IdentityEnterprise ScaleEnterprise DeploymentCommerce BundlePortal BundleNotty CMS DocumentationAuth & SecurityContent ModelingDeploymentEcosystem & Packaging ConventionsEditions and First-party ModulesExtensibilityGetting StartedMedia ManagementModule Extraction PathDraft & PublishUpgrade GuideWebhooks & IntegrationsCookbook: Blog with Next.jsCookbook: Custom PluginCookbook: Multilingual SiteOperations DocsBackup AutomationDeployment BlueprintsRunbook — Восстановление БД из бэкапаRunbook — Плановый деплойRunbook — Реакция на инцидентRunbook — Откат релизаRunbook — Горизонтальное масштабированиеRunbook — Ротация секретовRunbook — Major upgradeSecrets ManagementNotty CMS — Capability MapNotty Configuration ModelGenerated App ContractComponents and Dynamic ZonesMiddleware SystemPerformance & Scaling ToolkitDisaster Recovery PlaybookDistribution Model
Документация / Разработка

API, SDK и генерация типов

Доставка контента через REST и GraphQL, SDK и OpenAPI.

CommunityОбновлено 2026-09-30

REST

Основные операции используют /api/content/:type и /api/content/:type/:id. Доступны CRUD, фильтры, сортировка, пагинация, агрегирование и массовые операции. Запросы выполняются с правами пользователя или API-токена.

curl 'http://localhost:2102/api/content/article' \
  -H "Authorization: Bearer $NOTTY_API_TOKEN"

GraphQL

GraphQL доставляет данные по моделям. Права на сущности и поля действуют и здесь. GraphQL subscriptions пока не реализованы; не планируйте их как готовый канал обновлений.

SDK и codegen

Пакеты @notty/sdk и @notty/codegen предоставляют клиентские инструменты и генерацию типов/валидаторов по схемам. SDK содержит интеграции для React, Next и Nuxt. Типы обновляйте вместе с изменением схемы.

OpenAPI и события

OpenAPI описывает HTTP-контракты. Для потоковых уведомлений реализован SSE; WebSocket API относится к будущей функциональности.

Безопасность

Не помещайте административный токен в клиентский JavaScript. Для чтения используйте роль с минимальными правами и серверные секреты там, где данные не публичны. Ограничивайте populate и размер ответа.

Пример с Next.js, экосистема и SDK.