Offlineer.Lib.Service 1.3.0

Offlineer.Lib.Service

A .NET client library for the Offlineer API, providing simple and type-safe access to license management through the Offlineer proxy to License8. Supports multiple Offlineer apps with a unified API interface.

Installation

dotnet add package Offlineer.Lib.Service

Quick Start

using Offlineer.Lib.Service;
using static Offlineer.Lib.Service.OfflineerAppLicenseClient;

// Initialize the client with environment and credentials
var client = new SoloPDFLicenseClient(
    env: Env.test, // or Env.production, Env.local
    appKey: "your-app-key",
    appSecret: "your-app-secret" // Optional for some endpoints
);

// Authenticate with a license key
var authResponse = await client.AuthenticateWithLicenseKeyAsync("XXXXX-XXXXX-XXXXX-XXXXX");

if (authResponse != null)
{
    Console.WriteLine($"Authenticated! JWT: {authResponse.Jwt}");
    Console.WriteLine($"License ID: {authResponse.LicenseID}");
    Console.WriteLine($"Max Devices: {authResponse.MaxDevices}");

    // Register a device
    var deviceResponse = await client.RegisterNewDeviceAsync(
        deviceID: "unique-device-id",
        deviceLabel: "User's Laptop",
        machineName: Environment.MachineName
    );

    // Validate token
    var isValid = await client.ValidateTokenAsync();
    Console.WriteLine($"Token valid: {isValid}");

    // List registered devices
    var devices = await client.ListRegisteredDevicesAsync();
    Console.WriteLine($"Total devices: {devices?.Count ?? 0}");
}

// Get license details
var licenseDetails = await client.GetLicenseDetailsAsync("license-id");

// Create a trial license
var trialLicense = await client.CreateTrialLicenseAsync(
    deviceID: "device-123",
    email: "user@example.com",
    ttlDays: 30,
    simplifyLicenseKeys: true
);

Environment Configuration

The client supports three environments:

• Env.local - http://localhost/Web.Service.Offlineer
• Env.test - https://api-test-offlineer.jtigernova.com
• Env.production - https://api-offlineer.jtigernova.com

Features

• Multi-App Support: Base architecture supports multiple Offlineer apps through inheritance
• Environment Management: Built-in support for local, test, and production environments
• License Management: Create, issue, revoke, and retrieve license details through Offlineer proxy
• Device Registration: Register and manage devices for licensed users
• JWT Authentication: Automatic token management with thread-safe operations
• Trial Licenses: Issue time-limited trial licenses
• Type-Safe: Strongly-typed request and response models
• Async/Await: Full async support with cancellation tokens

API Endpoints

System Management

• CheckAliveAsync() - Check if API is alive
• CheckApiStatusAsync() - Check License8 API status

License Management

• GetLicenseDetailsAsync(licenseID) - Get license details
• IssueLicenseTokenAsync(licenseID, trialEmail?) - Issue license token
• CreateNewLicenseAsync(...) - Create new license
• CreateTrialLicenseAsync(...) - Create trial license
• RevokeLicenseAsync(licenseID, reason) - Revoke license

Token Operations

• AuthenticateWithLicenseKeyAsync(licenseKey) - Authenticate with license key
• RenewTokenAsync() - Renew/refresh token
• ValidateTokenAsync() - Validate current token
• SetJwt(jwt) - Manually set JWT token
• ClearJwt() - Clear JWT token

Device Management

• ListRegisteredDevicesAsync() - List registered devices
• RegisterNewDeviceAsync(...) - Register new device
• DisableDeviceAsync(deviceIDHash) - Disable device

Architecture

The library uses an inheritance-based architecture for supporting multiple Offlineer apps:

Core Components

• OfflineerAppLicenseClient - Abstract base class containing all License8 API functionality (internal)
• SoloPDFLicenseClient - Public client for SoloPDF app, inherits from base class
• License8Models.cs - Request and response models for all API operations

Dependencies

• RestSharp (v112.1.0)
• .NET Standard 2.0

License

MIT