Cliente API

SDK oficial de TypeScript para Paragraph CMS. Conecta aplicaciones con claves API para obtener, listar, crear y actualizar contenido en páginas, colecciones y configuraciones regionales.

GrzegorzGrzegorz
Cliente API

El Cliente API es el SDK oficial de TypeScript para Paragraph CMS. Ofrece a las aplicaciones externas una forma clara de trabajar con el contenido almacenado en el CMS, ya sea un frontend de sitio web, una integración del lado del servidor o una automatización interna.

Está diseñado para funcionar con claves API, y es el puente principal entre el trabajo editorial dentro de Paragraph CMS y las aplicaciones que entregan ese contenido a los usuarios finales.

Para qué lo usan los equipos

El Cliente API es más útil cuando un frontend o servicio necesita:

  • obtener páginas por slug, colección o configuración regional,

  • listar contenido para una sección como un blog o un área de documentación,

  • leer colecciones, etiquetas, estados, modelos de datos, configuraciones regionales o medios,

  • o crear y actualizar contenido mediante programación.

Eso lo convierte en una opción natural para proyectos creados con Next.js, Astro, React Router, Nuxt y SvelteKit.

Conéctalo con una clave API

La configuración habitual es sencilla: crea una clave en Paragraph CMS, añádela a tu aplicación y deja que el cliente gestione las solicitudes a la API pública.

Eso mantiene separadas la superficie editorial y la superficie de entrega. Los equipos pueden gestionar contenido en Páginas, Colecciones y Modelos de datos, y luego usar el cliente en el código de su aplicación para leer o actualizar ese contenido donde sea necesario.

Diálogo de clave API creada de Paragraph CMS que muestra un valor de clave de un solo uso y un botón de copia.
Diálogo de clave API creada de Paragraph CMS que muestra un valor de clave de un solo uso y un botón de copia.

Cerca del flujo de trabajo editorial

Paragraph CMS también muestra ejemplos de código dentro del producto, lo que facilita pasar de la configuración del contenido a la implementación. Las colecciones, páginas, etiquetas y estados pueden alimentar directamente el trabajo de frontend o automatización impulsado por el cliente.

Esto es especialmente útil cuando el mismo equipo se encarga tanto de la estructura del CMS como del sitio o la aplicación que lo consume.

Diálogo de ejemplos de código de Paragraph CMS para usar contenido a través del cliente API.
Diálogo de ejemplos de código de Paragraph CMS para usar contenido a través del cliente API.

Funciona bien con otras herramientas de entrega

El Cliente API también es la capa base para el Cliente SEO, que genera archivos SEO a nivel de sitio, como sitemaps y feeds, a partir de la misma fuente de contenido.

Relacionado

Descubre Paragraph CMS en acción

Explora Paragraph CMS en directo y descubre cómo te ayuda a crear, gestionar y publicar contenido más rápido.