Contenido

Obtiene un solo contenido de un proyecto.

Este endpoint es útil para obtener un contenido específico, como un artículo o una entrada de blog.

Endpoint

shell

curl https://api.contentisland.net/api/1.0/content \
--header 'Authorization: Bearer TU_TOKEN_DE_ACCESO'

Query Params

Este endpoint acepta los siguientes query params:

interface ContentQueryParams {
  id?: Filter;
  contentType?: Filter;
  language?: Filter;
  `fields.${string}`?: Filter; // Permite filtrar por valores específicos de campos
  // Por ejemplo: 'fields.slug': 'my-post'
  includeRelatedContent?: boolean; // Indica si se debe incluir contenido relacionado en la respuesta (solo relaciones de primer nivel)
}

Nota

El id del contenido que quieres recuperar.

Puedes encontrar el id del contenido en la pestaña Contenido de tu proyecto. Ya sea en el propio listado o en el detalle del mismo.

Nota

El filtro contentType es un poco redundante, pero puede ser útil si quieres asegurarte de que el contenido que estás recuperando pertenece a un modelo específico.

En el caso de que el id no coincida con el modelo, no se devolverá ningún contenido.

nombre	descripción
id	El ID del contenido que queremos recuperar. Este parámetro debe ser un string. Por ejemplo: /content?id=1234 Puedes encontrar el id del contenido en la pestaña Contenido.
contentType	El modelo del contenido que queremos recuperar. Por ejemplo: /content?id=1234&contentType=post
language	El idioma del contenido que queremos recuperar. Cuando aplicamos este filtro, solamente devolverá los campos del modelo en el idioma seleccionado y descartará los demás. Por ejemplo: /content?id=1234&language=es
fields.${string}	Permite filtrar por valores específicos de campos. Ejemplos: /content?fields.slug=my-post /content?fields.title[in]=hello%20world,hola%20mundo Recupera contenido con campos que coincidan con los valores especificados.
includeRelatedContent	Un booleano que indica si se debe incluir contenido relacionado en la respuesta. Esto es útil cuando se quiere obtener contenido junto con sus elementos relacionados (solo relaciones de primer nivel). Por ejemplo: /content?id=1234&includeRelatedContent=true

type Filter =
  | string
  | {
      in?: string[];
    };

Nota

A futuro se añadirán más filtros

nombre	descripción
string	Filtra el contentido donde el parámetro es igual a este valor. Por ejemplo: /content?id=1234&contentType=post Recupera un contentido cuyo modelo es igual a post
in	Filtra el contenido donde el parámetro contiene alguno de estos valores. Por ejemplo: /content?id=1234&language[in]=es,en Recupera un contenido filtrando los campos que coincidan con es y/o en

Ejemplo:

shell

// Recupera un solo contenido filtrando por el modelo y el idioma
curl https://api.contentisland.net/api/1.0/content?id=1234&contentType=post&language[in]=es,en \
--header 'Authorization: Bearer TU_TOKEN_DE_ACCESO'

Respuesta

La respuesta es un objeto JSON que contiene información sobre el contenido. Este objeto tiene la siguiente estructura:

export interface Content {
  id: string;
  contentType: { id: string; name: string };
  lastUpdate: Date;
  fields: Field[];
}

export interface Field {
  id: string;
  name: string;
  value: any;
  type: FieldType;
  isArray: boolean;
  language: string;
}

• id: El ID del contenido.
• contentType: El modelo al que pertenece el contenido. Contiene un id y un name.
• lastUpdate: La fecha de la última actualización del contenido.
• fields: Un array de objetos que representan los campos del contenido.

Ejemplo:

{
  "id": "1",
  "contentType": {
    "id": "100",
    "name": "post"
  },
  "lastUpdate": "2023-10-01T12:00:00Z",
  "fields": [
    {
      "id": "111",
      "name": "title",
      "value": "Hola Mundo",
      "type": "short-text",
      "isArray": false,
      "language": "es"
    },
    {
      "id": "222",
      "name": "body",
      "value": "Este es el cuerpo del post en markdown.",
      "type": "long-text",
      "isArray": false,
      "language": "es"
    },
    { "id": "333", "name": "order", "value": 1, "type": "number", "isArray": false, "language": "es" }
  ]
}

Códigos de estado

Código	Descripción
200	La solicitud se ha procesado correctamente y se ha devuelto la información del proyecto.
401	No autorizado. El token de acceso no es válido o ha expirado.
500	Error interno del servidor. Ocurrió un error al procesar la solicitud.