PINGWorks.SitecoreAI.SitesSDK 1.1.0

PINGWorks.SitecoreAI.SitesSDK

This is a .NET SDK for working with SitecoreAI's Sites API.<br /> More information about Sitecore's API is at Sites API Doc (official)

Features

• Typed, DI-friendly service for interacting with the SitecoreAI Sites API
• Async-first API with CancellationToken support and full XML documentation comments
• NetStandard 2.1 for wide compatibility
• Automatic token maintenance using client credentials flow
• Optional environmentId parameter on all operations for targeting specific environments
• Individual focused interfaces for each API group for narrower dependency injection

Getting started

Prerequisites

To work with the SDK you will require credentials which are created in the SitecoreAI Deployment Portal.

Create an Environment credential of type Automation for the project and environment combination for which you wish to grant access.

Install

From your project directory:

dotnet add package PINGWorks.SitecoreAI.SitesSDK

AppSettings

Properties are available to configure the SDK through configuration binding. The snippet below shows all options along with their default values. You do not need to include values where you wish to use the defaults.

{
    /* The base URL of the Sites API */
    "ServiceEndpoint": "https://xmapps-api.sitecorecloud.io/",

    /* The URL of the Token Request API */
    "TokenEndpoint": "https://auth.sitecorecloud.io/oauth/token",

    /* The auth audience */
    "Audience": "https://api.sitecorecloud.io",

    /* The auth grant type */
    "GrantType": "client_credentials",

    /* The value of ClientID from the SitecoreAI Deploy Portal */
    "ClientID": "[Created in SitecoreAI Deploy portal's Credentials pane]",

    /* The value of ClientSecret from the SitecoreAI Deploy Portal */
    "ClientSecret": "[Created in SitecoreAI Deploy portal's Credentials pane]"
}

We recommend the use of Visual Studio's User Secrets feature to store sensitive information such as ClientId and ClientSecret during development.

Register services

Register the SDK in Program.cs, e.g. when using the minimal hosting model:

// Program.cs
var builder = WebApplication.CreateBuilder(args);

// Register SDK services - set options through binding or manually
builder.Services.AddSitecoreEESitesSDK( opt => config.GetSection( "mySettings" ).Bind( opt ) );

HttpClient defaults. This call (via AddSitecoreEECommon) applies AddStandardResilienceHandler() and a DEBUG-only console request/response logger to every HttpClient in your container — not just the SDK's own. See the PINGWorks.SitecoreExperienceEdge.Common README for how to customize the resilience options per-client.

This library uses Json serialization through System.Text.Json.

Using the environment ID

Most operations accept an optional environmentId parameter that targets a specific SAI environment. When omitted, the default environment is used.

// Target a specific environment
var sites = await sdk.ListSites( environmentId: "main" );

Available services

Inject ISitecoreSitesSdk for full API access, or inject any of the individual group interfaces for narrower, more focused dependencies.

Jobs — ISitecoreSitesJobsSdk

Languages — ISitecoreSitesLanguagesSdk

Collections — ISitecoreSitesCollectionsSdk

Favorites — ISitecoreSitesFavoritesSdk

Editor Profiles — ISitecoreSitesEditorProfilesSdk

Aggregation — ISitecoreSitesAggregationSdk

Sites — ISitecoreSitesSitesSdk

Sites

Analytics identifiers

Translation

Hierarchy

Hosts

Sitemap

Statistics