Apigen.TransIp.Client
6.53.2
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Apigen.TransIp.Client --version 6.53.2
NuGet\Install-Package Apigen.TransIp.Client -Version 6.53.2
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="Apigen.TransIp.Client" Version="6.53.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Apigen.TransIp.Client" Version="6.53.2" />
<PackageReference Include="Apigen.TransIp.Client" />
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 Apigen.TransIp.Client --version 6.53.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Apigen.TransIp.Client, 6.53.2"
#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 Apigen.TransIp.Client@6.53.2
#: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=Apigen.TransIp.Client&version=6.53.2
#tool nuget:?package=Apigen.TransIp.Client&version=6.53.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Apigen.TransIp
Generated C# client for the TransIP REST API v6.
Installation
dotnet add package Apigen.TransIp.Client
Quick start
using Apigen.TransIp.Client;
string privateKeyPem = File.ReadAllText("transip.pem");
// Singleton-friendly: returns a TransIpApiClient whose HttpClient
// automatically acquires & refreshes JWTs.
TransIpApiClient client = TransIpAuthTokenProvider.CreateClient(
login: "your-username",
privateKeyPem: privateKeyPem,
label: "my-app");
var domains = await client.Domains.ListAllDomainsAsync();
Custom HttpClient pipeline
TransIpTokenAccessor accessor = TransIpAuthTokenProvider.CreateAccessor(login, privateKeyPem);
HttpClient http = new(new TransIpBearerHandler(accessor, new HttpClientHandler()))
{
BaseAddress = new Uri("https://api.transip.nl/v6/"),
};
var client = new TransIpApiClient(http);
Bring your own token storage
TransIpTokenAccessor is a delegate — implement it to persist the JWT wherever
you like (file, database, Vault, etc.). Default storage is in-memory only.
With a pre-obtained Bearer token
var client = TransIpApiClient.WithBearer("eyJ0eXAi...");
Authentication options
CreateClient, CreateAccessor, and GetBearerTokenAsync accept:
login— your TransIP account nameprivateKeyPem— the PKCS#8 PEM key obtained from the control panellabel— token label (must be unique per active token; auto-generated if omitted)readOnly— request a read-only token (defaultfalse)expirationTime— e.g."30 minutes","1 hour","1 day"(default"1 day")globalKey— allow use from any IP address (defaultfalse)baseUrl— override the API base URLrefreshBefore— re-auth this far before expiry (default 5 minutes)
Versioning
Package versions follow the upstream API version: the major.minor matches
the TransIP API version, and the patch is our client revision. For example,
package 6.53.0 was built against API version 6.53.x.
License
MIT
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.