API

読み: えーぴーあい

エーピーアイ:ソフト同士が機能やデータをやり取りするための接続口(規約)

API

概要

API(Application Programming Interface)は、あるソフトウェアやサービスの機能・データを、別のソフトウェアから利用できるようにする「接続口」や「呼び出しルール(インターフェース)」のこと。アプリ同士を連携させる基盤になる。

何ができるか(例)

  • 決済APIで支払い処理を行う
  • 地図APIで地図表示や経路検索をする
  • SNS APIで投稿・ログイン連携をする(OAuthなど)
  • 自社システムからSaaSの顧客データを取得・更新する

よく出るAPIの形

Web API(HTTP API)

インターネット越しにHTTPで呼び出すAPI。JSONデータを返すことが多い。
  • REST(レスト:リソース単位で扱う設計様式)
  • GraphQL(ぐらふきゅーえる:必要な項目だけ取得できる問い合わせ方式)
  • gRPC(じーあーるぴーしー:高速なRPC方式)

ライブラリAPI

ログラム内で呼び出す関数やクラスの仕様(例:画像処理ライブラリの関数群)。

基本要素(Web APIの例)

  • エンドポイント:呼び出し先URL
  • メソッド:GET/POST/PUT/DELETEなど
  • リクエスト:送るデータ(パラメータ、JSONなど)
  • レスポンス:返ってくるデータJSONなど)
  • 認証・認可:APIキー、OAuth、トークンなど
  • レート制限:呼び出し回数の上限(過負荷防止)

APIを使うメリット

  • 機能を再利用でき、開発が速くなる
  • システム連携で二重入力を減らせる
  • 外部サービスの強み(決済、配送、AIなど)を取り込める

注意点

  • 仕様変更(バージョン更新)で動かなくなることがある
  • 認証情報の漏えいは重大事故になるため、鍵管理が重要
  • 通信障害・タイムアウト・リトライなど「失敗する前提」の設計が必要
  • 料金や利用規約、データ取り扱い(個人情報)を事前に確認する