API とは?
API(アプリケーションプログラミングインターフェース)は、異なるソフトウェア間の通信「橋渡し」で、プログラムが事前設定されたルールに基づいて他のプログラムの機能を呼び出したりデータを取得したりできる仕組みで、基盤の詳細を知る必要はありません。
主な役割
- 機能再利用:重複開発を回避。
- データ共有:外部に機能の一部を公開。
代表的な種類
- REST API:HTTP ベースで、インターフェースがシンプル。
- SOAP API:XML ベースで、セキュリティ性が高い。
動作フロー
- クライアントがリクエストを送信。
- サーバーが処理して権限を確認。
- データを返す。
重要な要素
- API キー:認証を行い、不正アクセスを防ぐ。
- リクエストメソッド:GET(データ取得)、POST(データ送信)など。
- データ形式:一般的に JSON/XML を使用。
KTX アカウント API の作成方法
- ブラウザで KTX ウェブサイトにアクセスし、個人アカウントにログインします。
- 右上隅のプロフィールアイコンをクリックし、「API 管理」を選択して作成・管理ページに移動します。
- 右上隅の「API 作成」ボタンをクリックすると、ポップアップウィンドウが表示されます。
- 利用用途に合わせて、認可された信頼 IP アドレスを固定するか、IP 制限をしないかを選択します。
- 対応する API 名を設定します。
- アカウントの Google 認証コードを入力して認証を完了します。
API キーが正常に作成されました。