logo
logo

Web Client SDK

Note

In Sitecore Content Hub 3.0, the Web API client SDK (WebApiClient) was replaced by a new Web Client SDK (WebClient). The WebApiClient SDK is supported until Sitecore Content Hub 3.2 so that existing code can be migrated over two major releases.

The Web Client SDK (WebClient) supports scripting through a Scripting SDK as well as supporting code in the Web SDK and the Scripting SDK. The Web Client SDK, however, does not work directly with REST API resources. (Almost) everything REST related has been abstracted away, although the Web SDK still features ways to manage HTTP calls. Furthermore, to ensure consistent performance across all services, backend services apply throttling mechanisms.

Note

Guidelines for throttling are available in the Best practices section of the documentation. The Web Client API handles throlling internally and developers do not need to handle it in their code.

To get started, see:

API reference

The API reference provides further information about the classes and the objects used by the Web client SDK.

Note

Examples in the API reference use strongly defined return types such as IEntity instead of var, which is commonly used in C#. This is done for clarity in the examples, but is not recommended when writing actual code. Using var has multiple benefits.

Can we improve this article ? Provide feedback