API キーによるアクセス許可機能について¶

ここでは、API キーによるアクセス許可機能について説明します。

コラム

API キーによるアクセス許可機能は intra-mart Accel Platform 2023 Autumn(Hollyhock) 以降のバージョンで利用可能です。

API キーによるアクセス許可¶

API キーによるアクセス許可機能では、事前に発行した資格情報（API キー）を使用します。

intra-mart Accel Platform は提示された API キーを検証し、リソースへのアクセス許可を判断します。

注意

API キーは intra-mart Accel Platform 上のリソースへのアクセス許可を付与することが容易である反面、漏洩によるセキュリティリスクが潜在します。

定期的なローテーション（API キーの再発行）やアクセスを許可するリモート IP アドレスの制限等、セキュリティリスクを緩和する対策を講じたうえで使用することを推奨します。

API キーによるアクセス許可フロー¶

ユーザが intra-mart Accel Platform 上で API キーの登録を実行します。

intra-mart Accel Platform は API キーを登録し、登録した API キーをユーザに返却します。
クライアントはユーザから提供された API キーを用いて intra-mart Accel Platform 上の Web API を実行します。

※API キーはベアラートークンとして Authorization リクエストヘッダフィールドを使用して送信します。
GET /<resource_path> HTTP/1.1
Host: localhost
Authorization: Bearer <api_key>
intra-mart Accel Platform は API キーを検証してリソースを返却します。

Web API は取得したリソースを用いて処理を行い、結果をクライアントへ返却します。

API キーの発行¶

API キーの発行手順については「 OAuth ユーザ操作ガイド」 - 「 API キーによるアクセス許可機能を利用する」を参照してください。

API キーの有効期限と更新方法¶

API キーの有効期限は発行する際に設定できます。

発行後は有効期限を変更できないため、有効期限を更新する場合や有効期限が切れた場合は API キーを削除して再度発行する必要があります。

詳しくは「 OAuth ユーザ操作ガイド」 - 「 API キーによるアクセス許可機能を利用する」を参照してください。

API キーの管理¶

API キー管理画面から、ユーザにより発行された API キーの確認や削除が可能です。

詳しくは「 OAuth 管理者操作ガイド」 - 「 API キーの管理」を参照してください。

目次