0

私は現在、この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

4

1 に答える 1

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

ここで起こっていることは、HTTPを介して通常のGETリクエストを行うためにcurlが使用されているということです。これは、リンクをクリックしたときにブラウザが通常行う種類のリクエストです。URLは「http://api.guitarparty.com/v2/songs/?query=Jolene」です。これは、「Jolene」以外の曲を検索するために変更するものです。起こっている唯一の奇妙なことは、カスタムHTTPヘッダー値がAPIキーに設定されていることです:"Guitarparty-Api-Key"。-Hは、カスタムヘッダーを設定するためのcurl構文です。

それに応じて、サーバーから、検索結果とともにJSONでエンコードされた構造を返します。この構造を解析し、関心のある部分を抽出する必要があります。

あらゆる種類の詳細(特別なヘッダーを使用してHTTPリクエストを作成する方法、JSONを解析する方法)を理解するには、作業する予定の言語または環境の種類を知る必要があります。たとえば、Pythonの場合、モジュール「urllib2」と「json」を確認することをお勧めします。

于 2013-03-15T22:33:16.527 に答える