GETリクエストの構築

GETとは

GETとは、「リソース（情報）を取得する」ためのHTTPメソッドです。ウェブサイトをブラウザーで見るとき、内部ではGETによるリクエストが行われています。Web APIも情報を取得する性質のものが多いため、GETをよく使います。

例として、ルビ振りAPIを使って「明鏡止水」の読み方を調べてみます。
GETの場合は、ブラウザーで以下のURLを見ることでもAPIの結果をプレビューできます。
ただし「<あなたのアプリケーションID>」の部分は登録したアプリケーションIDに置き換えてください。
（アプリケーションIDの登録方法はご利用ガイドをご覧ください）

telnetコマンドを使った例

telnetコマンドを使うと具体的な通信の中身を見ることができます。まずtelnetを起動します。

次に、リクエストを送ります。以下を端末に打ち込み、最後にEnterキーを2回押すと、レスポンスが返ってくるはずです。

通信のタイムアウトがあるため、ゆっくり入力していると途中で切れてしまうことがあります。テキストエディターなどであらかじめリクエスト内容を作成しておき、コピーアンドペーストするといいでしょう。

実際はこのレスポンス結果をプログラムで解析し、サービスを利用していくことになります。

このページのトップへ

アプリケーションIDについて

Yahoo!デベロッパーネットワークで公開されているWeb APIを使う際には、原則としてアプリケーションIDが必要です。

例外として、OAuthによるユーザー認証を必要とするWeb APIについては、アプリケーションIDではなくConsumer Keyを利用します。

登録したアプリケーションIDは、以下のいずれかの方法でリクエストに付与しなくてはなりません。

User-Agent方式

User-Agentヘッダーの末尾に以下の形式で埋め込むことでアプリケーションIDを渡します。
User-Agent: <元のUser-Agent文字列>; Yahoo AppID: <あなたのアプリケーションID>

User-Agentがもともと空の場合は、

となります。

パラメーター方式

パラメーターとして後述のクエリーストリングに混ぜ込むことでアプリケーションIDを渡すこともできます。 こちらの方が手軽で、ヘッダーを操作できない場合でも使うことができます。

このページのトップへ

Web APIへのパラメーターの渡し方

Web APIは渡されたパラメーターによって出力が変わります。 パラメーターを渡すには、クエリーストリングと呼ばれる形式に変換する必要があります。 クエリーストリングは以下の順序で作ります。

1. Web APIドキュメントをもとに、必要なリクエストパラメーターと、渡したい文字列を書き出します。

   sentence

   明鏡止水

2. パラメーター名と、パラメーターの値をそれぞれパーセントエンコーディング形式に変換します。

   sentence

   %E6%98%8E%E9%8F%A1%E6%AD%A2%E6%B0%B4

3. 変換結果を「=」で連結します。このときに使う「=」は、エンコードしてはいけません。

   sentence=%E6%98%8E%E9%8F%A1%E6%AD%A2%E6%B0%B4

4. 各パラメーターについて1～3を行い、最後に「&」で連結します。この「&」もエンコードしてはいけません。

   appid=YOUR_APPID&sentence=%E6%98%8E%E9%8F%A1%E6%AD%A2%E6%B0%B4

たとえばPHPの場合、http_build_query（外部リンク）という標準関数で簡単にクエリーストリングを作ることができます。GETの場合、URLの末尾にクエリーストリングを「?」で連結することでパラメーターを渡します。

クエリーストリング以外の形式をサポートするケースもありますので、各Web APIのドキュメントもお読みください。

パラメーターの文字コードについて

Web APIのドキュメントに記載がない場合、UTF-8をサポートしています。日本語の文字列などはUTF-8で渡すようにしてください。

このページのトップへ

レスポンスの解析

Web APIのレスポンスはXMLやPHPSerialize、JSONといったテキスト形式になっています。対応している形式はWeb APIによって異なります。 いずれも汎用的なデータフォーマットですので、お好きなツール・ライブラリを使って解析してください。