KKBOX Open API 开发者 SDK for iOS/macOS/watchOS/tvOS

版权 © 2016-2020 KKBOX Technologies Limited

关于

SDK 有助于访问 KKBOX 的开放 API。您可以将 SDK 添加到您的 Xcode 项目中，并启动由 KKBOX 驱动的应用程序。您还可以获取有关歌曲轨道、专辑、艺术家和播放列表的信息。

此SDK使用Objective-C编程语言开发，但您仍可以将SDK桥接至Swift代码。您可以在各种Apple平台上使用SDK，例如iOS、macOS、watchOS和tvOS。

如果您正在寻找纯Swift SDK，请查看KKBOX Open API Swift SDK。

有关更多信息，请访问KKBOX开发者网站。

需求

SDK支持

• 📱iOS 7.x 或更高版本
• 💻macOS X 10.9 或更高版本
• ⌚️watchOS 2.x 或更高版本
• 📺tvOS 9.x 或更高版本

构建⚒

您需要最新的Xcode和macOS。建议使用Xcode 10和macOS 10.14 Mojave。

安装

Swift包管理器

您可以通过Swift包管理器（SPM）安装此库。只需将以下行添加到您的Package.swift文件中。

dependencies: [
    .package(url: "https://github.com/KKBOX/OpenAPI-ObjectiveC.git", from: "1.3.1"),
],

然后运行swift build。

或者，您可以在Xcode 11的“Swift Packages”菜单下使用“添加包依赖”命令。

CocoaPods

SDK支持CocoaPods。请将pod 'KKBOXOpenAPI'添加到您的Podfile中，然后运行pod install。

使用方法

要开始使用 SDK，您需要创建一个 KKBOXOpenAPI 的实例。

let API = KKBOXOpenAPI(clientID: "YOUR_CLIENT_ID", secret: "YOUR_CLIENT_SECRET")

然后，通过传递客户端凭据以请求实例获取访问令牌。

API.fetchAccessTokenByClientCredential { token, error in ... }

最后，您可以开始进行 API 调用。例如，您可以通过调用 'fetchTrack' 来获取歌曲跟踪的详细信息。

self.API.fetchTrack(withTrackID: trackID, territory: .taiwan) { track, error in ... }

您可以使用 Swift 或 Objective-C 编程语言开发应用程序，尽管这里只提供了 Swift 示例代码。

该项目包含一个演示项目。请使用 Xcode 打开位于 "ExampleIOS" 文件夹中的 KKBOXOpenAPI.xcodeproj，并尝试运行。

API 文档📖

• SDK 的文档可在https://kkbox.github.io/OpenAPI-ObjectiveC/ 查找。
• KKBOX 的 Open API 文档可在 https://developer.kkbox.com/ 查找。

许可证

版权所有 © 2016-2020 KKBOX 技术有限公司

遵循 Apache 许可协议（2.0版）("许可证")；除非您遵守许可证规定，否则不得使用此文件。您可以在以下位置获得许可证副本：

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或已以书面形式同意，否则根据许可证分发的软件按照“现状”提供，不提供任何明示或暗示的保证或条件。有关许可证的具体语言控制许可和限制条件，请参阅许可证。