Sitecore services Client(SSC) - SeviceAPIController Rest

-
Business has given the requirement to access the content of the items based on a template using some criteria by passing a parameter, this content will be used by the different opensource application and mobile device. So, I have decided to create an API using Sitecore service client(SSC)

Step 1:
Create the template for the item that needs to be searched.

Step2:
Create the class which inherits from ServiceAPIController (It is a WebAPI controller in asp.net but with all the security available for the items provided by Sitecore)

namespace Company.Feature.RestraurantsAPI.Controllers
{
    [ServicesController]
    public class RestaurantController : ServicesApiController
    {
        // GET: Restaurant
        [HttpGet]
        public IHttpActionResult Get(string id)
        {
            string CTAUrl = String.Empty;
            List<Restaurant> restaurantlist = new List<Restaurant>();
            using (var context = ContentSearchManager.GetIndex("sitecore_web_index").CreateSearchContext())
            {
                var searchQuery = context.GetQueryable<SearchResultItem>().Where(p => p.TemplateName=="Restaurants" && p["RestaurantCode"] == id).Select(i => (Item)i.GetItem()).ToList();
                foreach (var item in searchQuery)
                {
                    Item mediaItem = null;
                    string imageURL = string.Empty;
                    Sitecore.Data.Fields.ImageField imageField = item.Fields["RestaurantImage"];
                    if (imageField != null && imageField.MediaItem != null)
                    {
                        mediaItem = imageField.MediaItem;
                 
                        var mediaOptions = new MediaUrlOptions { AbsolutePath = true, AlwaysIncludeServerUrl=true };
                        var mediaUrl = MediaManager.GetMediaUrl(imageField.MediaItem, mediaOptions);
                        imageURL =  mediaUrl;
                    }
                    LinkField bookTableCTA = item.Fields["BookTableCTA"];
                   
                    switch (bookTableCTA.LinkType.ToLower())
                    {
                        case "internal":
                            CTAUrl= bookTableCTA.TargetItem != null ? LinkManager.GetItemUrl(bookTableCTA.TargetItem) : string.Empty;
                            break;
                        case "external":
                            CTAUrl= bookTableCTA.Url;
                            break;
                    }
                    Restaurant restaurant = new Restaurant()
                    {
                        RestaurantCode = item["RestaurantCode"],
                        BookTableCTA = CTAUrl,
                        Contact = item["Contact"],
                        Description = item["Description"],
                        DressCode = item["DressCode"],
                        Email = item["Email"],
                        Location = item["Location"],
                        RestaurantImage = imageURL,
                        RestaurantName = item["RestaurantName"],
                        SpecialOffers = item["SpecialOffers"],
                        Timings = item["Timings"]
                    };
                    restaurantlist.Add(restaurant);
                }

            }
            if (restaurantlist.Count() > 0)
            {
                return Ok(restaurantlist);
            }
            else
            {
                return BadRequest("No Restaurant found for this code: "+id) ;
            }
        }
    }
}

Step 3:
Provide a valid route for the API as we not going to use the default route provided by Sitecore, by defining [ServicesController] Sitecore will automatically provide the default route. Let’s define the custom route.

namespace Company.Feature.RestraurantsAPI.Pipeline
{
    public class RestaurantRoute
    {
  
        public void Process(PipelineArgs args)
        {
            RouteTable.Routes.MapHttpRoute("RestaurantApi", "Api/Restaurants/{id}", new
            {
                controller = "Restaurant",
                action = "Get"
            });
        }

    
    }
}

Step 4:
Finally, config update to patch the route pipeline we just created.

<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/" xmlns:set="http://www.sitecore.net/xmlconfig/set/">
  <sitecore>
       <pipelines>
      <initialize>
        <processor patch:after="processor[@type='Sitecore.Pipelines.Loader.EnsureAnonymousUsers, Sitecore.Kernel']"
          type="Company.Feature.RestraurantsAPI.Pipeline.RestaurantRoute, Company.Feature.RestraurantsAPI" />
      </initialize>
    </pipelines>

  </sitecore>
</configuration>

Output:
Url: http://hostname/API/Restaurants/001



Happy Programming :)

Comments

Post a Comment

Popular posts from this blog

Custom Item Url and resolving the item in Sitecore - Buckets

-
Image
I have a situation to update the Item URL to be SEO friendly as my items in content tree looks like below. In the above image in order to resolve the item, Sitecore will find the item from the below URL http://domainname/en/dine/nv/chicken but I need to form a URL that is more SEO friendly like http://domainname/en/chicken In Sitecore by Out of box, we can achieve this by using Aliases , we can create an Aliases under System à Aliases and in the Linked Item field select the target item. But this is very tedious as we need to go to every item in the content tree and create Aliases, instead of that we will be going to do it programmatically using custom pipelines. ·          Link Provider (Provides the custom URL for the item based on the templates) ·          Item Resolver (Resolves the item based on the custom URL generated by CustomLinkProvider , that we going to create later. Sitecore could not resolve the item in the specified path in the content tree
Read more

Exploring Sitecore XM Cloud Forms: A Comprehensive Overview

-
Image
  The most awaited news came from Sitecore about the release of XM Cloud Forms.  Previously Sitecore enthusiasts / Marketers used different ways of forms implementation in Sitecore to reach the target customers like WFFM (Web Form For Marketers) Sitecore Forms Embeddable Forms Framework(EFF) XM Cloud Form is the latest addition by Sitecore and especially used to create Forms on XM Cloud pages. It will only work with the latest version of Sitecore JSS (21.6) Note:  I have tried to use XM Cloud Forms in my local docker setup by cloning the starter   repo , but I couldn't see the option of Forms in the XM Cloud dashboard to get started. Lets explore together on the features of Forms. Similar to Sitecore Components, we can navigate to  https://forms.sitecorecloud.io/  to start creating the Forms There are 2 important tabs in creating Sitecore Forms  Forms  Webhook(for triggering the submit action) We can create, modify, delete, and activate the form from the Form tab.  Once the form is
Read more

Sitecore Custom Rule (Action and Condition)

-
Image
I have a situation to create a custom Sitecore rule and action for it. v   Goto /Sitecore/system/Settings/Rules/Definitions/Elements v   Create a new item base on the template “ ElementFolder ” with a name “ Custom Rule ” v   Click on the item and create condition and Actions that are necessary for your requirements Condition Template Item: It has two important sections v   Data ·          Text (This is the condition Text which will use tokens to evaluate the condition and user input which will be in [ ] brackets.The brackets contain four positional parameters separated by commas (“,”). 1. The name of the property that the parameter sets in the .NET class that implements the condition. 2. The name of an item beneath the /Sitecore/System/Settings/Rules/Common/Macros item providing predefined functionality, or an empty string. For example, to activate a user interface allowing the user to select an item from the content tree, specify the value tree. 3. URL param
Read more