createClient

La función createClient crea una instancia del cliente de la API de Content Island.

Ejemplo:

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

const client = createClient({
  accessToken: 'TU_TOKEN_DE_ACCESO',
  // ... opciones adicionales
});

Interfaz

function createClient(options: Options): ApiClient;

Parámetros

Esta función acepta un objeto de configuración con las siguientes propiedades:

interface Options {
  accessToken: string;
  domain?: string;
  secureProtocol?: boolean;
  apiVersion?: string;
}

nombre	descripción
`accessToken`	`Token de acceso` de tu proyecto. Puedes encontrar este token en la pestaña General.
`domain`	Dominio para hacer las peticiones. Útil si tienes Content Island `On Premise` Por defecto: `api.contentisland.net`
`secureProtocol`	Indica si se debe usar HTTPS para las peticiones. Por defecto: `true` (usar HTTPS)
`apiVersion`	Versión de la REST API. Por defecto: `1.0`

Salida

La función createClient devuelve una instancia del cliente de la API de Content Island. Esta instancia tiene métodos para interactuar con la API, como getContentList, getProject, etc.

interface ApiClient {
  getProject: () => Promise<Project>;
  getContentList: <Model>(queryParam?: QueryParams<Model>) => Promise<Model[]>;
  getContent: <Model>(queryParam: QueryParams<Model>) => Promise<Model>;
  getRawContentList: <Model>(queryParam?: QueryParams<Model>) => Promise<Content[]>;
  getRawContent: <Model>(queryParam: QueryParams<Model>) => Promise<Content>;
}