The Kentico Cloud Delivery .NET SDK is a client library used for retrieving content from Kentico Cloud. You can use the SDK in the form of a NuGet package.

To retrieve content from a Kentico Cloud project via the Delivery API, you first need to activate the API for the project. See our documentation on how you can activate the Delivery API.

The DeliveryClient class is the main class of the SDK. Using this class, you can retrieve content from your Kentico Cloud projects. To create an instance of the class, you need to provide the ID of your project. See our documentation on how to get the project ID.

// Initializes an instance of the DeliveryClient client
DeliveryClient client = new DeliveryClient("975bf280-fd91-488c-994c-2f04416e5ee3");

Once you create a DeliveryClient, you can start querying your project repository by calling methods on the instance. See Basic querying for details.

The SDK supports full scale of the API querying and filtering capabilities as described in the API reference.

// Retrieves a list of the specified elements from the first 10 content items of
// the 'brewer' content type, ordered by the 'product_name' element value
DeliveryItemListingResponse response = await client.GetItemsAsync(
    new EqualsFilter("system.type", "brewer"),
    new ElementsParameter("image", "price", "product_status", "processing"),
    new LimitParameter(10),
    new OrderParameter("elements.product_name")
);

To retrieve unpublished content, you need to create a DeliveryClient with both Project ID and Preview API key. Each Kentico Cloud project has its own Preview API key.

// Note: Within a single project, we recommend that you work with only
// either the production or preview Delivery API, not both.
DeliverClient client = new DeliveryClient("YOUR_PROJECT_ID", "YOUR_PREVIEW_API_KEY");

For more details, see Previewing unpublished content using the Delivery API.

Once you have a DeliveryClient instance, you can start querying your project repository by calling methods on the instance.

// Retrieves a single content item
DeliveryItemResponse response = await client.GetItemAsync("about_us");

// Retrieves a list of all content items
DeliveryItemListingResponse listingResponse = await client.GetItemsAsync();

The DeliveryClient also supports retrieving of strongly-typed models.

// Retrieving a single content item
DeliveryItemResponse response = await client.GetItemAsync<Article>("latest_article");

// Retrieving all content items
DeliveryItemListingResponse listingResponse = await client.GetItemsAsync<Article>();

See Working with Strongly Typed Models in the wiki to learn how to generate models and adjust the logic to your needs.

For full description of single and multiple content item JSON response formats, see our API reference.

When retrieving a single content item, you get an instance of the DeliveryItemResponse class. This class represents the JSON response from the Delivery API endpoint and contains the requested ContentItem as a property.

When retrieving a list of content items, you get an instance of the DeliveryItemListingResponse. This class represents the JSON response from the Delivery API endpoint and contains:

• Pagination property with information about the following:
  • Skip: requested number of content items to skip
  • Limit: requested page size
  • Count: the total number of retrieved content items
  • NexPageUrl: the URL of the next page
• A list of the requested content items

The ContentItem class provides the following:

• System property with metadata such as code name, display name, type, or sitemap location.
• Elements as a dynamically typed property containing all the elements included in the response structured by code names.
• Methods for easier access to certain types of content elements such as modular content, or assets.

You can access information about a content item (i.e., its ID, codename, name, location in sitemap, date of last modification, and its content type codename) by using the System property.

// Retrieves name of an article content item
articleItem.System.Name

// Retrieves codename of an article content item
articleItem.System.Codename

// Retrieves name of the content type of an article content item
articleItem.System.Type

The SDK provides methods for retrieving content from content elements such as Asset, Text, Rich Text, Multiple choice, etc.

For text elements, you can use the GetString method.

// Retrieves an article text from the 'body_copy' Text element
articleItem.GetString("body_copy")

The Rich text element can contain links to other content items within your project. See Resolving links to content items for more details.

// Retrieves a teaser image URL
articleItem.GetAssets("teaser_image").First().Url

To get a list of options defined in a Multiple choice content element, you first need to retrieve the content element itself. For this purpose, you can use the GetContentElementAsync method, which takes the codename of a content type and the codename of a content element.

// Retrieves the 'processing' element of the 'coffee' content type
ContentElement element = await client.GetContentElementAsync("coffee", "processing");

After you retrieve the Multiple choice element, you can work with its list of options. Each option has the following properties:

To put the element's options in a list, you can use the following code:

List<SelectListItem> items = new List<SelectListItem>();

foreach (var option in element.Options)
{
    items.Add(new SelectListItem {
        Text = option.Name,
        Value = option.Codename,
        Selected = (option.Codename == "semi_dry")
    });
}

// Retrieves related articles
articleItem.GetModularContent("related_articles")

For more developer resources, visit the Kentico Cloud Developer Hub at https://developer.kenticocloud.com.

Prerequisites:

Required: .NET Core SDK.

Optional:

• Visual Studio 2017 for full experience
• or Visual Studio Code

Check out the contributing page to see the best places to file issues, start discussions, and begin contributing.

We would like to express our thanks to the following people who contributed and made the project possible:

• Jarosław Jarnot - Vimanet
• Varinder Singh - Kudos Web

Would you like to become a hero too? Pick an issue and send us a pull request!