ホーム / IT知識 /

非エンジニアでも簡単！APIを利用して理解してみる。

2021/04/16

IT知識

t f B! P L
非エンジニアでも簡単！APIを利用して理解してみる。

はじめに

APIって何かわからないというお悩みの方必見です。

確かにAPIと調べるとたしかにわかるようなわからないような説明が多くでてきますよね。

この記事では、実際にAPIを利用してみて、よりAPIの理解を深めていただける内容を紹介します。Googleの提供するブラウザChromeさえあれば、簡単にAPIを試すことのできるので、誰でも簡単に理解していただくことができるかと思います。

全体像

Chromeの拡張機能である「Talend API Tester - Free Edition」をChromeに追加します。もちろんFree（無料）です。あとは、この機能を使って、実際にAPIを利用するだけです。使い方もとても簡単なので、順を追って解説していきます。


API Testerのインストール

以下のURLから「Talend API Tester - Free Edition」をChromeに追加します。
「Chrome」に追加から簡単に追加していただくことができます。


https://chrome.google.com/webstore/detail/talend-api-tester-free-ed/aejoelaoggembcahagimdiliamlcdmfm


APITesterのインストール

METHODの指定

今回は以下のAPIを利用して実際にAPIリクエスト（APIを用いて情報をくださいという命令を出す操作）とレスポンス（APIリクエストを行った結果、返ってきた情報）を受け取ってみたいと思います。


利用するAPI【郵便番号検索API】
http://zipcloud.ibsnet.co.jp/doc/api


このAPIを簡単に紹介すると、郵便番号をリクエストすると、住所情報が返ってくるようなAPIです。それでは、どうやってリクエストするのか、どのように情報が返ってくるのかを見ていきたいと思います。


まずは画面のMETHODというところから埋めていければと思います。METHODとはその名のとおり、どのような方法でリクエストを行うのかというルールを指定する項目のことです。大抵の場合APIのドキュメント（http://zipcloud.ibsnet.co.jp/doc/api）にMETHODはなにか記載してあるのですが、上記の場合は、METHODが記載されていないです。ただ、URLのパラメータに情報を入れて、通信を行い、サーバー側に情報を渡す方法となる旨が記載されているため、METHODは「GET」になります。よって、METHOD欄は「GET」を指定します。


METHODの設定

エンドポイントの指定

SCHEMEと記載されているところに、HTTPリクエストを送るURLを記載します。
この郵便番号APIの場合は、APIドキュメント（http://zipcloud.ibsnet.co.jp/doc/api）に「リクエストURL」として記載されている以下がエンドポイントとなります。


【https://zipcloud.ibsnet.co.jp/api/search】


このエンドポイントをSCHEMEと書かれている下のフォームに入力します。

このエンドポイントとは、実際にどこのサーバーに情報提供依頼を出すかということを指定する「URL」であると理解しておけばOKです。

エンドポイントの入力

パラメータの指定

GETリクエストではAPIのリクエストに情報の載せるためにパラメータを利用します。利用できるパラメータはAPIドキュメント（http://zipcloud.ibsnet.co.jp/doc/api）のリクエストパラメータと書いてある箇所に記載されています。


このAPIでリクエストパラメータとして利用できるのは、「zipcode」、「callback」、「limit」があります。そのうち必須なのは、「zipcode」となるので、今回はパラメータとして「zipcode」のみ使うこととします。

このパラメータについて補足すると、APIでは情報の授受を行うわけですが、どんな情報を欲しいのか指定する役割のある項目になります。


「QUERY PARAMETERS」という箇所をクリックし、続いて「Add query parameter」という箇所をクリックします。そうすると、以下のようなフォームが出てくるので、パラメータ名とパラメータの値（この場合は住所を調べたい郵便番号）をいれます。

パラメータの設定


APIリクエストの実行と結果の確認

次はいよいよAPIリクエストを実行します。エンドポイントを入力した箇所の右側に
「Send」というボタンがあるので、クリックします。これでAPIリクエスト完了です。


APIの実行


上記のようにAPIリクエストを実行すると画面下部に「Response」と書かれたフィールドが表示されます。こちらのフィールドの「Body」にAPIリクエストをした結果（レスポンス）が返ってきています。コードに囲まれ、住所が入って返ってきているのが確認できるかと思います。

APIレスポンスの確認


まとめ

簡単にAPIリクエストを実行し、レスポンスを受け取ることができましたね。
他のAPIに関してもGETメソッドであれば、同じように操作していただくことで、結果が得られるかと思います。是非いろんなAPIを試してみてください。また、本記事を読むことによって
少しでもAPIの知識が向上できればと思っています。不明点などあれば、是非コメントください。




QooQ