API キーを発行する¶

API キーを発行する場合は以下の手順で行ってください。

注意

API キーは有効期間の長いトークンであるため、漏洩した際のセキュリティリスクが高くなります。

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

intra-mart Accel Platform にログインして、「サイトマップ」→「OAuth 認証 - API キー - API キー一覧」の順にクリックします。
「API キー発行」をクリックします。

フォームの各要素の内容を入力して「発行」をクリックします。

設定項目		必須	説明
基本情報	表示名	標準のみ必須	API キーの表示名を設定します。ロケール毎に設定可能です。 ※ログインユーザのロケールの表示名が設定されていない場合、「標準」の表示名が利用されます。
	説明	－	API キーの説明を設定します。ロケール毎に設定可能です。
	有効日数	必須	API キーの有効日数を設定します。「1～9999」の範囲で設定してください。
	画像	－	API キーを識別する画像を設定します。
アクセス範囲		必須	API キーに許可するアクセス範囲を設定します。
IP アドレス制限		－	API キーの使用を許可するリモート IP アドレスを設定します。 [m-n] での範囲指定や、* でのワイルドカード指定が可能です。例：「 192.168.[0-24].[0-254] 」「 192.168.0.* 」注意未設定の場合はすべてのリモート IP アドレスに対して API キーの使用を許可します。

コラム

発行後は設定の変更はできません。

設定を変更する場合や有効期限が切れた場合は、「発行した API キーを削除する」の手順で API キーを削除して再度発行してください。

コラム

リモート IP アドレスの取得に関しては「設定ファイルリファレンス」 - 「IPアドレス取得元設定」を参照してください。

「決定」をクリックします。
API キーが発行されました。

コラム

クリップボードアイコンをクリックすることで、発行された API キーをクリップボードにコピーできます。
発行した API キーを付与したリクエストを送信することで、intra-mart Accel Platform 上の OAuth 認証方式のリソースへアクセスできます。

Authorization リクエストヘッダフィールドを使用して API キーをベアラートークンとして送信してください。
```
GET /<resource_path> HTTP/1.1
Host: localhost
Authorization: Bearer <api_key>
```
- curl コマンドの例：
  curl http://<host>:<port>/<contextPath>/<resource_path> -H "Authorization: Bearer <api_key>"
コラム

API キーは intra-mart Accel Platform 上で提供する以下のようなリソースで使用できます。

詳しくは各ドキュメントを参照してください。
- OAuth認証モジュールを用いて提供するクライアントリソース
  
  参考：OAuth プログラミングガイド
- Web API Maker を用いて提供する OAuth 認証方式の Web API
  
  参考：Web API Maker プログラミングガイド
  
  ※Web API Maker で OAuth 認証方式を利用するには Web API Maker OAuth認証モジュールが必要です。
- IM-LogicDesigner を用いて提供する OAuth 認証方式の Web API（フロールーティング）
  
  参考：IM-LogicDesigner ユーザ操作ガイド
  
  ※フロールーティングで OAuth 認証方式を利用するには IM-LogicDesigner REST API OAuth認証モジュールが必要です。
- ViewCreator を用いて提供する OAuth 認証方式の Web API（クエリルーティング）
  
  参考：ViewCreator 管理者操作ガイド

目次

API キーを発行する¶

目次