contensis-delivery-api

contensis-delivery-api

Contensis JavaScript Delivery API implementation written in TypeScript.

This allows the querying and retrieval of entries, content types and projects in JavaScript.

It can be used in any ES5 compatible project.

• Angular
• React
• React Native
• NativeScript
• Express

The examples folder contains Express, React and Angular test applications.

Installation

The Contensis JavaScript Delivery API can be installed using npm.

npm install contensis-delivery-api

Examples

Using ES2015 async/await

import { Client } from 'contensis-delivery-api';

let contensisConfig = { 
	rootUrl: 'https://my-cms.com',
	accessToken: 'MY_DELIVERY_API_ACCESS_TOKEN',
	projectId: 'MY_PROJECT_ID',
	language: 'en-GB',
	versionStatus: 'published',
	pageSize: 50
};

async function loadMovies() {
	let client = Client.create(contensisConfig);
	let movieList = await client.entries.list({
		contentTypeId: 'movie',
		pageOptions: { pageIndex: 0, pageSize: 10 },
		orderBy: ['-releaseDate']
	});
	console.log(movieList.items);
}

loadMovies();

Using Promises

import { Client } from 'contensis-delivery-api';

let contensisConfig = { 
	rootUrl: 'https://my-cms.com',
	accessToken: 'MY_DELIVERY_API_ACCESS_TOKEN',
	projectId: 'MY_PROJECT_ID',
	language: 'en-GB',
	versionStatus: 'published',
	pageSize: 50
};

function loadMovies() {
	let client = Client.create(contensisConfig);
	client.entries.list({
		contentTypeId: 'movie',
		pageOptions: { pageIndex: 0, pageSize: 10 },
		orderBy: ['-releaseDate']
	}).then(movieList => {
		console.log(movieList.items);
	});
}

loadMovies();

Documentation

Read our documentation on the Contensis Javascript Delivery API to learn of all it's features.

Changelog

[1.0.0] - 2019-02-28

Added

• Created this repo from the develop branch of api-delivery-js repo.
• Published the first npm package.