iOS開發(fā) - Apple Music API 使用

一、介紹

官方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 使用步驟

  1. 生成 Developer Token
  2. 獲取 User Token
  3. 獲取配置 Storefront
  4. 請求 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 生成
步驟
  1. 建立 Music ID
  2. 建立 MusicKit 的 private key
  3. 建立 developer token
  4. 獲取 User Token
建立 Music ID
  1. 登錄 Apple 的開發(fā)網站
  1. 新建Music ID
  1. 填寫 Description 和 ID
建立 MusicKit 的 private key
  1. 點擊 Keys - All莱睁,然后點擊 + 號
  1. 輸入Key 的名字,勾選Music Kit 芒澜。
  1. 點擊右邊的 Configure,選擇此 key 對應的 music id
  1. 下載剛剛生成的Key (每次生成都只有一次下載機會创淡,之后無法重新下載痴晦,所以要保存好下載的 key )
  1. 下載的 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

生成步驟
  1. 設置 developer token
  2. 獲取 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)


四唆阿、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

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

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末浅辙,一起剝皮案震驚了整個濱河市扭弧,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌记舆,老刑警劉巖鸽捻,帶你破解...
    沈念sama閱讀 206,311評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異氨淌,居然都是意外死亡泊愧,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,339評論 2 382
  • 文/潘曉璐 我一進店門删咱,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人豪筝,你說我怎么就攤上這事痰滋《嗤В” “怎么了挽拂?”我有些...
    開封第一講書人閱讀 152,671評論 0 342
  • 文/不壞的土叔 我叫張陵镇饮,是天一觀的道長嘶是。 經常有香客問我酝蜒,道長蛙紫,這世上最難降的妖魔是什么唁毒? 我笑而不...
    開封第一講書人閱讀 55,252評論 1 279
  • 正文 為了忘掉前任猪瞬,我火速辦了婚禮,結果婚禮上咖驮,老公的妹妹穿的比我還像新娘。我一直安慰自己训枢,他們只是感情好托修,可當我...
    茶點故事閱讀 64,253評論 5 371
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著恒界,像睡著了一般睦刃。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上仗处,一...
    開封第一講書人閱讀 49,031評論 1 285
  • 那天眯勾,我揣著相機與錄音,去河邊找鬼婆誓。 笑死吃环,一個胖子當著我的面吹牛,可吹牛的內容都是我干的洋幻。 我是一名探鬼主播郁轻,決...
    沈念sama閱讀 38,340評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了好唯?” 一聲冷哼從身側響起竭沫,我...
    開封第一講書人閱讀 36,973評論 0 259
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎骑篙,沒想到半個月后蜕提,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經...
    沈念sama閱讀 43,466評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡靶端,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 35,937評論 2 323
  • 正文 我和宋清朗相戀三年谎势,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片杨名。...
    茶點故事閱讀 38,039評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡脏榆,死狀恐怖,靈堂內的尸體忽然破棺而出台谍,到底是詐尸還是另有隱情须喂,我是刑警寧澤,帶...
    沈念sama閱讀 33,701評論 4 323
  • 正文 年R本政府宣布趁蕊,位于F島的核電站坞生,受9級特大地震影響,放射性物質發(fā)生泄漏掷伙。R本人自食惡果不足惜恨胚,卻給世界環(huán)境...
    茶點故事閱讀 39,254評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望炎咖。 院中可真熱鬧,春花似錦寒波、人聲如沸乘盼。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,259評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽绸栅。三九已至,卻和暖如春页屠,著一層夾襖步出監(jiān)牢的瞬間粹胯,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,485評論 1 262
  • 我被黑心中介騙來泰國打工辰企, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留风纠,地道東北人。 一個月前我還...
    沈念sama閱讀 45,497評論 2 354
  • 正文 我出身青樓牢贸,卻偏偏與公主長得像竹观,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 42,786評論 2 345

推薦閱讀更多精彩內容