Integrate Algolia with ASP.NET

This is documentation for v6 of the C# API clients, which is not the latest version. To see the documentation for the latest version, see C# v7.

Learn how to add a reusable Algolia client to your ASP.NET application. First, install the .NET Algolia API client.

Inject a reusable client

To keep performance optimal, you should reuse the client instance for every request. To do this, inject the SearchClient as singleton in the service provider.

Open the Startup.cs file and add the following line in the ConfigureSerivces method.

1
2
3
4
5
6
7
public void ConfigureServices(IServiceCollection services)
{
    ...
    services.AddSingleton<ISearchClient, SearchClient>();
    services.AddSingleton<ISearchClient>(new SearchClient("YourApplicationID", "YourSearchOnlyAPIKey"));
    ...
}

You can reuse the same SearchClient for multiple indices, as SearchClient is thread-safe.

If you are using other clients such as the AnalyticsClient or InsightsClient you should also add them as singletons in the service provider.

Reusable clients in your controllers

To reuse the SearchClient instance in your controllers, add the following lines:

1
2
3
4
5
6
7
8
9
public class HomeController : Controller
{
    private readonly ISearchClient _searchClient;

    public HomeController(ISearchClient searchClient)
    {
        _searchClient = searchClient;
    }
}
Did you find this page helpful?
C# API clients v6