2013-03-15 55 views
0

我目前正在啓動一個使用此API的項目guitarparty。問題是我不知道如何使用它。不明白如何使用此api

例如,該行

curl -H 'Guitarparty-Api-Key: {API_KEY}' http://api.guitarparty.com/v2/songbooks/ 

我甚至不知道在哪裏,我想將它放置。有人可以展示如何使用它的例子嗎?就像,只是要求一首歌。

該API看起來很簡單。問題是我不知道如何開始。謝謝。

api文檔非常短,但我不明白從哪裏開始。

http://www.guitarparty.com/developers/api-docs/api-resources/songs/#available-song-methods

+1

祈禱有API文檔,並閱讀它們。 ['httpie'](https://github.com/jkbr/httpie)是命令行HTTP請求的朋友。 – 2013-03-15 22:05:04

回答

1

捲曲器是與HTTP和類似的協議工作的命令行工具。你可以在這裏下載:http://curl.haxx.se

這行代碼是爲了在一個安裝了curl的系統上輸入一個命令行,也許是在類似Linux的系統上。您可能想要下載curl並嘗試跟隨該示例。

但是,這樣的API的美妙之處在於,您不需要使用任何特定的工具 - 只要您可以設置HTTP標頭值,您就可以使用任何您想要的工具。許多不同的工具和模塊可以發出HTTP請求。

您必須做的第一件事是在GuitarParty網站上獲取API密鑰。這是識別您的應用程序的關鍵,並且可能對例如你可以運行多少個查詢。沒有人,你將不被允許使用API​​。你的意思是用一個實際的API密鑰替換上面的「{API_KEY}」。

查詢(從文件)的一個例子是:

curl -H 'Guitarparty-Api-Key: {API_KEY}' http://api.guitarparty.com/v2/songs/?query=Jolene 

這是怎麼回事是捲曲被用於製造通過HTTP正常GET請求。這是您點擊鏈接時瀏覽器通常爲您提供的請求。該網址是「http://api.guitarparty.com/v2/songs/?query=Jolene」 - 這是您要修改以搜索除「Jolene」以外的歌曲的內容。發生的唯一奇怪的事情是,將一個自定義HTTP標頭值設置爲:「Guitarparty-Api-Key」。 -H是設置自定義標題的curl語法。

作爲響應,您將從服務器返回帶搜索結果的JSON編碼結構。你需要解析這個結構,並提取你感興趣的部分。

爲了進入任何特定的細節 - 如何使用特殊的標頭做一個HTTP請求,如何解析JSON - 我會有要知道您計劃工作的語言或環境。例如,對於Python,我建議您查看模塊「urllib2」和「json」。

+0

是的,我正在使用json。 – user1869558 2013-03-15 23:06:45

+0

JSON是數據的表示法,而不是編程語言。它使用類似於編程語言Javascript的語法,因此名稱(JavaScript Object Notation)。你在製作一個能在Javascript中運行的程序嗎?如果是這樣,您可以從這些鏈接開始:http://www.json.org/js.html,http://eloquentjavascript.net/chapter14.html,http://stackoverflow.com/questions/581383/adding -custom-http-headers-using-javascript – svk 2013-03-15 23:15:38

+0

感謝您的鏈接!http請求的學習曲線非常高。我之前和GET,POST一起工作過,但這是一些比較基本的東西。 https://github.com/stuycs-ml7/pd7-miniproject1/blob/master/Smirnov_Wu/app.py – user1869558 2013-03-15 23:30:24