TipsTrade.UkVehicleData 8.0.1

TipsTrade.UkVehicleData

HTTP client and dependency-injection extensions for the UK Vehicle Data REST API.

Targets .NET Framework 4.8.1 and .NET 8.

The package major version follows the .NET target version (e.g. 8.x.x targets net8.0).

Installation

dotnet add package TipsTrade.UkVehicleData

Configuration

Implement ICredentialProvider

The client requires an API key that you obtain from the UK Vehicle Data panel.

using TipsTrade.UkVehicleData;
using TipsTrade.ApiClient.Core.Credential;

public class MyCredentialProvider : ICredentialProvider {
	public Task<ApiKeyCredential> GetCredentialAsync(string key, CancellationToken ct = default)
		=> Task.FromResult(new ApiKeyCredential("YOUR_API_KEY"));
}

Register with dependency injection

// Minimal registration
services.AddUkVehicleCheckClient<MyCredentialProvider>();

// With custom options (e.g. timeout)
services.AddUkVehicleCheckClient<MyCredentialProvider>(options => {
	options.Timeout = TimeSpan.FromSeconds(30);
});

// Optional: add response caching
services.AddUkVehicleCheckClientCache<MyCacheProvider>();

// Optional: add multi-tenant support
services.AddUkVehicleCheckClientTenants<MyTenantProvider>();

Available API Methods

All methods are async and accept an optional CancellationToken.

VRM = Vehicle Registration Mark (number plate). Spaces are stripped and the value is upper-cased automatically.
VIN = Vehicle Identification Number.

Usage Examples

Vehicle data by VRM

var response = await client.GetVehicleDataByVrmAsync("AB12CDE");

if (response.IsSuccess) {
	var reg = response.Response?.DataItems?.VehicleRegistration;
	Console.WriteLine($"{reg?.Make} {reg?.Model} ({reg?.YearOfManufacture})");

	// Helper extension methods
	string make  = response.Response!.DataItems!.GetCombinedMake();
	string model = response.Response!.DataItems!.GetCombinedModel();
}

Battery data by VIN

var response = await client.GetBatteryDataByVinAsync("WVWZZZAUZMW000001");

if (response.IsSuccess) {
	var batteries = response.Response?.DataItems?.BatteryDetails?.BatteryList;
	foreach (var battery in batteries ?? []) {
		Console.WriteLine(battery.PartNumber);
	}
}

Extensibility

ICacheProvider

Implement ICacheProvider to cache API responses and reduce repeated lookups for the same VRM/VIN.

public class MyCacheProvider : ICacheProvider {
	// IReadWriteCache<(string TenantId, string Key), T> implementation
}

Register with:

services.AddUkVehicleCheckClientCache<MyCacheProvider>();

ITenantProvider

Implement ITenantProvider to support multi-tenant scenarios.

public class MyTenantProvider : ITenantProvider {
	// IGetTenant implementation
}

Register with:

services.AddUkVehicleCheckClientTenants<MyTenantProvider>();

License

MIT — see LICENSE for details.

Source: https://github.com/tipstrade/TipsTrade.UkVehicleData