Разработка кастомных Contentful Apps (расширений)

Разработка кастомных Contentful Apps (расширений)

Стандартный редактор Contentful удобен, но для бизнес-процессов с уникальной логикой часто не хватает встроенных полей. Приходится выгружать данные, обрабатывать внешними инструментами, тратить время на ручной ввод. Мы разрабатываем кастомные Contentful Apps — расширения, которые встраиваются прямо в интерфейс редактора. Это не просто виджеты: через SDK приложение получает доступ к Entry API, Space API и Server-side App Actions. С нашими решениями клиенты сокращают время публикации контента на 30–50% и исключают ошибки ручного переноса.

За 5 лет работы с headless CMS мы создали более 20 кастомных App для клиентов из e-commerce, медиа и финансов. Гарантируем совместимость с актуальными версиями Contentful и бесшовную интеграцию в существующий воркфлоу. Кастомные Apps в 4 раза быстрее ручной обработки контента — это подтверждают данные наших проектов.

Архитектура Contentful App

Каждое приложение состоит из двух частей: frontend (React/Vue/Vanilla JS, размещается на любом хостинге) и опциональный App Backend (AWS Lambda или любой HTTP-эндпоинт для App Actions и Events). Оба регистрируются в App Definition через Contentful Management API или Web App.

App Definition
├── Locations: field, sidebar, entry-editor, page, home
├── Parameters: instance params (per-field) + installation params (per-space)
└── App Actions: serverless functions callable from UI or API

Типичные сценарии:

• Кастомный field editor — например, цветовой пикер, связанный с дизайн-токенами из Figma
• Sidebar extension — панель SEO-анализа, которая читает поля Entry в реальном времени
• Page location — полноэкранный Asset Manager с интеграцией Cloudinary
• App Actions — генерация AI-описаний через OpenAI при сохранении Entry

Как разработать кастомное поле Contentful?

Для field extension используется SDK @contentful/app-sdk. Например, цветовой пикер с привязкой к дизайн-токенам:

import { init, FieldExtensionSDK } from '@contentful/app-sdk';

init((sdk: FieldExtensionSDK) => {
  const value = sdk.field.getValue();
  sdk.field.onValueChanged((newValue) => setFieldValue(newValue));
  sdk.field.setValue({ color: '#ff5500', token: 'brand-primary' });
  sdk.window.startAutoResizer();
});

Для React-приложений применяем @contentful/react-apps-toolkit:

import { useSDK, useFieldValue } from '@contentful/react-apps-toolkit';

const ColorPickerField = () => {
  const sdk = useSDK<FieldExtensionSDK>();
  const [value, setValue] = useFieldValue<string>();

  return (
    <ColorPicker
      value={value}
      onChange={(color) => setValue(color.hex)}
      tokens={sdk.parameters.installation.designTokens}
    />
  );
};

Что такое App Actions и зачем они нужны?

App Actions — серверные функции, вызываемые из UI редактора без кастомного бэкенда. Contentful проксирует запрос на ваш endpoint и возвращает результат. Пример — генерация SEO-описаний через OpenAI:

const result = await sdk.cma.appAction.callById({
  spaceId: sdk.ids.space,
  environmentId: sdk.ids.environment,
  appDefinitionId: sdk.ids.app,
  appActionId: 'generate-seo',
  parameters: {
    entryId: sdk.ids.entry,
    locale: sdk.locales.default,
  },
});

На сервере (Node.js/Express):

app.post('/actions/generate-seo', async (req, res) => {
  verifySignature(req.headers['x-contentful-signature'], req.body);
  const { entryId, locale } = req.body.parameters;
  const entry = await cma.entry.get({ entryId });
  const seoData = await openai.chat.completions.create({
    model: 'gpt-4o',
    messages: [{ role: 'user', content: buildSeoPrompt(entry, locale) }],
  });
  res.json({ result: { seoTitle: seoData.choices[0].message.content } });
});

Installation Parameters и конфигурация

Параметры установки задаются один раз при инсталляции приложения в Space. Через них передаются API-ключи, токены, конфиги — без хардкода в коде приложения:

const ConfigScreen = () => {
  const sdk = useSDK<AppExtensionSDK>();
  const [params, setParams] = useState(sdk.parameters.installation);

  sdk.app.onConfigure(() => ({
    parameters: params,
    targetState: {
      EditorInterface: {
        controls: [
          {
            fieldId: 'seoTitle',
            widgetId: sdk.ids.app
          }
        ]
      }
    }
  }));
};

Почему кастомные Contentful Apps выгоднее стандартных решений?

Кастомные Apps интегрируются напрямую в редактор, экономя время на переключение между сервисами. В отличие от сторонних плагинов, они полностью контролируют логику и данные. Например, SEO-анализ в сайдбаре позволяет маркетологу сразу видеть ошибки заполнения — это исключает перезагрузку страниц и правки в последний момент. Наши клиенты фиксируют сокращение цикла публикации в 2–3 раза после внедрения кастомного App.

Сборка и деплой

Contentful предоставляет CLI для локальной разработки и деплоя:

npx create-contentful-app@latest my-app --template typescript
npm run start
contentful-app-scripts activate
npm run build
contentful-app-scripts upload

Настроить CI/CD для Contentful App несложно: мы используем GitHub Actions для автоматического тестирования и деплоя. После пуша в main запускается сборка, прогоняются тесты с моками @contentful/app-sdk, и через contentful-app-scripts upload загружается новая версия в Contentful CDN. Это гарантирует, что ваше расширение всегда обновлено без ручных операций.

Сроки и объём работ

При разработке обязательно покрываем тестами с @contentful/app-sdk mock-объектами и настраиваем CI для автоматического деплоя через contentful-app-scripts upload.

Как мы гарантируем качество?

Каждое расширение проходит код-ревью, тестируется в изолированном окружении и получает документацию для конечных пользователей. Мы даём гарантию на стабильность работы с актуальными версиями Contentful и оперативно адаптируем приложение при обновлении SDK. Contentful App SDK docs подтверждают корректность нашего подхода. Свяжитесь с нами — оценим ваш сценарий за 1 рабочий день. Закажите разработку Contentful App под ключ и получите экономию времени на контент-публикацию до 50%.