iOS开发 - Apple Music API 使用

一、介绍

官方Demo

https://developer.apple.com/sample-code/wwdc/2017/Interacting-with-Apple-Music-Content.zip

Apple Music API 背景

苹果在 iOS 9.3 中推出全新 Apple Music API，在更新后的iOS 9.3后，开发者可以利用Apple Music API 使自己在应用中扩展支持Apple Music的更多功能的资源。

Apple Music API 介绍

官方文档：https://developer.apple.com/documentation/applemusicapi

Apple Music API 是属于一种 Web Services API，是MusicKit的Web服务部分。

使用 Apple Music API，可以在Apple Music目录和用户的个人云库中访问有关媒体（如专辑，歌曲，艺术家和播放列表）的信息。

如果用户授权后，您还可以访问或修改与该用户关联的数据。例如，您可以在目录和库中找到用户的音乐推荐或更改特定歌曲的评级。

Apple Music 是一项在许多国家/地区和语言中运营的全球服务。但是，可用内容因地区而异。在Apple Music中，一个区域称为店面，每个店面都会出售不同的音乐目录。

在大多数情况下，请求URL包括需要包含店面代码，该代码指定应将请求路由到哪个店面。在iOS应用程序中，您可以调用StoreKit以找出用户在该设备上登录的店面。

Apple Music API 使用步骤

生成 Developer Token
获取 User Token
获取配置 Storefront
请求 API 获取音乐信息

二、Apple Music Token 生成

（1）说明

在使用 Apple Music 的时候有一个参数十分重要，就是 Developer Token，如何没有它就没法进行请求 Apple Music 接口获取到数据。

另外针对请求 Apple Music 接口，需要在请求头中添加 Developer Token 进行身份验证，对于个性化请求，还需要根据 Developer Token 进行生成 User Token ，详细如何设置后面会进行演示。

（2）Developer Token 生成

步骤

建立 Music ID
建立 MusicKit 的 private key
建立 developer token
获取 User Token

建立 Music ID

新建Music ID

填写 Description 和 ID

建立 MusicKit 的 private key

点击 Keys - All，然后点击 + 号

输入Key 的名字，勾选Music Kit 。

点击右边的 Configure，选择此 key 对应的 music id

下载刚刚生成的Key （每次生成都只有一次下载机会，之后无法重新下载，所以要保存好下载的 key ）

下载的 key 是个后缀名为 p8 的文件

建立 developer token

1. 下载制作 developer token 需要的 python 脚本

地址：https://github.com/pelauimagineering/apple-music-token-generator

2. 安装脚本执行必备环境

sudo easy_install pip
sudo pip install pyjwt
sudo pip install cryptography

3. 编辑 music_token.py （配置过程）

（1）替换 secret ：

打开我们生成的 MusicKit private key，复制 private key 的字串，替换里面的 secret 为我们自己的 secret。

（2）替换 keyID

在 Apple开发页面的 Keys > All 页面，可找到 key 的 key ID。

（3）替换 teamId

在 Apple 开发页面的 Membership 页面，可找到 Team ID。

secret = """-----BEGIN PRIVATE KEY-----
MIGTAgEAMBMGByqGSM49AgEGCCqGSM49AwEHBHkwdwIBAQQgBJabyDbmG59WgHaL+QfFJkzlXWHubcadHhSO61K9CY6gCgYIKoZIzj0DAQehRANCAASNNOdHUZV9/Sgo4R+ulD1UX18ngMRCBlKecxU5EuRYQMyk7AulcXkWq8ZyjjmftmhpHQZBVEfyA+kOEm7ockU8
-----END PRIVATE KEY-----"""
keyId = "5Z9X3HX2RC"
teamId = "G4HL98LX6L"

（4）设置Token有效时间

date.time.timedelta(weeks=26) 这里为设置有效时间。

4. token 加密

生成 developer token，需要 alg，kid，iss，exp 和 iat。Apple 要求 alg 采用 ES256 加密，iat 決定 token 过期的时间，最长可设定 6 个月。
我们只要完成刚刚 secret，keyID 和 teamId 的设定，其它部分此 python script 都帮我們处理好了。

（5）生成 token

在终端中执行Python脚本：

python music_token.py

示例：

5. 代码中设置 Developer Token

此时已经获取到 Developer Token了，在 OC中如果用 AFN 设置如下：

AFJSONRequestSerializer *requestSerializer = [AFJSONRequestSerializer serializer];
[requestSerializer setValue:[NSString stringWithFormat:@"Bearer %@", API_TOKEN]
         forHTTPHeaderField:@"Authorization"];

注意事项：

在开发 iOS App 時，developer token 最好通过服务器配置下载，不要在 App 里写死。否则如果我们我们生成新的 token的时候App 还要重新发版。

（3）获取 User Token

生成步骤

设置 developer token
获取 User Token

设置 developer token

确保已经设置了developer token 在请求头里，这是必备的操作，如果 developer token 未设置，或者设置的有误那么请求就会提示拒绝访问。

获取 User Token

User Token 的获取方式有两种，分别对应：
- iOS 11 以及以上版本。
- iOS 11 以下的获取方式。

请求获取用户的 User Token 之前还需请求获取 Apple Music 访问权限。

（1）获取 Apple Music 访问权限

可以使用此方法请求用户允许您播放Apple Music曲目或向音乐库添加曲目等。
获取权限的方法：

[SKCloudServiceController requestAuthorization:^(SKCloudServiceAuthorizationStatus status) {
        
}];

（2）不同 OS 版本获取 User Token

使用 SKCloudServiceController 类的 requestUserTokenForDeveloperToken 实例方法。

SKCloudServiceController *skCloud = [[SKCloudServiceController alloc] init];
if (@available(iOS 11.0, *)) {
    [skCloud requestUserTokenForDeveloperToken:API_TOKEN completionHandler:^(NSString * _Nullable userToken, NSError * _Nullable error) {
        
    }];
}else{
    [skCloud requestPersonalizationTokenForClientToken:API_TOKEN withCompletionHandler:^(NSString * _Nullable personalizationToken, NSError * _Nullable error) {
        
    }];
}

（3）设置 User Token

在OC中用AFN 设置如下

AFJSONRequestSerializer *requestSerializer = [AFJSONRequestSerializer serializer];

[requestSerializer setValue:USER_TOKEN forHTTPHeaderField:@"Music-User-Token"];

三、Apple Music Storefront 获取

Apple Music Storefront 同样获取方式有两种，分别对应：
- iOS 11 以及以上版本。
- iOS 11 以下的获取方式。

（1）iOS 11 以及以上版本获取方式（确保已经设置正确 Developer Token）

SKCloudServiceController *cloud = [[SKCloudServiceController alloc] init];
[cloud requestStorefrontCountryCodeWithCompletionHandler:^(NSString * _Nullable storefrontCountryCode, NSError * _Nullable error) {
    
}];

（2）iOS 11 以下获取方式（确保已经设置 User Token）

请求接口 https://api.music.apple.com/v1/me/storefront
Get all storefronts - 获取所有国家code
https://developer.apple.com/documentation/applemusicapi/get_all_storefronts

四、Apple Music API 使用

到现在我们已经获取到了 Developer token ，Storefronts，Usertoken，接下来就可以根据官方API，做需要的功能。

参考资料

https://developer.apple.com/documentation/applemusicapi#overview
https://developer.apple.com/videos/play/wwdc2017/502/?time=1264

https://medium.com/%E5%BD%BC%E5%BE%97%E6%BD%98%E7%9A%84-swift-ios-app-%E9%96%8B%E7%99%BC%E5%95%8F%E9%A1%8C%E8%A7%A3%E7%AD%94%E9%9B%86/%E7%94%9F%E6%88%90-musickit-app-%E9%9C%80%E8%A6%81%E7%9A%84-developer-token-1e4195f517e0