README

Agility Content Fetch JS SDK

This is the official JavaScript 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 (forever) 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
Optional in-memory caching

Getting Started

In order to use this sdk, you'll need to install the script 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

Install it using npm (recommended):

npm install @agility/content-fetch

If necessary, you can also reference a standalone package that can be used in a browser using a traditional script tag. In this case, the sdk can be accessed using a global variable by name of agility:

<!-- Use a specific version (i.e. 0.4.2) -->
<script type="text/javascript" src="https://unpkg.com/@agility/content-fetch@0.4.2/dist/agility-content-fetch.browser.js"></script>

<!-- Or, Use the latest version -->
<script type="text/javascript" src="https://unpkg.com/@agility/content-fetch@latest/dist/agility-content-fetch.browser.js"></script>

Making a Request

import agility from '@agility/content-fetch'

//initialize the api client
const api = agility.getApi({
  guid: 'ade6cf3c',
  apiKey: 'defaultlive.201ffdd0841cacad5bb647e76547e918b0c9ecdb8b5ddb3cf92e9a79b03623cb'
});

//make the request: get a content item with the ID '22'
api.getContentItem({
    contentID: 22,
    locale: 'en-us'
})
.then(function(contentItem) {
    //on success
    console.log(contentItem);
})
.catch(function(error) {
    //on error
    console.log(error);
});