4.2 APIキー一覧(V02-00以降)
[JP1]画面のナビメニュー[ネットワーク]−[APIキー一覧]を選択すると,APIキー一覧画面が表示されます。
一覧画面の右の「環境種別」で示されたリストにはログインユーザーに利用権限がある環境種別が表示されます。リストから表示対象の環境種別を選択すると,その環境に設定されているAPIキー情報が表示されます。デフォルトは何も選択されていません。
インターネット経由でのアクセスを許可していない環境種別の場合,このAPIキー一覧画面で提供する機能は利用できません。
APIキーは,お客様環境からインターネット経由でサービス内のWebアプリケーションにREST APIを発行する場合に設定が必要になります。REST API発行時のリクエストヘッダーに「x-jp1cs-api-key」を付与し,値としてAPIキー一覧画面から取得したAPIキーのいずれかを指定してください。このヘッダーが付与されていない場合やAPIキーが誤っている場合,API接続に失敗します。
- 注意事項
-
-
APIキーをお客様のファイル等に記載する場合,安全な方法・場所で管理してください。
-
不要になったAPIキーは削除してください。
-
APIキーは定期的にローテーションしてください。
-
V02-50以降において,災対環境・大阪リージョン側で稼働中の際には,APIキーの表示・確認だけを実施し,作成・削除の操作は実施しないでください。
-
- 〈この節の構成〉