contentful

What is contentful?

The contentful npm package is a JavaScript client for the Contentful Content Delivery API and Content Management API. It allows developers to fetch and manage content from Contentful's content infrastructure, making it easy to integrate content into web and mobile applications.

What are contentful's main functionalities?

Fetching Entries

This feature allows you to fetch entries from your Contentful space. The code sample demonstrates how to create a client and fetch all entries.

const contentful = require('contentful');
const client = contentful.createClient({
  space: 'your_space_id',
  accessToken: 'your_access_token'
});

client.getEntries()
  .then((response) => console.log(response.items))
  .catch(console.error);

Fetching a Single Entry

This feature allows you to fetch a single entry by its ID. The code sample shows how to create a client and fetch a specific entry.

const contentful = require('contentful');
const client = contentful.createClient({
  space: 'your_space_id',
  accessToken: 'your_access_token'
});

client.getEntry('entry_id')
  .then((entry) => console.log(entry))
  .catch(console.error);

Fetching Assets

This feature allows you to fetch assets from your Contentful space. The code sample demonstrates how to create a client and fetch all assets.

const contentful = require('contentful');
const client = contentful.createClient({
  space: 'your_space_id',
  accessToken: 'your_access_token'
});

client.getAssets()
  .then((response) => console.log(response.items))
  .catch(console.error);

Content Management

This feature allows you to manage content, such as creating new entries. The code sample shows how to create a client and create a new entry in a specific content type.

const contentfulManagement = require('contentful-management');
const client = contentfulManagement.createClient({
  accessToken: 'your_management_access_token'
});

client.getSpace('your_space_id')
  .then((space) => space.createEntry('content_type_id', {
    fields: {
      title: {
        'en-US': 'Hello, World!'
      }
    }
  }))
  .then((entry) => console.log(entry))
  .catch(console.error);

Other packages similar to contentful

prismic-javascript

Prismic is a headless CMS similar to Contentful. The prismic-javascript package allows you to query content from Prismic's API. It offers similar functionalities such as fetching entries and assets, but with a different API structure and query language.

strapi-sdk-javascript

Strapi is an open-source headless CMS that provides a JavaScript SDK for interacting with its API. The strapi-sdk-javascript package allows you to fetch and manage content, similar to Contentful, but with the added benefit of being open-source and self-hosted.

README

contentful.js

Javascript client for Contentful's Content Delivery API:

• Documentation
• Example Apps
• Tests running in node and browsers via BrowserStack

Supported browsers/environments:

• Chrome
• Firefox
• IE10
• node.js >= 0.8

Install

In node, using npm:

npm install contentful

In a browser, using bower:

bower install contentful
# After installing, add this as a script tag:
# <script src="components/contentful/dist/contentful.min.js"></script>

Latest contentful.min.js.

Note: The next minor version release of dist/contentful.min.js will be much smaller. Please use a package manager to keep your JS dependencies up to date and get the newest version right when it's ready!

Usage

// Don't require if you've already included contentful as a script tag
var contentful = require('contentful');

var client = contentful.createClient({
  // ID of Space
  space: 'cfexampleapi',

  // A valid access token within the Space
  accessToken: 'b4c0n73n7fu1',

  // Enable or disable SSL. Enabled by default.
  secure: true,

  // Set an alternate hostname, default shown.
  host: 'cdn.contentful.com'
});

var log = console.log.bind(console); // wat

// Get Space
client.space().then(log, log);

// Get all Entries
client.entries().then(log, log);

// Get Assets using callback interface
client.entries({}, function(err, entries) {
  if (err) { console.log(err); return; }
  console.log(entries);
});

For now, please check out the Content Delivery API documentation to learn how the API and the JavaScript client work.

Functionality

supported

• .space() = get details of current space
• .contentTypes() = get content types of current space
• .entries() = get entries of current space
• ...

not supported

• Sync

License

MIT