Using the Delivery API

You can use Kentico Cloud and its Delivery API as an API-first CMS. This enables you to develop websites or mobile applications in your favorite language and technology.

The Delivery API is read-only and allows you to retrieve content from your project. See the API reference for a complete list of methods you can use with the API.

To use the Delivery API functionality with your project, the API must be activated for the project first.

Enabling the Delivery API for your project

Once you activate the Delivery API for your project, you won’t be able to disable it.

To enable the Delivery API:

  1. In Kentico Cloud, navigate to the API keys section.
  2. Select a project using the project switcher at the top.
  3. In the Delivery API box, click Activate Delivery API.
Activating the Delivery API for a project.

Activating the Delivery API for a project.

Getting an object codename

All content types and content items are represented in the Delivery API using their codenames.

When developing a website, content item codenames help you identify which content item your website displays. Content type, sitemap, and taxonomy codenames help you create more complex filters for displaying multiple content items. For example, all content items of a certain content type.

Codenames are generated each time the display name of an object is updated. You can find and copy codenames by clicking the {#} icon near the name of a content item, content type, or other object.

Displaying a codename of a content item.

Displaying a codename of a content item.

In the administration interface, you can display codenames of the following objects:

  • Content types and their elements
  • Content items
  • Sitemap items
  • Taxonomy groups and their terms

Getting project ID

To access any content of your project using the Delivery API, you need to know the project ID. To get the project ID:

  1. In Kentico Cloud, navigate to the API keys section.
  2. Copy the Project ID and use it in your API calls.

A project ID can look like the following: 38af179c-40ba-42e7-a5ca-33b8cdcc0d45.


What's Next

Before you begin exploring the Delivery API, let us walk you through the way the content is structured in Kentico Cloud and what are the standard practices of working with the API.

Content structure
Get titles and images of 5 latest articles
Get all articles tagged with a specific taxonomy term
Preview content via API

Using the Delivery API