TipsTrade.VCheck
8.0.1
.NET 8.0
This package targets .NET 8.0. The package is compatible with this framework or higher.
.NET Framework 4.8.1
This package targets .NET Framework 4.8.1. The package is compatible with this framework or higher.
dotnet add package TipsTrade.VCheck --version 8.0.1
NuGet\Install-Package TipsTrade.VCheck -Version 8.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="TipsTrade.VCheck" Version="8.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="TipsTrade.VCheck" Version="8.0.1" />
<PackageReference Include="TipsTrade.VCheck" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add TipsTrade.VCheck --version 8.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: TipsTrade.VCheck, 8.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package TipsTrade.VCheck@8.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=TipsTrade.VCheck&version=8.0.1
#tool nuget:?package=TipsTrade.VCheck&version=8.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
TipsTrade.VCheck
A .NET client library for querying the VCheck REST API, providing strongly typed access to vehicle check reports.
The package major version follows the .NET target version (e.g. 8.x.x targets net8.0).
Installation
dotnet add package TipsTrade.VCheck
Getting Started
1. Implement ICredentialProvider
You must implement ICredentialProvider to supply an API key to the client:
using TipsTrade.VCheck;
public class MyCredentialProvider : ICredentialProvider {
public Task<ApiKeyCredential> GetCredentialAsync(string key, CancellationToken cancellationToken = default) {
return Task.FromResult(new ApiKeyCredential("your-api-key"));
}
}
2. Register Services
Use the provided extension methods to register the client with the .NET dependency injection container:
services.AddVCheckClient<MyCredentialProvider>(options => {
options.Timeout = TimeSpan.FromSeconds(30);
});
// Optional: add caching support
services.AddVCheckClientCache<MyCacheProvider>();
// Optional: add multi-tenant support
services.AddVCheckClientTenants<MyTenantProvider>();
3. Use the Client
Inject VCheckClient and call the API:
public class MyService(VCheckClient client) {
public async Task<Report?> GetReportAsync(string vrm) {
return await client.CreateReportByVrmAsync(vrm, CheckType.Full);
}
public async Task<Report> ViewExistingReportAsync(string reference) {
return await client.ViewReportAsync(reference);
}
}
Check Types
| Value | Description |
|---|---|
CheckType.Initial |
An initial check |
CheckType.Basic |
A basic check |
CheckType.Full |
A full check |
API Methods
| Method | Description |
|---|---|
CreateReportByVrmAsync(vrm, checkType) |
Creates a new report by vehicle registration mark (VRM) |
CreateReportByVinAsync(vin, checkType) |
Creates a new report by vehicle identification number (VIN) |
ViewReportAsync(reference) |
Views an existing report by its unique reference |
Optional Providers
| Interface | Description |
|---|---|
ICredentialProvider |
Required. Supplies the API key for authentication |
ICacheProvider |
Optional. Caches API responses keyed by (TenantId, Key) |
ITenantProvider |
Optional. Resolves the current tenant ID for multi-tenant scenarios |
Targets
Targets net8 and net481 (.NET Framework 4.8.1).
License
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Framework | net481 is compatible. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETFramework 4.8.1
- Microsoft.Extensions.DependencyInjection (>= 8.0.1)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Options (>= 8.0.2)
- RestSharp (>= 114.0.0)
- System.Net.Http (>= 4.3.4)
- TipsTrade.ApiClient.Core (>= 8.0.0)
- TipsTrade.VCheck.Model (>= 8.0.1)
-
net8.0
- Microsoft.Extensions.DependencyInjection (>= 8.0.1)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Options (>= 8.0.2)
- RestSharp (>= 114.0.0)
- System.Net.Http (>= 4.3.4)
- TipsTrade.ApiClient.Core (>= 8.0.0)
- TipsTrade.VCheck.Model (>= 8.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.