This section is for developers who want to find out more about how to integrate a website, app or e-commerce system with Dynamic Content.
In this section we've included information to help you implement each step of a typical project, from creating your content types to consuming published content.
In this section
- Content type schemas. All you need to know about creating content type schemas, including using the schema editor. This section also includes reference information and examples.
- Working with content types. How to register and update content types and configure icons, cards and visualizations. Also includes how to develop visualizations and custom cards.
- Slots. Shows how to create an example slot type and populate a slot item with content.
- Consuming content goes into detail about how to consume content from a slot and as an individual content item.
- Content preview apps. How to make use of the content "time machine" feature, including a simple example.
- Extensions. How to create extensions to provide custom features not found on the standard content editing form.
- Webhooks. Developers create webhooks that subscribe to certain specified "webhook events" generated by Dynamic Content. Webhooks are particularly useful when creating your own integration.
- Search indexes. Our search index feature makes it easy to create and manage an index for your Dynamic Content data.
- API Reference. Includes the Content Delivery API, the Content Rendering Service and the Content Management API.
The following explains the main parts of this section in more detail.
Content type schemas
This section takes developers through what will typically be their first step in a project: creating content type schemas. These will usually be based on designs and wireframes from the creative team. Content type schema development involves creating a JSON schema that describes the content, breaking it down into its component parts: such as text, images and video elements and applying business rules, such as field validation. In the content type schema section we go through the structure of schemas in detail, including examples of each property type and validation and provide some complete examples. We also show how to use the new schema editor to quickly create schemas.
Working with content types
In order to make it easier for content producers to work with content created from your content types, you should configure a card, either using one of our built-in cards or by creating a custom card. A card provides a representation of a content item in the content library, making a content item easier to find.
Visualizations provide a preview of content in the content editing window, allowing content producers to make sure they're happy with content before it's scheduled to be published.
Both cards and visualizations are written in a similar way and involve writing code to retrieving the content from the CMS and developing rendering code, such as handlebars and CSS. Much of the same code will be used for consuming published content.
In Dynamic Content content items are contained within slots. This section walks you through the creation of a slot type, creating a slot, adding it to an edition and scheduling some content to be published into that slot. It also shows how to find the slot id for a slot item, this is then used to consume the content in that slot.
In the consuming content section, we explain how to retrieve individual content items, and slots from the CMS. As you will see, both slots and content items have a unique ID that is used to retrieve their content in JSON format. The only difference is that a slot is a container for one or more content items.
In this section we walk through the example of consuming content that is published to a slot and provide some example rendering code, including a handlebars template. Much of this rendering code will be the same for each content type, whether you're developing a card preview or visualization or consuming that content as part of a slot.
Content preview apps
A content preview app lets you display of the contents of one or more slots at any point in the future. The content preview can range from a single slot to an entire website or app and allows content planners to see exactly what their selected channel will look like at the specified time. Consuming content within a content preview app is very similar to consuming published content in a slot, but there are some differences to allow you to view scheduled, but unpublished, content at the specified date and time. This page includes a simple, but complete example.