{"id":20710226,"url":"https://github.com/kkbox/openapi-dotnet","last_synced_at":"2025-04-23T05:09:10.918Z","repository":{"id":27710964,"uuid":"114972513","full_name":"KKBOX/OpenAPI-Dotnet","owner":"KKBOX","description":"The KKBOX Open API SDK for .Net.","archived":false,"fork":false,"pushed_at":"2022-07-22T18:31:42.000Z","size":381,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":22,"default_branch":"master","last_synced_at":"2025-04-23T05:09:02.945Z","etag":null,"topics":["kkbox","openapi"],"latest_commit_sha":null,"homepage":"https://developer.kkbox.com/","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KKBOX.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-21T06:46:14.000Z","updated_at":"2022-07-22T18:31:28.000Z","dependencies_parsed_at":"2022-09-20T16:42:40.762Z","dependency_job_id":null,"html_url":"https://github.com/KKBOX/OpenAPI-Dotnet","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KKBOX%2FOpenAPI-Dotnet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KKBOX%2FOpenAPI-Dotnet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KKBOX%2FOpenAPI-Dotnet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KKBOX%2FOpenAPI-Dotnet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KKBOX","download_url":"https://codeload.github.com/KKBOX/OpenAPI-Dotnet/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250372931,"owners_count":21419722,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kkbox","openapi"],"created_at":"2024-11-17T02:10:34.661Z","updated_at":"2025-04-23T05:09:10.892Z","avatar_url":"https://github.com/KKBOX.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# KKBOX OpenAPI SDK for .NET\n\n## SDK usage\n### Compatibility\n1. The SDK itself is supported Universal Windows Platform(Build 15063+) and .NET Framework 4.6.1+.\n1. It should be able to use with Visual Studio 2017.\n\n### Use Nuget to install the SDK\n- [![NuGet](https://img.shields.io/nuget/v/Nuget.Core.svg)](https://www.nuget.org/packages/KKBOX.OpenAPI.Standard/)\n- .NET Standard 2.0, .NET Framework 4.5/6.1 and Universal Windows Platform.\n\n### Prepare client ID \u0026 client secret\nBrowse [KKBOX Developer Website](https://developer.kkbox.com/) and create an developer account, then create an app to get the client ID and client secret.\n\n### Use the SDK\n- For Universal Windows Platform, need internet capability: \n\n```xml\n\u003cCapabilities\u003e\n    \u003cCapability Name=\"internetClient\" /\u003e\n\u003c/Capabilities\u003e\n```\n\n- Get access token: \n\n```csharp\n// Request to get access token\nvar authResult = await KKBOXOAuth.SignInAsync(clientId, clientSecret);\nstring accessToken = authResult.Content.AccessToken;\n```\n\n- Use KKBOX Open API:\n\n```csharp\nKKBOXAPI openAPI = new KKBOXAPI();\n// Must setting access token\nopenAPI.AccessToken = accessToken;\n// Must setting user territory\nOpenAPI.TerritoryType = TerritoryType.TW;\n\n// example get album metadata\nvar album = await openAPI.GetAlbumAsync(albumId);\n```\n\n- Reference [Sample](Sample/OpenAPI.App.Shared/MainPageViewModel.cs) to learn how to use the SDK.\n\n### SDK document\nPlease browse [Dotnet SDK document](Doc/Home.md)\n\n## SDK Development\n### Development Environment\n1. Below applies to those who wants to develop the SDK.\n1. If you were just using the SDK, please refer to previous parts.\n1. Install Visual Studio 2017 or latest version.\n   - include Windows 10 (Build 15063+) SDK.\n   - .NET Framework 4.6.1+.\n   - Windows 10 (Build 15063+).\n\n### Develop the library\nFork the repository to develop, don't develop and custom class name on the repository.\nIf you have any issue, please oepn [issue](https://github.com/KKBOX/OpenAPI-Dotnet/issues)。\n\n## License\nCopyright 2017 KKBOX Technologies Limited\n\n   Licensed under the Apache License, Version 2.0 (the \"License\");\n   you may not use this file except in compliance with the License.\n   You may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\n   Unless required by applicable law or agreed to in writing, software\n   distributed under the License is distributed on an \"AS IS\" BASIS,\n   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n   See the License for the specific language governing permissions and\n   limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkkbox%2Fopenapi-dotnet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkkbox%2Fopenapi-dotnet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkkbox%2Fopenapi-dotnet/lists"}