基本・概念
APIの概要や、システム構成・運用に関する用語
API (Application Programming Interface)
システム同士がデータや機能を連携・共有するための仕組み。
環境
APIが稼働する実行環境。本番環境(Production)のほか、開発(Dev)やテスト・検証(Staging/Test)など、用途に応じて独立して用意されている。
レート制限 (Rate Limit)
サーバー負荷を防ぐため、「1分間に100回まで」などAPIの呼び出し回数を制限する仕組み。
SLA(Service Level Agreement)
サービス品質保証。APIの稼働率や障害時の対応速度など、提供側が保証するルールのこと。
通信・やり取りの流れ
データの送信・受信やリクエストの命令に関する用語
エンドポイント (Endpoint)
APIの機能にアクセスするための専用URL(接続先)。「どのURLにリクエストを送るか」だけでなく、リクエストの種類(HTTPメソッド)とセットで機能を指定する。
リクエスト (Request)
利用側(クライアント)からAPIサービス側(サーバー)へ送る「処理やデータの要求」。
レスポンス (Response)
リクエストに対してAPIサーバーから返ってくる「処理結果やデータ」。
パラメータ (Parameter)
APIを呼び出す際に送る条件指定の値。検索キーワードや取得件数などを指定します。
HTTPメソッド
APIに対して何を行いたいかを指定する動詞。主に GET(取得)、POST(作成)、PUT(更新)、DELETE(削除)など。
ステータスコード
処理が成功したか失敗したかを示す3桁の数字。例: 200(成功)、404(未検出 / ページ・リソースが見つかりません )、500(サーバーエラー)等。
ウェブフック(WebHook)
システム内で特定のイベント(データの更新や決済完了など)が発生した際、API提供側から利用側のシステムへ自動でデータを送信・通知する仕組み。
データ形式・規格
通信されるデータの中身や形式ルールに関する用語
JSON(JavaScript Object Notation)
現在のWeb APIで最も標準的に使われているデータ記述形式。軽量で人間にも読みやすいのが特徴。 ( 画面上で見やすい「"キー": "値"」というペアの形式でデータを表現します。 )
ペイロード(Payload )
リクエストやレスポンスに含まれる「実際のデータ本文(データ本体)」のこと。
スキーマ (Schema)
APIでやり取りされるデータの形式・型・必須項目などの定義ルール。
XML (Extensible Markup Language)
タグを使ってデータを表現する形式で、主に従来のシステムや特定業界のデータ標準規約等で使われるもの。
REST・RESTful API
Webの仕組みに沿って設計された、シンプルで標準的なAPIの設計スタイルのこと。
SOAP API
XML形式のメッセージを用いて通信を行うプロトコル規格。厳格な規約や高度なセキュリティを備えており、レガシーシステムや金融系等で使われる。
認証・セキュリティ・通信基盤
アクセス権限や安全な通信を行うための用語
APIキー
申請者に発行される一意の識別文字列(パスワードのようなもの)。誰からのリクエストかを識別・許可するために使用。
トークン (Token)
一定時間のみ有効なアクセス許可証(例: Bearer Token)。パスワードを直接保持せずに安全に通信するために使われます。
認可 (Authorization)
ログイン済みのユーザーやシステムに対し、「どの操作やデータへのアクセス(権限)を許可するか」を決める仕組み。(※本人確認を行う「認証」と区別されます)
OAuth 2.0
ユーザーのID・パスワードを渡さずに、特定の機能やデータへのアクセス権限のみを安全に付与するための認可規格。
