Introduction

proknow-sdk is a .NET software development kit (SDK) to interface with ProKnow from .NET applications.

Installation

Install the SDK using NuGet.

Basic Usage

To use the SDK, you'll need two important items:

• Base URL: This is the URL that will be used to make API requests to ProKnow. It's the first part of the web address you see when you are signed into your ProKnow account. The form of this URL is typically https://your-domain.proknow.com.

• API Token: You can generate an API token in the ProKnow user interface. Always keep your API token secret. Once you have your credentials.json, make note of the file path.

The code snippet below can be used to test your installation and configuration of the proknow-sdk package.

The LoggerFactory property of the ProKnow.ProKnowLogging class needs to be initialized prior to using the SDK, if logging is desired. See the Microsoft article Logging in .NET for more information. The example below requires the Microsoft.Extensions.Logging and Microsoft.Extension.Logging.Debug NuGet packages. When run in debug mode, it will output debug-level messages from the ProKnow.Upload.Uploads class.

Please be sure to replace https://example.proknow.com with your organization's base URL described above, and replace ./credentials.json with the path to your credentials file:

using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Debug;
using ProKnow;
using System.Threading.Tasks;

using var loggerFactory = LoggerFactory.Create(builder =>
{
    builder
        .AddFilter(typeof(Uploads).FullName, LogLevel.Debug)
        .AddProvider(new DebugLoggerProvider());
});
ProKnowLogging.LoggerFactory = loggerFactory;
var pk = new ProKnowApi('https://example.proknow.com', './credentials.json');
var connectionStatus = await pk.GetConnectionStatusAsync();
if (!connectionStatus.IsValid)
{
    throw new Exception($"Error connecting to ProKnow API: {connectionStatus.ErrorMessage}.");
}

Note that the majority of the methods in the SDK are asynchronous. Asynchronous methods are named with the 'Async' suffix per convention. For more information about asynchronous programming, please refer to the Microsoft Asynchronous programming with async and await article.

If an adaptation of the above code snippet does not work for you, please see the troubleshooting guide.