アプリケーションプログラミングインターフェースはソフトウェアを接続する
インターフェースは、あるシステムが別のシステムに何かを要求するための既知の方法を提供します。 また、返される結果も定義します。
アプリケーションプログラミングインターフェース(API)は、ソフトウェアシステムが通信し、データ、機能、または動作を交換できるようにする定義されたルールのセットです。
リクエストは合意された契約に従う
別のサービスから配送ステータスを必要とするアプリケーションを想像してください。期待される情報を使用して、定義されたエンドポイントにリクエストを送信します。サービスはリクエストをチェックし、両者が理解できる形式でレスポンスを返します。
この契約により、各システムは合意された接続を安定させたまま、内部的に変更できます。契約が変更される場合、既存のリクエストが引き続き機能するように、チームは調整する必要があります。
APIは再利用と分離をサポートする
APIは、別のアプリケーションが再度構築する代わりに、既存の機能を公開できます。あるシステムは、複数の承認されたアプリケーションに顧客記録、スケジューリング、または支払いステータスを提供する場合があります。
アクセスは意図的であるべきです。APIには、明確な権限、不正なリクエストの安全な処理、およびそれに依存する人やシステムのための有用なドキュメントが必要です。
API用語
- リクエスト
- 別のアプリケーションまたはサービスに情報やアクションを求めるメッセージ。
- レスポンス
- ソフトウェアシステムがリクエストを受信して処理した後に返される結果。
- エンドポイント
- 特定のタイプのリクエストが送信される定義された場所。
有用な接続が定義するもの
利用可能なアクション
インターフェースは、どの情報をリクエストまたは変更できるかを示します。
期待される形式
両方のシステムは、リクエストとレスポンスの形状と意味について合意します。
アクセスルール
認証と権限チェックにより、誰または何が接続を使用できるかを制限します。
アプリケーションプログラミングインターフェースに関する質問
APIはアプリケーションプログラミングインターフェースの略です。ソフトウェアが情報やアクションをリクエストして交換するために使用するルールを説明します。
通常は違います。ユーザーインターフェースは人のために設計されています。APIは、ソフトウェアが他のソフトウェアと通信するために設計されていますが、その通信を定義して管理するのは人です。
APIにより、別々のシステムが定義された接続を通じて承認されたデータや機能を共有できます。これにより、繰り返し作業を削減し、アプリケーション間で責任を分離できます。
関連する用語集ガイド
チームが依存する作業を接続する
CaffeineのアプリはInternet Computer上で動きます。そのために作られたパブリックネットワークです。