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!
- 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
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.
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.
npm
npm install @agility/content-fetch
yarn
yarn add @agility/content-fetch
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",
})Full documentation for this SDK can be found in our Agility Fetch JS SDK Reference Doc.
For docs & help around Agility CMS, please see Agility CMS Documentation
Authenticating your Content Fetch API Calls
Retrieving your API Key(s), Guid, and API URL
Making your First Call with the Content Fetch API
Calilng the Content Fetch API using the Javascript SDK
Page Management in a Headless CMS
Using Agility CMS with Create React App
Creating a Module for the Agility CMS Create React App
Creating a Page Template for the Agility CMS Create React App
Deploying your Agility CMS Create React App
If you would like to contribute to this SDK, you can fork the repository and submit a pull request. We'd love to include your updates.
An essential part of contributing to this SDK is adding and running unit tests to ensure the stability of the project.
> npm run test