Agility Content Fetch JS SDK

This is the official JavaScript/TypeScript library for accessing live and preview content from your Agility CMS instance.

You can use this in both node and browser based JS apps.

Don't have an Agility CMS instance? Sign up for Free Trial today!

Features

Queries the high-availability, CDN backed Agility Fetch REST API
Get a sitemap for a given channel
Get a page, including its content zones, modules, and their content
Get a content item
Query a content list using a filter syntax
Get the details of a media gallery
Keep track of syncing content to your app

Getting Started

In order to use this sdk, you'll need to install the @agility/content-fetch package and you'll also need to authenticate your requests.

Prerequisites

You must have access to an Agility instance to retrieve the guid and generate your apiKey. Or, you must have these values provided to you.

Installation

npm

npm install @agility/content-fetch

yarn

yarn add @agility/content-fetch

Making a Request

import agility from "@agility/content-fetch"

//initialize the api client
const api = agility.getApi({
	guid: "[guid]",
	apiKey: "[your-api-key]",
})

//make the request: get a content item with the ID 22 in locale 'en-us'
const contentItems = await api.getContentItem({
	contentID: 22,
	locale: "en-us",
})