Loading...
Area: Episerver Search & Navigation
Applies to versions: 12 and higher
Other versions:

.NET Client API

Recommendations [hide]

This topic introduces the .NET client API for Episerver Search & Navigation (formerly Episerver Find). This is a fluent (chained) API, providing a readable code that lets you index and search for actual domain objects with great flexibility.

How it works

The .NET client API for Episerver Search & Navigation is built on the premise of "convention over configuration," meaning it "just works" out-of-the-box using a set of default conventions. Using code, you can customize these conventions to suit your needs. This topic describes how to configure Search & Navigation to start working with the .NET API.

To use the .NET API, first add references to the required assemblies, EPiServer.Find.dll and NewtonSoft.Json.dll. Next, configure the service URL and default index name in web.config/app.config

Open the web.config/app.config file and add the following:

<configuration>
  <configSections>
    <section name="episerver.find"
             type="EPiServer.Find.Configuration, EPiServer.Find"
             requirePermission="false"/>
  </configSections>
  <episerver.find serviceUrl="http://..." defaultIndex="myindex"/>
</configuration>

See also Getting started with Search & Navigation.

Next, create an instance of the Client class and start working with the Find service. See Client class for more details about next steps.

Related topics

Do you find this information helpful? Please log in to provide feedback.

Last updated: Oct 31, 2016

Recommendations [hide]