@agility/content-fetch
Version:
JS/TS library for the Agility Fetch API
103 lines (63 loc) • 4.13 kB
Markdown
[](https://agility.visualstudio.com/Agility%20CMS/_build/latest?definitionId=59&branchName=master)
[](https://app.netlify.com/sites/agilitydocs/deploys)
# Agility Content Fetch JS SDK
This is the official JavaScript/TypeScript library for accessing live and preview content from your [Agility CMS](https://agilitycms.com) 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](https://agilitycms.com/free) 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
```javascript
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",
})
```
## Documentation
Full documentation for this SDK can be found in our [Agility Fetch JS SDK Reference Doc](https://agilitydocs.netlify.com/agility-content-fetch-js-sdk/).
For docs & help around Agility CMS, please see [Agility CMS Documentation](https://help.agilitycms.com/hc/en-us)
## Tutorials
[About the Content Fetch API](https://help.agilitycms.com/hc/en-us/articles/360031985112-About-the-Content-Fetch-API)
[Authenticating your Content Fetch API Calls](https://help.agilitycms.com/hc/en-us/articles/360032225191-Authenticating-your-Content-Fetch-API-Calls)
[Retrieving your API Key(s), Guid, and API URL](https://help.agilitycms.com/hc/en-us/articles/360031919212-Retrieving-your-API-Key-s-Guid-and-API-URL-)
[Making your First Call with the Content Fetch API](https://help.agilitycms.com/hc/en-us/articles/360031918152-Making-your-First-API-Call-with-the-Content-Fetch-API)
[Calilng the Content Fetch API using the Javascript SDK](https://help.agilitycms.com/hc/en-us/articles/360031945912-Calling-the-Content-Fetch-API-using-the-JavaScript-SDK)
[Page Management in a Headless CMS](https://help.agilitycms.com/hc/en-us/articles/360032554331-Page-Management-in-a-Headless-CMS)
[Using Agility CMS with Create React App](https://help.agilitycms.com/hc/en-us/articles/360031121692-Using-Agility-CMS-with-Create-React-App-CRA-)
[Creating a Module for the Agility CMS Create React App](https://help.agilitycms.com/hc/en-us/articles/360031590791-Creating-a-Module-for-the-Agility-CMS-Create-React-App)
[Creating a Page Template for the Agility CMS Create React App](https://help.agilitycms.com/hc/en-us/articles/360032611011-Creating-a-Page-Template-for-the-Agility-CMS-Create-React-App)
[Deploying your Agility CMS Create React App](https://help.agilitycms.com/hc/en-us/articles/360032203552-Deploying-your-Agility-CMS-Create-React-App)
[Content Webhooks](https://help.agilitycms.com/hc/en-us/articles/360035934911)
## Contributing
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.
### Running the Tests
An essential part of contributing to this SDK is adding and running unit tests to ensure the stability of the project.
```
> npm run test
```