GLAPI.NET 1.1.12

GLAPI.NET

A .NET client library for the GLPI API, supporting both the legacy REST API and the new high-level OAuth 2.0 API.

Features

• ✅ Support for Legacy REST API (App-Token and Session-Token authentication)
• ✅ Support for High-Level API (OAuth 2.0 authentication)
• ✅ Multiple authentication methods:
  • Legacy API: Username/Password or User Token
  • High-Level API: Password Grant, Authorization Code Grant, or Client Credentials Grant
• ✅ Comprehensive test coverage
• ✅ Built with .NET 9.0

Installation

dotnet add package GLAPI.NET

Quick Start

Using the Legacy API

using GLAPI.NET;
using GLAPI.NET.Configuration;

// Register services
var services = new ServiceCollection();
services.AddGlpiApi();
var serviceProvider = services.BuildServiceProvider();

// Create client factory
var factory = serviceProvider.GetRequiredService<GlpiClientFactory>();

// Configure Legacy API
var legacyConfig = new LegacyApiConfiguration
{
    BaseUrl = "https://glpi.example.com",
    AppToken = "your-app-token",
    Username = "your-username",
    Password = "your-password"
    // OR use UserToken instead:
    // UserToken = "your-user-token"
};

// Create and authenticate
var legacyClient = factory.CreateLegacyClient(legacyConfig);
var authenticated = await legacyClient.AuthenticateAsync();

if (authenticated)
{
    Console.WriteLine($"Session Token: {legacyClient.Configuration.SessionToken}");
}

Using the High-Level API (OAuth 2.0)

using GLAPI.NET;
using GLAPI.NET.Configuration;

// Register services
var services = new ServiceCollection();
services.AddGlpiApi();
var serviceProvider = services.BuildServiceProvider();

// Create client factory
var factory = serviceProvider.GetRequiredService<GlpiClientFactory>();

// Configure High-Level API with Password Grant
var highLevelConfig = new HighLevelApiConfiguration
{
    BaseUrl = "https://glpi.example.com",
    ClientId = "your-client-id",
    ClientSecret = "your-client-secret",
    GrantType = "password",
    Username = "your-username",
    Password = "your-password"
};

// Create and authenticate
var highLevelClient = factory.CreateHighLevelClient(highLevelConfig);
var authenticated = await highLevelClient.AuthenticateAsync();

if (authenticated)
{
    Console.WriteLine($"Access Token: {highLevelClient.Configuration.AccessToken}");
    Console.WriteLine($"Token Expires At: {highLevelClient.Configuration.TokenExpiresAt}");
}

Configuration Options

Legacy API Configuration

High-Level API Configuration

Grant Types

Password Grant

Use username and password directly:

var config = new HighLevelApiConfiguration
{
    BaseUrl = "https://glpi.example.com",
    ClientId = "your-client-id",
    ClientSecret = "your-client-secret",
    GrantType = "password",
    Username = "your-username",
    Password = "your-password"
};

Client Credentials Grant

For machine-to-machine authentication:

var config = new HighLevelApiConfiguration
{
    BaseUrl = "https://glpi.example.com",
    ClientId = "your-client-id",
    ClientSecret = "your-client-secret",
    GrantType = "client_credentials"
};

Authorization Code Grant

For interactive authentication flows:

var config = new HighLevelApiConfiguration
{
    BaseUrl = "https://glpi.example.com",
    ClientId = "your-client-id",
    ClientSecret = "your-client-secret",
    GrantType = "authorization_code",
    AuthorizationCode = "authorization-code-from-oauth-flow",
    RedirectUri = "https://your-app.com/callback"
};

Token Management

Checking Token Expiration (High-Level API)

var authenticator = new HighLevelApiAuthenticator(httpClient);
if (authenticator.IsTokenExpired(config, bufferSeconds: 60))
{
    // Token is expired or about to expire, refresh it
    await authenticator.RefreshTokenAsync(config);
}

Refreshing Tokens (High-Level API)

var authenticator = new HighLevelApiAuthenticator(httpClient);
var refreshed = await authenticator.RefreshTokenAsync(config);
if (refreshed)
{
    Console.WriteLine("Token refreshed successfully");
}

Killing Sessions (Legacy API)

var authenticator = new LegacyApiAuthenticator(httpClient);
var killed = await authenticator.KillSessionAsync(config);
if (killed)
{
    Console.WriteLine("Session killed successfully");
}

Testing

The library includes comprehensive unit tests and integration test support. To run the tests:

# Run all tests
dotnet test

# Run only unit tests (skip integration tests)
dotnet test --filter "Category!=Integration"

# Run only integration tests (requires GLPI instance configuration)
dotnet test --filter "Category=Integration"

Testing Against Your GLPI Instance

For testing against a real GLPI instance, see TESTING.md for detailed instructions on:

• Setting up credentials using environment variables
• Using .NET User Secrets for local development
• Running integration tests
• CI/CD integration examples

Building

dotnet build

Requirements

• .NET 9.0 or later

License

[Specify your license here]

Contributing

[Specify contribution guidelines here]