IntelligentPlant.DataCore.HttpClient 3.1.0

IntelligentPlant.DataCore.HttpClient

This package defines types for calling the Intelligent Plant Data Core API, used by Industrial App Store apps, and on-premises apps from Intelligent Plant.

Please consider using one of the following packages to simplify configuration of Data Core API client applications:

The packages can also be used to write on-premises apps that interface with a local Data Core API instance.

Getting Started

The following sections describe how to configure API clients for querying standalone Data Core API instances using static authentication:

Windows Authentication

To create a Data Core API client for querying a standalone Data Core API instance using Windows authentication, use the DataCoreHttpClient class, ensuring that the HttpClient you provide has the appropriate credentials configured:

var handler = new HttpClientHandler() {
    Credentials = new NetworkCredential("username", "password")
};
var httpClient = new HttpClient(handler);

var options = new DataCoreHttpClientOptions() {
    // Remember the trailing / at the end of the URL!
    DataCoreUrl = new Uri("https://path/to/data/core/")
};

var client = new DataCoreHttpClient(httpClient, options);

var dataSources = await client.DataSources.GetDataSourcesAsync();

Static Authentication Header

When creating a Data Core API client for querying a Data Core API instance using a fixed authentication header (e.g. using Basic authentication), it is not necessary to manually create the inner HTTP message handler for the HttpClient instance. Instead, default request headers can be specified on the HttpClient:

var httpClient = new HttpClient();
httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(
    "Basic",
    Convert.ToBase64String(Encoding.ASCII.GetBytes("username:password"))
);

var options = new DataCoreHttpClientOptions() {
    // Remember the trailing / at the end of the URL!
    DataCoreUrl = new Uri("https://path/to/data/core/")
};

var client = new DataCoreHttpClient(httpClient, options);

var dataSources = await client.DataSources.GetDataSourcesAsync();