Get Started with .NET SDK

This guide will help you get started with Contentstack .NET SDK to build .NET apps powered by Contentstack.

Prerequisites

  • .NET version 2.0 or later

SDK Installation and Setup

Contentstack offers two regions (US and European) as data centers to store customers' account details and data. Both regions are independent of each other and therefore have a dedicated set of instructions to use SDKs offered by Contentstack.

To use SDKs for the European region, you will have to make certain changes in the configuration of the SDK, as detailed below, and the rest of the instructions remain the same.

Open the terminal and install the contentstack module via “Package Manager” command:

PM> Install-Package contentstack.csharp

And via “.Net CLI”

dotnet add package contentstack.csharp

To use the module in your application, you need to first add Namespace to your class

using Contentstack.Core; // ContentstackClient
using Contentstack.Core.Models; // Stack, Query, Entry, Asset, ContentType
using Contentstack.Core.Configuration; // ContentstackOptions

Initialize SDK

You will need to specify the stack’s API Key, delivery token, and name of the environment where you have published your content.

// Initialize the Contentstack
ContentstackClient stack = new ContentstackClient("stack_api_key", "delivery_token", "environment_name");

OR

var options = new ContentstackOptions() {
    ApiKey = "<stack_api_key>",
    AccessToken = "<delivery_token>",
    Environment = "<environment_name>"
}
ContentstackClient stack = new ContentstackClient(options);

For Setting the European Region:

Refer the below code if you want to use European region.

ContentstackOptions options = new ContentstackOptions() {
    ApiKey = "<stack_api_key>",
    AccessToken = "<delivery_token>",
    Environment = "<environment_name>",
    Region = ContentstackRegion.EU
}
ContentstackClient stack = new ContentstackClient(options);

Once you have initialized the SDK, you can start getting content in your app.

Basic Queries

Get a Single Entry

To retrieve a single entry from a content type, use the code snippet given below:

Entry entry = client.ContentType("blog").Entry("blta464e9fbd048668c");
entry.Fetch<Blog>().ContinueWith((t) => { 
    if (!t.IsFaulted) { 
        Console.WriteLine("entry:" + t.Result);  
    } 
});

Get Multiple Entries

To retrieve multiple entries of a particular content type, use the code snippet given below:

Query query = client.ContentType("blog").Query(); 
query.Where("title", "welcome"); 
query.IncludeSchema(); 
query.IncludeCount(); 
query.ToJSON(); 
query.Find<Blog>().ContinueWith((t) => { 
    if (!t.IsFaulted) { 
         ContentstackCollection<Blog> result = t.Result; 
         Console.WriteLine("result" + result); 
    } 
});

These were examples of some of the basic queries of the SDK. For advanced queries, refer to the Contentstack .NET SDK API reference.

On This Page

top-arrow