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 Client.

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

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

Пов’язане

• API Keys

• SEO Client

• Collections

• SDK resources