node package manager

contentful

npm Build Status Coverage Status Dependency Status devDependency Status

semantic-release js-standard-style npm downloads

Javascript SDK for Contentful's Content Delivery API.

About

Contentful is a content management platform for web applications, mobile apps and connected devices. It allows you to create, edit & manage content in the cloud and publish it anywhere via a powerful API. Contentful offers tools for managing editorial teams and enabling cooperation between organizations.

Features

Browsers and Node.js:

  • Chrome
  • Firefox
  • Edge
  • IE11 (with es6-promise polyfill applied)
  • Safari
  • node.js (4.x, 6.x)

Other browsers should also work, but at the moment we're only running automated tests on the browsers and Node.js versions specified above.

Getting started

In order to get started with the Contentful JS SDK you'll need not only to install it, but also to get credentials which will allow you to have access to your content in Contentful.

Installation

In node, using npm:

npm install contentful

Or, if you'd like to use a standalone built file you can use the following script tag or just download it from unpkg, under the dist directory:

<script src="https://unpkg.com/contentful@latest/dist/contentful.min.js"></script>

It is not recommended to use the above URL for production.

Using contentful@latest will always get you the latest version, but you can also specify a specific version number:

<script src="https://unpkg.com/contentful@4.1.1/dist/contentful.min.js"></script>

Check the releases page to know which versions are available.

Authentication

To get content from Contentful, an app should authenticate with an OAuth bearer token.

You can create API keys using Contentful's web interface. Go to the app, open the space that you want to access (top left corner lists all the spaces), and navigate to the APIs area. Open the API Keys section and create your first token. Done.

Don't forget to also get your Space ID.

For more information, check the Contentful's REST API reference on Authentication.

Using ES6 import

You can use the es6 import with the SDK as follow

// import createClient directly 
import {createClient} from 'contentful'
const client = createClient({
  // This is the space ID. A space is like a project folder in Contentful terms 
  space: 'developer_bookshelf',
  // This is the access token for this space. Normally you get both ID and the token in the Contentful web app 
  accessToken: '0b7f6x59a0'
})
//.... 

OR

// import everything from contentful 
import * as contentful from 'contentful'
const client = contentful.createClient({
  // This is the space ID. A space is like a project folder in Contentful terms 
  space: 'developer_bookshelf',
  // This is the access token for this space. Normally you get both ID and the token in the Contentful web app 
  accessToken: '0b7f6x59a0'
})
// .... 

Your first request

The following code snippet is the most basic one you can use to get some content from Contentful with this SDK:

const contentful = require('contentful')
const client = contentful.createClient({
  // This is the space ID. A space is like a project folder in Contentful terms 
  space: 'developer_bookshelf',
  // This is the access token for this space. Normally you get both ID and the token in the Contentful web app 
  accessToken: '0b7f6x59a0'
})
// This API call will request an entry with the specified ID from the space defined at the top, using a space-specific access token. 
client.getEntry('5PeGS2SoZGSa4GuiQsigQu')
.then((entry) => console.log(entry))

You can try and change the above example at Tonic, or if you'd prefer a more Browser oriented example, check out this JSFiddle version of our Product Catalogue demo app.

Using this SDK with the Preview API

This SDK can also be used with the Preview API. In order to do so, you need to use the Preview API Access token, available on the same page where you get the Delivery API token, and specify the host of the preview API, such as:

const contentful = require('contentful')
const client = contentful.createClient({
  space: 'developer_bookshelf',
  accessToken: 'preview_0b7f6x59a0',
  host: 'preview.contentful.com'
})

You can check other options for the client on our reference documentation

Advanced features

Link resolution

contentful.js does resolve links by default unless specified otherwise. To disable it just set resolveLinks to false when creating the Contentful client. Like so

const contentful = require('contentful')
const client = contentful.createClient({
  accessToken:'<you-access-token>',
  space: '<your-space-id>',
  resolveLinks: false
})

Please note that the link resolution is only possible when requesting records from the collection endpoint using client.getEntries() or by performing an initial sync client.sync({initial: true}). In case you want to request one entry and benefit from the link resolution you can use the collection end point with the following query parameter 'sys.id': '<your-entry-id>'.

e.g. assuming that you have a contentType post that has a reference field author

const contentful = require('contentful')
const client = contentful.createClient({
  accessToken:'<you-access-token>',
  space: '<your-space-id>',
})
// getting a specific Post 
client.getEntries({'sys.id': '<entry-id>'}).then((response) => {
  // output the author name 
  console.log(response.items[0].fields.author.fields.name)
})

The link resolution is applied to one level deep by default. If you need it to be applied deeper, you may specify the include parameter when fetching your entries as follows client.getEntries({include: <value>}). The include parameter can be set to a number up to 10..

Sync

The Sync API allows you to keep a local copy of all content in a space up-to-date via delta updates, meaning only changes that occurred since last sync call. Whenever you perform a sync operation the endpoint will send back a syncToken which you can use in a subsequent sync to only retrieve data which changed since the last call. e.g.

const contentful = require('contentful')
const client = contentful.createClient({
  accessToken:'<you-access-token>',
  space: '<your-space-id>',
})
// first time you are syncing make sure to spcify `initial: true` 
client.sync({initial: true}).then((response) => {
  // You should save the `nextSyncToken` to use in the following sync 
  console.log(response.nextSyncToken)
})

The SDK will go through all the pages for you and gives you back a response object with the full data so you don't need to handle pagination.

Querying & Search parameters

You can pass your query params as key: value pairs in the query object whenever request a resource. e.g.

const contentful = require('contentful')
const client = contentful.createClient({
  accessToken:'<you-access-token>',
  space: '<your-space-id>',
})
 
// getting a specific Post 
client.getEntries({'sys.id': '<entry-id>'}).then((response) => {
  // output the author name 
  console.log(response.items[0].fields.author.fields.name)
})
 
// You can pass a query when requesting a single entity 
client.getEntry('<entry-id>', {key: value})

for more infos about the search parameters check the documentation

Troubleshooting

  • Can I use the SDK in react native projects
    • Yes it is possible
  • Link resolution does not work when using client.getEntry('<entry-id>')
    • Link resolution does not work with the single entity endpoint, you can use client.getEntries({'sys.id': '<entry-id>'}) to link an entry with resolved links
  • Can I use it with typescript?
    • Yes, there is also a type definition file
  • Is the SDK doing any caching?
    • No, check this issue for more infos
  • 😱 Something is wrong what should I do?
    • If it is a bug related to the code create a Github issue and make sure to remove any credential for your code before sharing it.
    • If you need to share your credentials, for example you have an issue with your space, please create a support ticket in the support page.

Documentation/References

To help you get the most out of this SDK, we've prepared reference documentation, tutorials and other examples that will help you learn and understand how to use this library.

Reference documentation

The Contentful's JS SDK reference documents what objects and methods are exposed by this library, what arguments they expect and what kind of data is returned.

Most methods also have examples which show you how to use them.

You can start by looking at the top level contentful namespace.

From version 3.0.0 onwards, you can access documentation for a specific version by visiting `https://contentful.github.io/contentful.js/contentful/<VERSION>`

Contentful JavaScript resources

Check the Contentful for JavaScript page for Tutorials, Demo Apps, and more information on other ways of using JavaScript with Contentful

REST API reference

This library is a wrapper around our Contentful Delivery REST API. Some more specific details such as search parameters and pagination are better explained on the REST API reference, and you can also get a better understanding of how the requests look under the hood.

Legacy contentful.js

For versions prior to 3.0.0, you can access documentation at https://github.com/contentful/contentful.js/tree/legacy

Versioning

This project strictly follows Semantic Versioning by use of semantic-release.

This means that new versions are released automatically as fixes, features or breaking changes are released.

You can check the changelog on the releases page.

Migration from contentful.js 3.x

From version 4.0.0 and up contentful.js is exported as a single umd bundle the cdn distribution has changed, there is no more browser-dist. the new link format is https://unpkg.com/contentful@version/dist/contentful.min.js instead of https://unpkg.com/contentful@version/browser-dist/contentful.min.js. to access version 3 you can still use https://unpkg.com/contentful@3.0.0/browser-dist/contentful.min.js

Migration from contentful.js 2.x and older

contentful.js 3.x was a major rewrite, with some API changes. While the base functionality remains the same, some method names have changed, as well as some internal behaviors.

See the migration guide for more information.

Support

If you have a problem with this library, please file an issue here on Github.

If you have other problems with Contentful not related to this library, you can contact Customer Support.

Contributing

See CONTRIBUTING.md

License

MIT