API は、人の画面操作を介さずに、システム同士が決まった形式で注文とお返事をやり取りする窓口です。窓口の形が公開されているから、相手の中身を知らなくてもつなげます。
- 決まった形式で注文すると決まった形式で答えが返る
- 人手ゼロで 24 時間・何件でも繰り返せる
- 中身は見せず、窓口だけを公開して安全を保つ
なぜシステム同士は会話できるのか
宅配の配送状況が自社の販売システムに自動で表示される——裏側では、誰も相手のサイトを開いていません。システム同士が直接やり取りする窓口が API です。1 件の問い合わせがどう進むのか、動く図でたどりましょう。
APIの1往復を追いかける
各ステップ・参加者・分岐をクリックすると、その仕組みの説明がここに表示されます。
この図をテキストで読む
シーケンス図「APIの1往復(配送状況の自動問い合わせ)」。参加者3人、ステップ6個。 【参加者】(左から右) - 自社の販売システム: 問い合わせる側 - 宅配会社のAPI: 公開された注文の窓口 - 宅配会社のシステム: 窓口の奥の中身 【流れ】(上から下へ) ── ① 1件の問い合わせ ── 決まった形式の注文とお返事 ── 1. 自社の販売システム → 宅配会社のAPI: 「伝票番号 7701 の配送状況は?」と決まった形式で送る 2. 宅配会社のAPI → 宅配会社のシステム: 窓口が中のシステムに照会する 3. 宅配会社のシステム → 宅配会社のAPI: 最新の配送状況を渡す(応答) 4. 宅配会社のAPI → 自社の販売システム: 「配達中・あす到着」を決まった形式(JSON)で返す(応答) ── ② 自動でくり返す ── APIは自動化の入り口 ── (毎朝、届け待ちの注文の数だけ繰り返し の枠) [届け待ちの注文の数だけ の場合] 5. 自社の販売システム → 宅配会社のAPI: 次の伝票番号で同じ注文を送る 6. 宅配会社のAPI → 自社の販売システム: 結果が次々に返り、画面に反映される(応答)
もしAPIが無かったら?
各ステップ・参加者・分岐をクリックすると、その仕組みの説明がここに表示されます。
1 件ずつの検索と転記 — 件数に比例して時間も写し間違いも増える
この図をテキストで読む
シーケンス図「APIなし(人が調べて転記)」。参加者2人、ステップ3個。 【参加者】(左から右) - 担当者: 人が窓口になる - 宅配会社のサイト: 人間用の画面 【流れ】(上から下へ) 1. 担当者 → 宅配会社のサイト: サイトを開き伝票番号を 1 件ずつ入力 2. 宅配会社のサイト → 担当者: 画面で結果を目視確認(応答) 3. 担当者(自身で処理): 自社システムへ手で転記(件数ぶん繰り返し)
APIには鍵がかかっている
誰でも呼べる窓口ばかりではありません。多くのAPIは「APIキー」という合鍵で相手を確かめ、使いすぎや不正を防いでいます。鍵が漏れると勝手に使われてしまうため、パスワードと同じように厳重に管理します。
押さえておきたい用語
- API
- Application Programming Interface の略。プログラム同士が決まった形式でやり取りするための窓口・接続規格です。
- リクエスト / レスポンス
- 窓口へ送る注文がリクエスト、返ってくるお返事がレスポンス。どちらも形式が事前に決まっています。
- JSON
- お返事などに使われる定番のデータの形。「項目名: 値」の組で表すので、機械が読み間違えません。
- APIキー
- 正規の利用者であることを示す合鍵。呼び出しに添えて送り、相手の確認や利用量の管理に使われます。
- API仕様書
- 窓口のメニュー表。どんな注文をどう書けば何が返るかが公開されているから、初対面のシステム同士でもつながれます。
ここから先へ
この解説とつながりのあるページ