Saltearse al contenido
Content Island logo Content Island logo Docs

Introducción al cliente API

El cliente API de Content Island es una biblioteca JavaScript que permite interactuar con la API REST. Proporciona una interfaz sencilla y fácil de usar para recuperar todos los proyectos y contenidos de tu cuenta de Content Island. La biblioteca está diseñada para utilizarse en aplicaciones web y móviles, y es compatible con los navegadores modernos y Node.js.

Instalación

Puede instalar el cliente API de Content Island utilizando su gestor de paquetes preferido:

Ventana de terminal
npm install @content-island/api-client

Requisitos

  • Node.js 18.x o superior.

TypeScript es opcional, pero se recomienda para obtener la mejor experiencia de desarrollo. El cliente de la API de Content Island está escrito en TypeScript y proporciona tipos para todas las funciones y objetos expuestos.

Uso

Una vez instalado, siga estos pasos para configurar y utilizar el cliente de la API de Content Island:

  1. Cree una instancia del cliente API utilizando el token de acceso de su proyecto. Puede encontrar el token de acceso en la pestaña General.

    import { createClient } from '@content-island/api-client';
    

    const client = createClient({ accessToken: 'TU_TOKEN_DE_ACCESO' });

  2. Ahora puede utilizar el cliente para interactuar con la API de Content Island. Por ejemplo, para recuperar todo el contenido de su proyecto:

    const contents = await client.getContentList();

  3. Para recuperar contenido de un modelo específico que haya declarado, como el modelo post:

    const posts = await client.getContentList<Post>({ contentType: 'post' });

Para obtener más información sobre cómo recuperar contenido de su proyecto, consulte los métodos getContentList y getContent.

Métodos de escritura

El cliente también puede crear, modificar y subir contenido, y gestionar el esquema del proyecto. Estos métodos requieren un Write Token como accessToken — un read token no es suficiente y devolverá 403 Forbidden.

Contenido:

  • createContent — crea una nueva entrada de contenido.
  • updateContentFieldValue — actualiza (o hace upsert) de un único valor de campo.
  • publishContent — publica una entrada para que sea visible para los consumidores con read token.
  • uploadMedia — sube un fichero (imagen, vídeo, …) al almacenamiento de tu proyecto.

Esquema (modelos y enums):

  • createModel — crea una Entity (content type) con una lista de campos.
  • updateModel — actualiza el nombre y los campos de una Entity.
  • deleteModel — elimina una Entity y todo su contenido.
  • createEnum — crea un Enum (lista cerrada de valores).
  • updateEnum — actualiza el nombre y los valores de un Enum.
  • deleteEnum — elimina un Enum.

Manejo de errores

Todos los métodos del cliente lanzan un ApiClientError tipado cuando la petición falla — cubre fallos del servidor (UNAUTHORIZED, NOT_FOUND, VALIDATION_ERROR, …) y del cliente (NETWORK_ERROR). Mira Manejo de errores para el patrón recomendado de try / catch y la guía de migración desde v0.20.x.