KKBOX.OpenAPI.Standard 1.0.1.5

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

// Install KKBOX.OpenAPI.Standard as a Cake Tool
#tool nuget:?package=KKBOX.OpenAPI.Standard&version=1.0.1.5

KKBOX OpenAPI SDK for .NET

SDK usage

Compatibility

  1. The SDK itself is supported Universal Windows Platform(Build 15063+) and .NET Framework 4.6.1+.
  2. It should be able to use with Visual Studio 2017.

Use Nuget to install the SDK

  • NuGet
  • .NET Standard 1.4, .NET Framework 4.5/6.1 and Universal Windows Platform.

Prepare client ID & client secret

Browse KKBOX Developer Website and create an developer account, then create an app to get the client ID and client secret.

Use the SDK

  • For Universal Windows Platform, need internet capability:
<Capabilities>
    <Capability Name="internetClient" />
</Capabilities>
  • Get access token:
// Request to get access token
var authResult = await KKBOXOAuth.SignInAsync(clientId, clientSecret);
string accessToken = authResult.Content.AccessToken;
  • Use KKBOX Open API:
KKBOXAPI openAPI = new KKBOXAPI();
// Must setting access token
openAPI.AccessToken = accessToken;
// Must setting user territory
OpenAPI.TerritoryType = TerritoryType.TW;

// example get album metadata
var album = await openAPI.GetAlbumAsync(albumId);
  • Reference Sample to learn how to use the SDK.

SDK document

Please browse Dotnet SDK document

SDK Development

Development Environment

  1. Below applies to those who wants to develop the SDK.
  2. If you were just using the SDK, please refer to previous parts.
  3. Install Visual Studio 2017 or latest version.
    • include Windows 10 (Build 15063+) SDK.
    • .NET Framework 4.6.1+.
    • Windows 10 (Build 15063+).

Develop the library

Fork the repository to develop, don't develop and custom class name on the repository. If you have any issue, please oepn issue

License

Copyright 2017 KKBOX Technologies Limited

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

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 net452 is compatible.  net46 was computed.  net461 is compatible.  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. 
Universal Windows Platform uap was computed.  uap10.0 is compatible. 
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
1.0.1.5 750 8/12/2019
1.0.1.3 985 1/29/2018

1.0.1.5: Support .net standard 2.0 and fixed some issues.