BrandonPowers.PortalAPI
1.2.1
dotnet add package BrandonPowers.PortalAPI --version 1.2.1
NuGet\Install-Package BrandonPowers.PortalAPI -Version 1.2.1
<PackageReference Include="BrandonPowers.PortalAPI" Version="1.2.1" />
<PackageVersion Include="BrandonPowers.PortalAPI" Version="1.2.1" />
<PackageReference Include="BrandonPowers.PortalAPI" />
paket add BrandonPowers.PortalAPI --version 1.2.1
#r "nuget: BrandonPowers.PortalAPI, 1.2.1"
#:package BrandonPowers.PortalAPI@1.2.1
#addin nuget:?package=BrandonPowers.PortalAPI&version=1.2.1
#tool nuget:?package=BrandonPowers.PortalAPI&version=1.2.1
PortalAPI
A lightweight C# client library for interacting with Huron Portal WebServices APIs.
Features
- Simple wrapper around Portal WebServices API endpoints
- Basic Authentication support
- JSON deserialization into strongly typed objects
- Compatible with:
- .NET Standard 2.0
- .NET 8.0+
Installation
Install from NuGet:
dotnet add package BrandonPowers.PortalAPI
Or through the NuGet Package Manager:
Install-Package BrandonPowers.PortalAPI
Usage
Example
using PortalAPI;
using System;
using System.Text;
string domain = "example.huronportal.com";
string apiPath = "MyAPI";
string credential = Convert.ToBase64String(
Encoding.UTF8.GetBytes("username:password")
);
HuronAPIData data = HuronAPI.GetAPIData(
domain,
apiPath,
credential
);
Authentication
PortalAPI uses HTTP Basic Authentication.
Credentials must be passed as a Base64-encoded string in the format:
username:password
Example:
string credential = Convert.ToBase64String(
Encoding.UTF8.GetBytes("username:password")
);
API Endpoint Format
PortalAPI automatically builds requests using the following format:
https://{domain}/api/click/datamanagement/{apiPath}
Example:
https://example.huronportal.com/api/click/datamanagement/MyAPI
Requirements
- .NET Standard 2.0 or later
- .NET 8.0 or later
Notes
This library is intended to simplify interactions with Huron Portal WebServices APIs.
This is an unofficial client library and is not affiliated with or endorsed by Huron.
License
MIT License
| Product | Versions 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 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 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. |
-
.NETStandard 2.0
- System.Text.Json (>= 8.0.6)
-
net8.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.