{"id":20710221,"url":"https://github.com/kkbox/openapi-objectivec","last_synced_at":"2025-04-23T04:53:40.455Z","repository":{"id":56917282,"uuid":"115353578","full_name":"KKBOX/OpenAPI-ObjectiveC","owner":"KKBOX","description":"KKBOX Open API Developer SDK for iOS/macOS/watchOS/tvOS","archived":false,"fork":false,"pushed_at":"2020-02-07T03:51:50.000Z","size":1439,"stargazers_count":19,"open_issues_count":0,"forks_count":3,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-23T04:53:32.967Z","etag":null,"topics":["cocoapods","ios","kkbox","macos","objc","openapi","sdk","tvos","watchos","xcode"],"latest_commit_sha":null,"homepage":"https://developer.kkbox.com/","language":"Objective-C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","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":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-25T17:27:52.000Z","updated_at":"2020-02-27T15:05:37.000Z","dependencies_parsed_at":"2022-08-20T21:20:28.775Z","dependency_job_id":null,"html_url":"https://github.com/KKBOX/OpenAPI-ObjectiveC","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KKBOX%2FOpenAPI-ObjectiveC","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KKBOX%2FOpenAPI-ObjectiveC/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KKBOX%2FOpenAPI-ObjectiveC/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KKBOX%2FOpenAPI-ObjectiveC/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KKBOX","download_url":"https://codeload.github.com/KKBOX/OpenAPI-ObjectiveC/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250372946,"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":["cocoapods","ios","kkbox","macos","objc","openapi","sdk","tvos","watchos","xcode"],"created_at":"2024-11-17T02:10:32.778Z","updated_at":"2025-04-23T04:53:40.432Z","avatar_url":"https://github.com/KKBOX.png","language":"Objective-C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# KKBOX Open API Developer SDK for iOS/macOS/watchOS/tvOS\n\nCopyright © 2016-2020 KKBOX Technologies Limited\n\n[![Actions Status](https://github.com/KKBOX/OpenAPI-ObjectiveC/workflows/Build/badge.svg)](https://github.com/KKBOX/OpenAPI-ObjectiveC/actions)\u0026nbsp;\n[![build](https://api.travis-ci.org/KKBOX/OpenAPI-ObjectiveC.svg)](https://travis-ci.org/KKBOX/OpenAPI-ObjectiveC)\u0026nbsp;\n[![License Apache](https://img.shields.io/badge/license-Apache-green.svg?style=flat)](https://raw.githubusercontent.com/KKBOX/OpenAPI-ObjectiveC/master/LICENSE)\u0026nbsp;\n[![CocoaPods](http://img.shields.io/cocoapods/v/KKBOXOpenAPI.svg?style=flat)](http://cocoapods.org/pods/KKBOXOpenAPI)\u0026nbsp;\n[![Support](https://img.shields.io/badge/macOS-10.9-blue.svg)](https://www.apple.com/tw/macos)\u0026nbsp;\n[![Support](https://img.shields.io/badge/iOS-7-blue.svg)](https://www.apple.com/tw/ios)\u0026nbsp;\n[![Support](https://img.shields.io/badge/watchOS-2-blue.svg)](https://www.apple.com/tw/watchos)\u0026nbsp;\n[![Support](https://img.shields.io/badge/tvOS-9-blue.svg)](https://www.apple.com/tw/tvos)\u0026nbsp;\n\n## About\n\nThe SDK helps to access KKBOX's Open API. You can easily add the SDK to your\nXcode project, and start an app powered by KKBOX. You may obtain information\nabout song tracks, albums, artists and playlists as well.\n\nThe SDK is developed in Objective-C programing language, but you can still\nbridge the SDK to your Swift code. You can use the SDK on various Apple\nplatforms such as iOS, macOS, watchOS and tvOS.\n\nIf you are looking for a pure Swift SDK, please take a look at\n[KKBOX Open API Swift SDK](https://github.com/KKBOX/OpenAPI-Swift).\n\nFor further information, please visit\n[KKBOX Developer Site](https://developer.kkbox.com).\n\n## Requirement\n\nThe SDK supports\n\n- 📱 iOS 7.x or above\n- 💻 Mac OS X 10.9 or above\n- ⌚️ watchOS 2.x or above\n- 📺 tvOS 9.x or above\n\n## Build ⚒\n\nYou need the latest Xcode and macOS. Xcode 10 and macOS 10.14 Mojave are\nrecommended.\n\n## Installation\n\n### Swift Package Manager\n\nYou can install the library via Swift Package Manager (SPM). Just add the\nfollowing lines to your Package.swift file.\n\n``` swift\ndependencies: [\n    .package(url: \"https://github.com/KKBOX/OpenAPI-ObjectiveC.git\", from: \"1.3.1\"),\n],\n```\n\nThen run swift build.\n\nOr, you can use the \"Add Package Dependency\" command under the \"Swift Packages\"\nmenu in Xcode 11.\n\n### CocoaPods\n\nThe SDK supports CocoaPods. Please add `pod 'KKBOXOpenAPI'`\nto your Podfile, and then call `pod install`.\n\n## Usage\n\nTo start using the SDK, you need to create an instance of KKBOXOpenAPI.\n\n```swift\nlet API = KKBOXOpenAPI(clientID: \"YOUR_CLIENT_ID\", secret: \"YOUR_CLIENT_SECRET\")\n```\n\nThen, ask the instance to fetch an access token by passing a client credential.\n\n```swift\nAPI.fetchAccessTokenByClientCredential { token, error in ... }\n```\n\nFinally, you can start to do the API calls. For example, you can fetch the details\nof a song track by calling 'fetchTrack'.\n\n```swift\nself.API.fetchTrack(withTrackID: trackID, territory: .taiwan) { track, error in ... }\n```\n\nYou can develop your app using the SDK with Swift or Objective-C programming\nlanguage, although we have only Swift sample code here.\n\nThe project contains a demo project. Please open KKBOXOpenAPI.xcodeproj\nlocated in the \"ExampleIOS\" folder with Xcode and give it a try.\n\n## API Documentation 📖\n\n- Documentation for the SDK is available at https://kkbox.github.io/OpenAPI-ObjectiveC/ .\n- KKBOX's Open API documentation is available at https://developer.kkbox.com/ .\n\n## License\n\nCopyright 2016-2020 KKBOX Technologies Limited\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkkbox%2Fopenapi-objectivec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkkbox%2Fopenapi-objectivec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkkbox%2Fopenapi-objectivec/lists"}