API Client

API Client — це офіційний TypeScript SDK для Paragraph CMS. Він надає зовнішнім застосункам зручний спосіб працювати з контентом, що зберігається в CMS, незалежно від того, чи йдеться про фронтенд вебсайту, серверну інтеграцію або внутрішню автоматизацію.

Його розроблено для роботи з API Keys, і він є основним мостом між редакційною роботою всередині Paragraph CMS та застосунками, які доставляють цей контент кінцевим користувачам.

Для чого його використовують команди

API Client найбільш корисний, коли фронтенду або сервісу потрібно:

• отримувати сторінки за slug, колекцією або локаллю,

• переглядати списки контенту для розділу, наприклад блогу або документації,

• читати колекції, мітки, статуси, моделі даних, локалі або медіа,

• або програмно створювати й оновлювати контент.

Це робить його природним вибором для проєктів, побудованих на Next.js, Astro, React Router, Nuxt і SvelteKit.

Підключіть його за допомогою API-ключа

Звичайне налаштування просте: створіть ключ у Paragraph CMS, додайте його до свого застосунку та дозвольте клієнту обробляти запити до публічного API.

Це розділяє редакційну поверхню та поверхню доставки. Команди можуть керувати контентом у Pages, Collections і Data Models, а потім використовувати клієнт у коді свого застосунку, щоб читати або оновлювати цей контент там, де це потрібно.

Діалог створення API-ключа Paragraph CMS, що показує одноразове значення ключа та кнопку копіювання.

Близько до редакційного робочого процесу

Paragraph CMS також показує приклади коду всередині продукту, що полегшує перехід від налаштування контенту до реалізації. Колекції, сторінки, мітки та статуси можуть безпосередньо використовуватися у фронтенді або автоматизації, що працюють завдяки клієнту.

Це особливо корисно, коли одна й та сама команда відповідає і за структуру CMS, і за сайт або застосунок, який її споживає.

Діалог прикладів коду Paragraph CMS для використання вмісту через API-клієнт.

Добре працює з іншими інструментами доставки

API Client також є базовим рівнем для SEO Client, який створює SEO-файли рівня сайту, як-от sitemap і feeds, з того самого джерела контенту.

Підтримка категорій та AI-метаданих

Публічний API v1 також включає операції з категоріями для колекцій і AI-помічники, які генерують метадані сторінки, hero та зображення. Це дає інтеграціям можливість зберігати ті самі робочі процеси структурованого контенту й метаданих доступними поза межами застосунку.

Пов’язане

• API Keys

• SEO Client

• Collections

• SDK resources