Skip to main content

Ceros Contentful App

The Ceros Contentful App replaces the entry editor for a content type of your choosing in Contentful. Authors link a published Ceros experience to an entry and see it previewed in place — no copying embed codes between tabs, and a choice of how the experience is delivered to the page.

Embed styles

The app offers three ways to render an experience, so you can trade off layout control and rendering approach:

StyleWhat it does
Full heightIframe embed that grows to the experience's height; works for every experience
ScrollableIframe embed at a fixed height that scrolls internally
InlineRenders through the embed script with no iframe (Flex experiences only)

Inline is offered only when the linked experience is a Flex experience and an inline snippet is available for it.

Adding an experience

There are two ways to get an experience onto an entry:

  • Experience picker — with a Ceros REST API key configured, authors browse their account's folder tree and select an experience directly.
  • Published URL — paste the URL of a published experience. No API key needed, which makes the app usable in spaces that cannot hold Ceros credentials.

Vanity domains

An experience published to a domain of your own can be pasted as it stands. The app resolves that URL to the canonical experience before linking it, so entries stay pointed at the experience itself rather than at the domain fronting it.

Once an entry is linked, the editor keeps three actions alongside the preview:

  • Refresh Embed Code — re-fetch the embed code without relinking, for when an experience's canvas size or device variants change. The entry keeps the embed style it was linked in.
  • Change embed style — switch an already-linked entry to one of the other styles.
  • Unlink Experience — clear the experience from the entry.

Connecting to Ceros

The Ceros REST API key is entered once on the app's configuration screen and stored as a Contentful Secret installation parameter. Contentful redacts Secret parameters on every browser-side read, so no client-side code can read the key back — only the app's Contentful Function ever sees its value.

That makes the field write-only: it starts blank on every visit even when a key is stored, saving it empty leaves the stored key untouched, and rotating the key means typing a new one and saving.

Requirements

  • A Contentful space
  • A Ceros REST API key (optional — only needed for the experience picker)

Get started

The app installs from the Ceros listing on the Contentful marketplace, currently at version 1.2.0. Full installation and configuration detail lives in the repository:

View on GitHub