Web API(ウェブエーピーアイ)

PR
PR

Web API(ウェブエーピーアイ)とは、インターネットを通じて、外部のサービスが持つ機能やデータを、自分のプログラムから呼び出して使えるようにした窓口のことです。決められた住所(URL)に要求を送ると、結果がデータとして返ってくる仕組みで、地図や天気、決済など、さまざまなサービスがWeb APIを公開しています。

現実世界に例えると、Web APIは電話一本で注文を受け付けてくれる、専門店の受付窓口のようなものです。お店の中の仕組みを知らなくても、決まった言い方で注文すれば、欲しい品物を届けてもらえます。

HTTPでやり取りする

仕組みの基本です。Web APIは、Webページを見るときと同じHTTPの仕組みで、要求と応答をやり取りします。呼び出す側は、機能ごとに決められたURLに、条件を添えて要求を送ります。応答は、プログラムで扱いやすいJSONなどの形式で返ってくるのが一般的です。

自分で作らずに機能を借りられる

使われる理由です。地図の表示や住所の検索、天気の情報、クレジットカードの決済などを一から作るのは大変ですが、Web APIを使えば、専門のサービスの機能を借りて手早く組み込めます。開発の手間と費用を大きく減らせるため、現在の多くのアプリやWebサービスが、複数のWeb APIを組み合わせて作られています。

主な方式

Web APIにはいくつかの作り方があります。現在はREST APIが最も広く使われていますが、目的に応じてほかの方式も選ばれています。

方式 特徴 主な使われ方
REST URLとHTTPの作法に沿った、シンプルな方式 多くの公開API
SOAP XMLで厳密な取り決めに沿ってやり取りする 企業や金融のシステム
GraphQL 欲しいデータの項目を、呼び出す側が指定できる 画面の多いアプリ

APIキーで利用者を見分ける

利用の手続きです。多くのWeb APIは、事前に利用の登録をすると発行される「APIキー」を、要求に添えて送る決まりになっています。提供する側は、キーで誰が使っているのかを見分け、利用の量の管理や料金の計算を行います。APIキーは合鍵のようなものなので、他人に知られないよう厳重に管理する必要があります。

呼び出しの回数には上限がある

利用時の注意点です。多くのWeb APIには、一定の時間に呼び出せる回数の上限が設けられています。上限を超えると、しばらく応答が返ってこなくなります。無料で使える範囲と、それを超えた分の料金が決められていることも多いため、利用規約や料金表を事前に確かめておくことが大切です。

仕様の変更や終了に備える

長く使ううえでの注意点です。Web APIは提供する側の都合で、仕様が変わったり、提供が終了したりすることがあります。多くの場合は事前に告知され、新旧の版がしばらく並行して提供されます。自分のサービスが外部のWeb APIに頼っている場合は、告知を見逃さないようにし、切り替えの準備をしておく必要があります。

説明書を読んで使う

使い始めるときの手順です。Web APIを提供するサービスは、呼び出せる機能の一覧、送る内容、返ってくるデータの形などを、説明書として公開しています。多くの説明書には、試しに呼び出せる画面や、さまざまな言語での書き方の例も載っています。まずは説明書をよく読み、小さく試してから組み込むのが近道です。

ブラウザーの「Web API」との違い

言葉の注意点です。Webの開発の分野では、ブラウザーがJavaScriptに向けて用意している機能の窓口も「Web API」と呼ばれることがあります。画面の部品を操作する機能や、通信を行う機能などがこれにあたります。インターネット越しに外部のサービスを呼び出す意味とは異なるため、文脈で見分ける必要があります。

あわせて知っておきたい用語

  • API:
    ソフトウェアどうしが機能やデータをやり取りするための窓口です。
  • REST API:
    URLとHTTPの作法に沿ってやり取りする方式です。
  • APIキー:
    APIを使う人やアプリを見分けるための、合鍵のような文字列です。
  • JSON:
    データを読みやすい文字の形で表すための記述形式です。

コメント

タイトルとURLをコピーしました