Client API
SDK TypeScript officiel pour Paragraph CMS. Connectez des applications avec des clés API pour récupérer, lister, créer et mettre à jour du contenu à travers les pages, les collections et les paramètres régionaux.
Grzegorz
Le Client API est le SDK TypeScript officiel de Paragraph CMS. Il offre aux applications externes un moyen clair de travailler avec le contenu stocké dans le CMS, qu’il s’agisse d’une interface de site web, d’une intégration côté serveur ou d’une automatisation interne.
Il est conçu pour fonctionner avec des clés API, et constitue le principal pont entre le travail éditorial dans Paragraph CMS et les applications qui livrent ce contenu aux utilisateurs finaux.
À quoi les équipes l’utilisent
Le Client API est particulièrement utile lorsqu’une interface ou un service doit :
récupérer des pages par slug, collection ou paramètre régional,
lister du contenu pour une section comme un blog ou une zone de documentation,
lire des collections, libellés, statuts, modèles de données, paramètres régionaux ou médias,
ou créer et mettre à jour du contenu par programmation.
Cela en fait un choix naturel pour les projets construits avec Next.js, Astro, React Router, Nuxt et SvelteKit.
Connectez-le avec une clé API
La configuration habituelle est simple : créez une clé dans Paragraph CMS, ajoutez-la à votre application, et laissez le client gérer les requêtes vers l’API publique.
Cela permet de garder séparées la surface éditoriale et la surface de diffusion. Les équipes peuvent gérer le contenu dans Pages, Collections et Data Models, puis utiliser le client dans le code de leur application pour lire ou mettre à jour ce contenu là où il est nécessaire.
Proche du flux de travail éditorial
Paragraph CMS affiche également des exemples de code dans le produit, ce qui facilite le passage de la configuration du contenu à l’implémentation. Les collections, pages, libellés et statuts peuvent tous alimenter directement le travail de frontend ou d’automatisation propulsé par le client.
C’est particulièrement utile lorsque la même équipe gère à la fois la structure du CMS et le site ou l’application qui l’utilise.
Fonctionne bien avec d’autres outils de diffusion
Le Client API est également la couche de base du Client SEO, qui génère des fichiers SEO au niveau du site comme des sitemaps et des flux à partir de la même source de contenu.
Prise en charge des catégories et des métadonnées IA
L’API publique v1 inclut également des opérations sur les catégories pour les collections ainsi que des assistants IA qui génèrent des métadonnées de page, de héros et d’image. Cela permet aux intégrations de conserver les mêmes flux de travail de contenu structuré et de métadonnées en dehors de l’application.
