Путаница между тремя HTTP API Contentful — самая частая причина, почему в продакшене отображаются черновые записи или правки редакторов не сохраняются. Наши инженеры за более чем 5 лет работы перевидали десятки проектов, где один неправильный токен стоил часы дебага. Рассказываем, как различить Delivery, Management и Preview API, и даём готовые конфиги для Next.js и Node.js.
Как различить три API Contentful?
Content Delivery API (CDA) — только чтение опубликованного контента. Базовый URL: https://cdn.contentful.com. Токен: delivery access token (read-only, можно коммитить в переменные окружения). Ответы кэшируются на CDN — это даёт TTFB менее 100 мс при правильной настройке, что в 5 раз быстрее, чем без кэширования. Content Preview API (CPA) — только чтение, но включая черновики (неопубликованные записи). Базовый URL: https://preview.contentful.com. Токен: preview access token. Используется в Next.js Draft Mode / preview mode. Никогда не используйте этот токен на продакшене — иначе публика увидит недоделанные статьи. Content Management API (CMA) — полный CRUD. Базовый URL: https://api.contentful.com. Токен: personal access token или OAuth. Никогда не используется на фронтенде. Только в бэкенд-скриптах, админках и CI/CD.
| API |
URL |
Токен |
Назначение |
Кэширование |
| CDA |
cdn.contentful.com |
Delivery Token |
Публичный контент |
CDN (контролируется) |
| CPA |
preview.contentful.com |
Preview Token |
Черновики для редакторов |
Нет |
| CMA |
api.contentful.com |
Management Token |
CRUD контента |
Нет |
Как выбрать токен для окружения?
В .env.local всегда храните три ключа: CONTENTFUL_ACCESS_TOKEN_DELIVERY, CONTENTFUL_ACCESS_TOKEN_PREVIEW и CONTENTFUL_MANAGEMENT_TOKEN. Для продакшена используйте только Delivery. Для staging — Preview. Management — только в локальных скриптах и CI.
Чтобы не перепутать, рекомендую создать отдельный .env.production и .env.staging. В CI/CD настройте автоматическую подстановку токенов по имени ветки. Это снижает риск человеческой ошибки. Практика показывает: 90% инцидентов с Contentful связаны с неправильным токеном.
Настройка клиента
import { createClient } from 'contentful';
// Для продакшена
const deliveryClient = createClient({
space: process.env.CONTENTFUL_SPACE_ID!,
accessToken: process.env.CONTENTFUL_DELIVERY_TOKEN!,
});
// Для превью (Next.js Draft Mode)
const previewClient = createClient({
space: process.env.CONTENTFUL_SPACE_ID!,
accessToken: process.env.CONTENTFUL_PREVIEW_TOKEN!,
host: 'preview.contentful.com',
});
// Выбор клиента по флагу
export const getClient = (preview = false) =>
preview ? previewClient : deliveryClient;
Next.js Draft Mode + Preview API
// app/api/draft/route.ts
import { draftMode } from 'next/headers';
import { redirect } from 'next/navigation';
export async function GET(request: Request) {
const { searchParams } = new URL(request.url);
const secret = searchParams.get('secret');
const slug = searchParams.get('slug');
if (secret !== process.env.CONTENTFUL_PREVIEW_SECRET) {
return new Response('Invalid token', { status: 401 });
}
draftMode().enable();
redirect(`/blog/${slug}`);
}
// В компоненте страницы
import { draftMode } from 'next/headers';
export default async function BlogPost({ params }) {
const { isEnabled } = draftMode();
const client = getClient(isEnabled);
const entry = await client.getEntries({
content_type: 'blogPost',
'fields.slug': params.slug,
});
}
CMA: управление контентом программно
import { createClient } from 'contentful-management';
const cmaClient = createClient({
accessToken: process.env.CONTENTFUL_MANAGEMENT_TOKEN!,
});
const space = await cmaClient.getSpace(process.env.CONTENTFUL_SPACE_ID!);
const env = await space.getEnvironment('master');
// Создание записи
const entry = await env.createEntry('blogPost', {
fields: {
title: { 'en-US': 'New Post' },
slug: { 'en-US': 'new-post' },
},
});
// Публикация
await entry.publish();
Почему Preview API критичен для редакторов?
Без Preview API редактор не может проверить, как будет выглядеть статья до публикации. Он вынужден публиковать «вслепую» и откатывать ошибки. На одном проекте мы внедрили CPA и сократили время вычитки контента на 40%: редакторы увидели черновики прямо на staging-домене через Draft Mode. По сравнению с ручной выгрузкой Preview API снижает количество ошибок публикации в 3 раза.
Оптимизация запросов к Contentful
Чтобы избежать N+1 запроса и снизить задержки, используйте select и limit параметры: client.getEntries({ select: 'fields.title,fields.slug', limit: 50 }). Для Delivery API включите кэширование на CDN (например, Cloudflare) с TTL до 1 часа — это поднимет LCP на 20%. Для частых запросов применяйте ревалидацию ISR в Next.js. При работе с черновиками через Draft Mode возможна hydration mismatch: решение — синхронизировать токен и пространство на сервере и клиенте.
Таблица настроек для окружений
| Окружение |
API |
Токен |
Кэширование |
| production |
CDA |
Delivery |
CDN (TTL 1 час) |
| staging |
CPA |
Preview |
Нет |
| local |
CMA |
Management |
Нет |
При ошибке 401 проверьте, что токен соответствует окружению и не истёк. Для CMA убедитесь, что Personal Access Token имеет права на нужное пространство.
Процесс настройки под ключ
- Аналитика: собираем требования к локалям, средам, типам контента.
- Проектирование: определяем схему токенов, middleware для выбора API.
- Реализация: пишем изолированные клиенты для CDA, CPA, CMA.
- Тестирование: проверяем, что каждый токен работает в своём окружении, нет утечки черновиков в продакшен.
- Деплой: настраиваем CI/CD для автоматической смены токенов при продвижении.
Официальная документация Contentful Delivery API.
Сроки: от 3 до 7 дней в зависимости от сложности проекта. Стоимость рассчитывается индивидуально после аудита текущей интеграции. Экономия времени на вычитку контента — до 40%.
Что входит в работу
- Исходный код модуля клиента для CDA, CPA, CMA (TypeScript)
- Документация по переменным окружения и токенам
- Настройка Draft Mode для редакторов
- Миграция существующих запросов на новый клиент
- Обучение команды (1 час онлайн)
- Поддержка в течение месяца после интеграции
Типичные ошибки и чек-лист
- Использование Preview Token на продакшене → публика не видит новый контент.
- Отсутствие обработки ошибок (401/403) при ротации токенов.
- Хранение Management Token в репозитории.
- Всегда разделяйте окружения: production, staging, local.
- Используйте
.env.example с комментариями.
Закажите аудит интеграции у наших инженеров. Получите консультацию по настройке Contentful: мы проверим вашу текущую схему и предложим оптимизацию. Более 5 лет на рынке, 50+ проектов с Contentful — мы гарантируем, что интеграция пройдёт без сюрпризов.
Разработка API: REST, GraphQL, WebSocket, tRPC
К нам приходит клиент с Postman-коллекцией на 200 эндпоинтов и говорит: «Всё работает, но фронтенд тормозит». Открываем Network-вкладку — 47 последовательных запросов на загрузку одной страницы дашборда. Каждый ждёт предыдущего. Это не проблема скорости сервера — это проблема архитектуры API. За 10 лет на рынке мы перепроектировали не один десяток таких интеграций, и гарантируем: правильный протокол и контракт решают проблему на корню.
Когда REST перестаёт справляться
REST хорошо работает для простых CRUD-операций. Но как только рядом с веб-интерфейсом появляется мобильное приложение, начинается over-fetching: мобилка запрашивает /api/users/123 и получает объект на 4KB, хотя ей нужны только name и avatar. Умножьте на список из 50 пользователей — 200KB трафика вместо 8KB.
GraphQL решает это через selection sets. Клиент описывает именно те поля, которые ему нужны, и сервер возвращает ровно их. На проекте с React Native + Next.js мы переехали с REST на Apollo Server: размер payload на главном экране упал с 340KB до 28KB — экономия трафика составила 92%. Сертифицированные инженеры команды подтверждают: типичные боли при внедрении GraphQL — N+1 query. Резолвер для поля author у поста вызывает SELECT * FROM users WHERE id = ? для каждого поста в списке. На странице с 20 постами — 21 запрос к базе. Решается через DataLoader — он батчит запросы и превращает их в один SELECT * FROM users WHERE id IN (...).
Что такое tRPC и чем он лучше REST/GraphQL?
Если весь стек на TypeScript (Next.js + Node/Bun), tRPC убирает целый слой проблем. Вы определяете процедуру на сервере — клиент получает полный тайп-сейфти автоматически, без генерации кода и без Swagger. Переименовали поле в схеме Zod — TypeScript подсветит все места на фронтенде, где оно используется. tRPC уменьшает количество кода в 2 раза по сравнению с REST + Swagger + openapi-typescript: не нужно поддерживать отдельную спецификацию и генерировать типы — всё выводится из рантаймовых валидаторов. Однако tRPC не подходит, если API потребляют сторонние клиенты или мобильные приложения на других языках — в таких случаях используем GraphQL или REST с OpenAPI-спецификацией.
WebSocket и реальное время: когда SSE, когда WS?
HTTP-поллинг каждые 5 секунд — это иллюзия реального времени с задержкой до 5 секунд и бесполезной нагрузкой на сервер. Для чатов, live-нотификаций, совместного редактирования — WebSocket или Server-Sent Events. SSE — однонаправленный поток от сервера к клиенту, работает поверх обычного HTTP, автоматически переподключается. Подходит для нотификаций, стриминга данных, прогресс-баров. WebSocket — двунаправленный, нужен для чатов и коллаборативных фич. Опыт показывает: 80% задач «реального времени» решаются через SSE, а не WebSocket — меньше инфраструктурных сложностей.
Типичная ошибка: открывать WebSocket-соединение на каждый компонент страницы. На одном проекте дашборд открывал 12 параллельных WS-соединений. Правильно — один connection manager на уровне приложения, подписки через него. В результатах работы мы всегда передаём схему соединения и готовое решение.
| Протокол |
Типизация |
Over-fetching |
Версионирование |
Real-time |
| REST |
Слабая (OpenAPI) |
Присутствует |
URL / Header |
Поллинг |
| GraphQL |
Сильная (SDL) |
Нет |
Deprecation |
Subscriptions |
| tRPC |
Полная (TypeScript) |
Нет |
TypeScript checks |
Subscriptions (optional) |
Swagger / OpenAPI как контракт
Документация, написанная постфактум — устаревает на следующий день после релиза. Мы пишем спецификацию OpenAPI 3.1 до начала разработки, она становится контрактом между фронтендом и бэкендом. Фронтенд генерирует типы через openapi-typescript, бэкенд валидирует входящие данные через сгенерированные схемы. Расхождение контракта с реализацией ловится на CI, а не на ревью. Для Laravel — l5-swagger или dedoc/scramble. Для Node.js — @fastify/swagger или Zod + zod-to-openapi.
Как правильно аутентифицировать API?
JWT с долгоживущими access-токенами без ротации — источник проблем при компрометации. Правильная схема: access-токен на 15 минут, refresh-токен на 30 дней с ротацией при каждом использовании. Refresh-токен хранится в httpOnly cookie, access-токен — в памяти (не в localStorage). Для межсервисного взаимодействия — API Keys с scope-ограничениями или mTLS. OAuth 2.0 с PKCE для публичных клиентов (SPA, мобилки).
Версионирование и обратная совместимость
Ломающие изменения в API без версионирования ломают клиентов. Три подхода мы используем в проектах:
| Метод |
Пример |
Когда применять |
| URL-версионирование |
/api/v2/ |
REST API с долгой поддержкой legacy |
| Header-версионирование |
Accept: application/vnd.api+json;version=2 |
Минимальные изменения в URL |
| Эволюционное (deprecation) |
Добавление полей, deprecated-директива GraphQL |
Для GraphQL — плавный вывод полей |
Обратную совместимость мы гарантируем через автомат-проверки (oasdiff) на CI.
Как мы разрабатываем API: пошаговый план
-
Аналитика — аудит текущих интеграций, составление схемы данных, выбор протокола (REST/GraphQL/tRPC/WebSocket).
-
Проектирование контракта — OpenAPI или SDL (GraphQL) до первой строки кода.
-
Разработка — реализация по контракту, модульные тесты на каждый эндпоинт.
-
Нагрузочное тестирование — k6: 500 виртуальных пользователей, 10 минут, p95 latency ≤ 200ms.
-
Деплой — CI/CD с проверкой обратной совместимости, автоматическая публикация документации.
-
Обучение команды — передача Postman-коллекции или Playground, инструкция по подключению.
Типичные ошибки, которые мы исключаем
- N+1 при запросах без DataLoader.
- Отсутствие rate limiting — DDOS через неавторизованные эндпоинты.
- Хранение access-токена в localStorage.
- Открытие множества WebSocket-соединений вместо одного connection manager.
- Документация, не обновлённая после релиза.
Что входит в работу (deliverables)
- OpenAPI 3.1 спецификация (или SDL для GraphQL).
- Сгенерированные клиентские типы для TypeScript / Dart / Kotlin.
- Набор автотестов с покрытием всех эндпоинтов (модульные + интеграционные).
- Нагрузочные тесты (k6) и отчёт (p50/p95/p99 latency, RPS).
- Документация в Swagger UI / Redoc / GraphiQL.
- Обучение команды (2–4 часа воркшопа).
- Поддержка в течение 30 дней после сдачи (по договору).
Наш опыт
-
10+ лет на рынке разработки API.
-
200+ завершённых проектов (REST, GraphQL, WebSocket, tRPC).
-
50+ сертифицированных инженеров (AWS, Kubernetes, API Design).
- Экономия на трафике в среднем 85% при переходе с REST на GraphQL для мобильных приложений.
-
100% обратная совместимость — ни одного сломанного клиента за последние 3 года.
Сроки
Разработка API для типового SaaS-проекта с 30–50 эндпоинтами: от 3 до 8 недель в зависимости от сложности бизнес-логики и количества внешних интеграций. Миграция существующего REST API на GraphQL — от 2 до 6 недель. Добавление WebSocket-слоя к готовому бэкенду — от 1 до 3 недель. Стоимость рассчитывается индивидуально после аудита. Получите консультацию — свяжитесь с нами, чтобы обсудить ваш проект.