不明白如何使用这个API

时间:2013-03-15 22:04:06

标签: json api request

我目前正在使用此API,guitarparty开始一个项目。问题是我不知道如何使用它。

例如,这一行

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 个答案:

答案 0 :(得分:1)

curl是一个用于处理HTTP和类似协议的命令行工具。您可以在此处下载:http://curl.haxx.se

该行应该在已安装curl的系统上输入命令行,可能在类似Linux的系统上。您可能想要下载curl并尝试按照示例进行操作。

然而,像这样的API的美妙之处在于您不需要使用任何特定工具 - 您可以使用任何您想要的工具,只要您可以设置HTTP标头值。许多不同的工具和模块可以发出HTTP请求。

您必须做的第一件事是在GuitarParty网站上获取API密钥。这是识别您的应用程序的关键,并可能对例如您可以运行多少个查询。如果没有,您将无法使用API​​。您打算将上面的“{API_KEY}”替换为实际的API密钥。

查询示例(来自文档)是:

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

这里发生的是curl用于通过HTTP发出正常的GET请求。这是您单击链接时浏览器通常会为您提供的那种请求。网址为“http://api.guitarparty.com/v2/songs/?query=Jolene” - 这是您修改以搜索“Jolene”以外的歌曲的内容。发生的唯一奇怪的事情是设置自定义HTTP标头值:“Guitarparty-Api-Key”到API密钥。 -H是设置自定义标题的curl语法。

作为响应,您将从服务器返回带有搜索结果的JSON编码结构。您需要解析此结构并提取您感兴趣的部分。

要获得任何类型的细节 - 如何使用特殊标头创建HTTP请求,如何解析JSON - 我必须知道您计划使用哪种语言或环境。对于Python例如,我建议你看看模块“urllib2”和“json”。