dotnet add package Ungerboeck.Api.Sdk --version                
NuGet\Install-Package Ungerboeck.Api.Sdk -Version                
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="Ungerboeck.Api.Sdk" Version="" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Ungerboeck.Api.Sdk --version                
#r "nuget: Ungerboeck.Api.Sdk,"                
#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.
// Install Ungerboeck.Api.Sdk as a Cake Addin
#addin nuget:?package=Ungerboeck.Api.Sdk&version=

// Install Ungerboeck.Api.Sdk as a Cake Tool
#tool nuget:?package=Ungerboeck.Api.Sdk&version=                

SDK for the Ungerboeck API

You found the code tools for the Ungerboeck API! This is the main SDK package you probably want to get started quickly on the Ungerboeck API.

Getting Started

If you are looking to get going as fast as possible, here are step by step instructions.

Find and download your Ungerboeck version on the examples page. For example, Ungerboeck .98 would use the 98 example project.

Navigate to StartHere/Program.cs. Fill in the values at the top of Main() in relation to your Ungerboeck URL and your API User values (Found in Ungerboeck → Main Menu → Api Users).

After that, running the program should return an Account name.

Ungerboeck.Api.Sdk (Formerly Ungerboeck209XSDKWrapper/UngerboeckSDKWrapper)

Contains pre-made wrapper calls to quickly get your client connected to the Ungerboeck API. This coexists on Github to allow you to see the code.
Find the nuget package here.

Ungerboeck.Api.Models (Formerly Ungerboeck209XSDK/UngerboeckSDKPackage)

This contains pre-made models and constants to help your client code. It only lives here.
Find the nuget package here.


Find examples here.

This class library shows how to use every endpoint programmatically, including specific scenarios and comments giving tips. After downloading the project, you can surf the code to find the method you need. Also, please ensure your Visual Studio is set up to download Nuget Packages (Visual Studio->Options->Nuget Package Manager-> General → Ensure these are checked: "Allow NuGet to download missing packages" and "Automatically check for missing packages during build in Visual Studio"). You can make a simple app to call the examples to see how they work.

At any time, you can see the matching Ungerboeck version of Ungerboeck.Api.Models or Ungerboeck.Api.Sdk by going to the nuget package version. Match the second version value to your Ungerboeck version (ex: 1.98 matches Ungerboeck version .98). It's recommended to be on the latest SDK for your Ungerboeck version, as the SDK is always backwards compatible, but later versions always contain more.

A related tip about upgrading the SDK: The Ungerboeck.Api.Models and Ungerboeck.Api.Sdk packages are designed to be forwards compatible. Upgrading from nuget to keep up with you Ungerboeck version isn't necessary. You typically only upgrade to take advantage of new features.

More Info

More infomration can be found in our knowledgebase.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated 620 5/24/2024 92 5/29/2024 461 3/8/2024 122 3/8/2024 4,239 11/29/2023 92 11/29/2023 118 3/11/2024 108 11/29/2023 74 11/29/2023 109 11/29/2023 105 11/29/2023 110 11/29/2023 1,645 8/11/2023 1,217 3/31/2023 185 3/31/2023 99 3/13/2024 106 3/12/2024 87 3/12/2024 81 3/12/2024 99 3/12/2024 189 8/11/2023 3,441 10/7/2022 375 10/7/2022 3,298 4/14/2022 469 4/14/2022