https://github.com/jkamsker/shlink-dotnet

A client library to interface with shlink.io
https://github.com/jkamsker/shlink-dotnet

csharp dotnet dotnet-core dotnet-standard dotnetcore s shlink url-shortener

Last synced: about 1 year ago
JSON representation

A client library to interface with shlink.io

• Host: GitHub
• URL: https://github.com/jkamsker/shlink-dotnet
• Owner: JKamsker
• License: mit
• Created: 2022-10-16T21:27:46.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-10-31T22:43:17.000Z (over 3 years ago)
• Last Synced: 2024-10-01T07:24:58.529Z (over 1 year ago)
• Topics: csharp, dotnet, dotnet-core, dotnet-standard, dotnetcore, s, shlink, url-shortener
• Language: C#
• Homepage:
• Size: 60.5 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          


  

    

      

      

    

    
Shlink .NET


  



[![NuGet version (ShlinkDotnet)](https://img.shields.io/nuget/v/ShlinkDotnet.svg?style=flat-square)](https://www.nuget.org/packages/ShlinkDotnet)

[![Nuget](https://img.shields.io/nuget/dt/ShlinkDotnet)](https://www.nuget.org/packages/ShlinkDotnet)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/JKamsker/shlink-dotnet/.NET)](https://github.com/JKamsker/shlink-dotnet/actions)

[![GitHub license](https://img.shields.io/github/license/JKamsker/shlink-dotnet)](https://github.com/JKamsker/shlink-dotnet/blob/master/LICENSE.txt)

[![PR](https://img.shields.io/badge/PR-Welcome-blue)](https://github.com/JKamsker/shlink-dotnet/pulls)

An API client for [shlink.io](https://github.com/shlinkio/shlink).

# How to use

[Example console app using DI](https://github.com/JKamsker/shlink-dotnet/blob/master/examples/ShlinkDotnet.Console/Program.cs)

## Basic sample:

Initialization:

```csharp

var restClient = ShlinkRestClient.Create("https://sh.link.cf", "1b7f1396-0c14-48ea-b581-07c2bf229ca1");

var apiClient = new ShlinkApiClient(restClient);

```

Enumerating through all shorted links:

```csharp

await foreach (var it in apiClient.EnumerateShortUrls())

{

    Console.WriteLine($"{it.ShortCode}: {it.LongUrl}");

}

```

Creating a new shortlink:

````csharp

var res = await apiClient.CreateOrUpdateAsync(new CreateShortUrlWithSlugRequest

{

    LongUrl = "https://www.google.at",

    ShortCode = "google"

});

````



Made with ♥ in Austria