BetaSeries.Net
0.0.1
dotnet add package BetaSeries.Net --version 0.0.1
NuGet\Install-Package BetaSeries.Net -Version 0.0.1
<PackageReference Include="BetaSeries.Net" Version="0.0.1" />
paket add BetaSeries.Net --version 0.0.1
#r "nuget: BetaSeries.Net, 0.0.1"
// Install BetaSeries.Net as a Cake Addin #addin nuget:?package=BetaSeries.Net&version=0.0.1 // Install BetaSeries.Net as a Cake Tool #tool nuget:?package=BetaSeries.Net&version=0.0.1
BetaSeries.Net
C# Wrapper to BetaSeries Rest API
Contribution
If you find this package useful, please make a gift on Paypal : https://www.paypal.me/roddone
Pre-requisites
You need to get a DeveloperKey to use the API. first, go to BetaSeries API to ask a key, then you can register the key in the application :
RestHelper.RegisterDeveloperKey("my-developer-key");
Concept
This wrapper is designed to be ultra generic and to have the less code as possible. To do that a lot of types used in the solution are dynamic. In a future releases, I will try to implement custom methods with strong-typed return types and inputs. But for now this API works and can be used with any method of the API. Have a look on BetaSeries API to know how to use the different API methods !
How to use it
BetaSeries API is based on a REST API, this package provides classes to access each entity of the API. The Rest API is based on a two levels URL (example: SHOWS/DISPLAY), this API consists in nested classes that matches the API urls and provide Delete, Get, Post and Put methods. example: for SHOWS/DISPLAY, I will use :
SHOWS.Display.[Delete|Get|Post|Put]();
All the Urls works the same way, all you have to do is to have a look on BetaSeries API to find the Urls you need to call.
Return types
All methods returns (for now) a dynamic object that contains the API response. Feel free to implement strong-typed response types if you need to use real return types.
Input types
All methods accepts a dynamic object as parameter. For Get and Delete operations, this object is passed as query-string parameters. For Post and Put operations, this object is passed in the body of the request.
Feel free to implement custom methods with strong-typed parameters for all the objects.
Authentication
If you use Api methods that needs to ben authenticated, you have to use :
MEMBERS.Auth.Post(new {
login = "my-login",
Password = RestHelper.HashPassword("my-password")
});
MEMBERS.Auth returns an object that contains the token to use. You can now save it with RestHelper.RegisterUserToken(auth.token.ToString());
to use it automatically in all further calls.
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 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 | net45 is compatible. net451 was computed. net452 was computed. net46 is compatible. net461 was computed. net462 was computed. net463 was computed. net47 is compatible. 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. |
-
.NETFramework 4.5
- Microsoft.AspNet.WebApi.Client (>= 5.2.4)
- Microsoft.CSharp (>= 4.4.1)
- Newtonsoft.Json (>= 11.0.2)
- System.Net.Http (>= 4.3.3)
-
.NETFramework 4.6
- Microsoft.AspNet.WebApi.Client (>= 5.2.4)
- Microsoft.CSharp (>= 4.4.1)
- Newtonsoft.Json (>= 11.0.2)
- System.Net.Http (>= 4.3.3)
-
.NETFramework 4.7
- Microsoft.AspNet.WebApi.Client (>= 5.2.4)
- Microsoft.CSharp (>= 4.4.1)
- Newtonsoft.Json (>= 11.0.2)
- System.Net.Http (>= 4.3.3)
-
.NETStandard 2.0
- Microsoft.AspNet.WebApi.Client (>= 5.2.4)
- Microsoft.CSharp (>= 4.4.1)
- Newtonsoft.Json (>= 11.0.2)
- System.Net.Http (>= 4.3.3)
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 |
---|---|---|
0.0.1 | 1,173 | 4/22/2018 |
initial version