一、介紹
官方Demo
Apple Music API 背景
蘋果在 iOS 9.3 中推出全新 Apple Music API六孵,在更新后的iOS 9.3后椿浓,開發(fā)者可以利用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目錄和用戶的個人云庫中訪問有關媒體(如專輯,歌曲左腔,藝術家和播放列表)的信息唧垦。
如果用戶授權后,您還可以訪問或修改與該用戶關聯(lián)的數(shù)據(jù)液样。例如振亮,您可以在目錄和庫中找到用戶的音樂推薦或更改特定歌曲的評級。
Apple Music 是一項在許多國家/地區(qū)和語言中運營的全球服務鞭莽。但是坊秸,可用內容因地區(qū)而異。在Apple Music中澎怒,一個區(qū)域稱為店面褒搔,每個店面都會出售不同的音樂目錄。
在大多數(shù)情況下喷面,請求URL包括需要包含店面代碼星瘾,該代碼指定應將請求路由到哪個店面。在iOS應用程序中惧辈,您可以調用StoreKit以找出用戶在該設備上登錄的店面琳状。
Apple Music API 使用步驟
- 生成 Developer Token
- 獲取 User Token
- 獲取配置 Storefront
- 請求 API 獲取音樂信息
二、Apple Music Token 生成
(1)說明
在使用 Apple Music 的時候有一個參數(shù)十分重要盒齿,就是 Developer Token念逞,如何沒有它就沒法進行請求 Apple Music 接口獲取到數(shù)據(jù)困食。
另外針對請求 Apple Music 接口,需要在請求頭中添加 Developer Token 進行身份驗證翎承,對于個性化請求硕盹,還需要根據(jù) Developer Token 進行生成 User Token ,詳細如何設置后面會進行演示审洞。
(2)Developer Token 生成
步驟
- 建立 Music ID
- 建立 MusicKit 的 private key
- 建立 developer token
- 獲取 User Token
建立 Music ID
- 登錄 Apple 的開發(fā)網站
- 新建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. 安裝腳本執(zhí)行必備環(huán)境
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開發(fā)頁面的 Keys > All 頁面,可找到 key 的 key ID露乏。
(3)替換 teamId
- 在 Apple 開發(fā)頁面的 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
- 在終端中執(zhí)行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"];
- 注意事項:
在開發(fā) iOS App 時撤卢,developer token 最好通過服務器配置下載,不要在 App 里寫死厂画。否則如果我們我們生成新的 token的時候App 還要重新發(fā)版凸丸。
(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)
Get all storefronts - 獲取所有國家code
https://developer.apple.com/documentation/applemusicapi/get_all_storefronts
四唆阿、Apple Music API 使用
到現(xiàn)在我們已經獲取到了 Developer token 益涧,Storefronts,Usertoken驯鳖,接下來就可以根據(jù)官方API闲询,做需要的功能。
參考資料
https://developer.apple.com/documentation/applemusicapi#overview
https://developer.apple.com/videos/play/wwdc2017/502/?time=1264