createClient

The createClient function creates an instance of the Content Island API client.

Example:

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

const client = createClient({
  accessToken: 'YOUR_ACCESS_TOKEN',
  // ... additional options
});

Danger

It’s important to keep your access token secret and never share it publicly. This token grants access to your project and all associated content. If the token is compromised, a third party could access your data and make unauthorized changes. If you believe your token has been exposed, review it immediately in your project’s General tab and generate a new one.

Tip

Ideally, the access token should be stored in an environment variable and not included directly in the source code. This environment variable should only be accessible from server-side code. You can see an example of how to do this in the Getting Started section.

Interface

function createClient(options: Options): ApiClient;

Parameters

This function accepts a configuration object with the following properties:

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

Name	Description
accessToken	Your project’s access token. You can find this token in the General tab.
domain	Domain used for requests. Useful if you’re using Content Island On Premise. Default: api.contentisland.net
apiVersion	Version of the REST API. Default: 1.0

Output

The createClient function returns an instance of the Content Island API client. This instance has methods to interact with the API, such as getContentList, getProject, etc.

interface ApiClient {
  getProject: () => Promise<Project>;
  getContentList: (queryParam?: QueryParams) => Promise<Content[]>;
  getContent: (id: string, queryParam?: QueryParams) => Promise<Content>;
}