IT・システム開発
API
Application Programming Interface
読み:えーぴーあい
別のソフトウェアから機能やデータを利用するために定めた、呼出し方と受渡しの約束です。
01初心者向け
まず意味をつかむ
アプリ同士が情報や処理を受け渡すための窓口です。何を送ると何が返るかを決めることで、相手の中身を直接操作せずに連携できます。
02実務者向け
仕事でどう使うか
利用目的、入力項目、応答、エラー、権限、利用量の上限を整理します。連携先との責任分担や変更通知の方法を合意し、異常時を含む接続試験を計画します。
03専門家向け
判断を一段深める
接続できることと業務上の意味が合うことは別です。同じ顧客という項目でも定義が違う場合があります。互換性、再試行時の二重処理、障害時の扱いまで含めて契約を設計します。
別名・略語:エーピーアイ、アプリケーションプログラミングインターフェース
IN PRACTICE
具体例で考える
架空の受付サイトが配送APIへ届け先を送り、配送番号を受け取ります。番号が返らない場合の照会方法と再送条件も決めます。
理解を助けるための架空の例です。利用側の入力
提供側の機能
応答とエラー
入出力契約の概念を示す図です。特定の通信形式や実装を指定しません。
ここは誤解しやすい
APIは必ずインターネット上で公開されるものではなく、社内やプログラム内部でも利用されます。
この知識を、組織の力へ。
