アプリケーション管理
機能概要
機能の位置付け
アプリケーション管理 は、API 呼び出し元のアプリケーション ID、呼び出し資格情報、API 認可関係を管理する機能です。ユーザーはアプリケーションを作成した後、アプリケーション詳細で呼び出し可能な API と認可有効期限を設定し、外部システムまたは内部業務システムに制御されたアクセス範囲を付与できます。
簡単に言うと:アプリケーションは API 呼び出し元の「身分情報」であり、アプリケーションシークレットは呼び出し資格情報です。API 認可は、どのサービスをいつまで呼び出せるかを決めます。
利用のヒント
初回連携時は、アプリケーション新規作成 → アプリケーション情報とシークレット確認 → 【API 認可】へ入る → API と有効期限を選択 → 送信後に認可一覧を確認 の順で操作することを推奨します。
主な特徴
- アプリケーション保守:アプリケーション基本情報を新規作成し、名称、タイプ、アイコン、公開状態、説明、備考を変更できます。
- 資格情報確認:詳細画面でアプリケーション番号、アプリケーションシークレット、アイコン、タイプ、説明を確認できます。
- API 認可:アプリケーションに呼び出し可能な API を選択し、永久有効または指定日付範囲を設定できます。
- 既存認可確認:既存認可の変更ダイアログを開き、現在の API と有効期限設定を確認できます。
適用範囲
【アプリケーション管理】は、外部システムまたは内部業務システムと連携するためのアプリケーション ID、呼び出し資格情報、API 認可関係を管理します。API サービスは【API 管理】から提供されます。実際の API 呼び出し、認可期限切れ後の遮断、呼び出し記録は本ページの操作範囲外です。
事前準備
前提条件
- qData プラットフォームにログインしていること。
- 現在のアカウントで【データサービス】モジュールと【アプリケーション管理】メニューにアクセスできること。
- API 認可を追加する場合、対象 API が【API 管理】に存在し選択可能であること。
- アプリケーション名称とアプリケーションタイプを準備済みであること。アイコンをアップロードする場合は、画面提示に合う画像ファイルを準備してください。
ナビゲーションパス
データサービス > アプリケーション管理
画面概要
【アプリケーション管理】に入ると、ページ説明、検索条件、アプリケーション一覧、ページング、一覧上部の【新規】が表示されます。検索条件には「アプリケーション名称」「アプリケーションタイプ」「公開するか」が含まれます。各レコードには【変更】【詳細】【その他】が表示されます。

アプリケーション一覧項目
| 項目名 | 説明 | 必須 |
|---|---|---|
| 番号 | 現在アプリケーションレコードのシステム番号です。 | 該当なし |
| アプリケーション名称 | アプリケーション名です。 | 該当なし |
| 説明 | アプリケーション用途説明です。一覧では省略表示される場合があります。 | 該当なし |
| アプリケーションタイプ | Web、App などのアプリケーション形態ラベルです。 | 該当なし |
| アプリケーションアイコン | アプリケーション表示アイコンです。 | 該当なし |
| 公開するか | アプリケーションの公開状態です。 | 該当なし |
| 作成者 | アプリケーションを作成したアカウントです。 | 該当なし |
| 作成時間 | アプリケーション作成時間です。 | 該当なし |
| 操作 | 【変更】【詳細】【その他】入口を表示します。 | 該当なし |
推奨操作フロー
アプリケーション作成と認可:【アプリケーション管理】へ入る → 【新規】でアプリケーションを作成 → アプリケーション詳細を開く → 【API 認可】へ入る → 【新規】をクリック → API と有効期限を選択 → 新規成功と認可一覧を確認。
アプリケーション情報保守:名称、タイプ、公開状態で検索 → 【変更】をクリック → 現在アプリケーション項目を調整 → 【確定】をクリックしてデータを確認。
呼び出し資格情報確認:【詳細】でアプリケーションシークレットを確認します。【シークレットリセット】を使用する場合は、確認提示を読み、呼び出し側が新しいシークレットを利用する段取りを評価してください。
操作説明
アプリケーションを検索する
- 「アプリケーション名称」に名称キーワードを入力します。
- 「アプリケーションタイプ」ドロップダウンで対象タイプを選択します。
- 「公開するか」ドロップダウンで公開状態を選択します。
- 【検索】をクリックします。
- アプリケーション一覧で返却されたレコードを確認します。
- 条件をクリアする場合は【リセット】をクリックします。
アプリケーションを新規作成する
- 一覧上部の【新規】をクリックします。
- 「アプリケーション名称」に名称を入力します。
- 「アプリケーションタイプ」を選択します。
- 必要に応じて「アプリケーションアイコン」領域でアイコンファイルをアップロードします。
- 「公開するか」で「非公開」または「公開」を選択します。
- 「説明」に用途を入力します。
- 「備考」に補足説明を入力します。
- 【確定】をクリックします。
- アプリケーションデータが 1 件追加されたことを確認します。

現在アプリケーションを変更する
- アプリケーション一覧で対象レコードを探します。
- 対象レコードの操作列で【変更】をクリックします。
- 「アプリケーション変更」ダイアログで入力済み情報を確認します。
- 変更が必要な項目を調整します。
- 【確定】をクリックします。
- 現在アプリケーションデータが更新されたことを確認します。

アプリケーション詳細を確認する
- アプリケーション一覧で対象レコードを探します。
- 対象レコードの操作列で【詳細】をクリックします。
- 詳細上部のアプリケーション番号、名称、公開状態を確認します。
- 基本情報のアプリケーションシークレット、アイコン、タイプ、説明を確認します。
- 【API 認可】と【詳細情報】タブ入口を確認します。
- 一覧へ戻る場合は右上の【戻る】をクリックします。

その他操作とシークレットリセット確認
- アプリケーション一覧で対象レコードを探します。
- 対象レコードの操作列で【その他】をクリックします。
- メニュー内の【シークレットリセット】と【削除】入口を確認します。
- 【シークレットリセット】をクリックします。
- 「システム提示」確認ボックスを確認します。
- 「シークレットをリセットしますか。リセット後は新しいシークレットでアクセスしてください。」の内容を読みます。
- リセットしない場合は【キャンセル】をクリックします。

API 認可の空状態と一覧を確認する
- 対象アプリケーション詳細へ入ります。
- 【API 認可】タブをクリックします。
- 認可レコードがない場合、「レコードなし」と総数 0 を確認します。
- 認可領域の【新規】入口を確認します。
- 認可レコードがある場合、認可一覧項目と操作入口を確認します。


| 項目名 | 説明 | 必須 |
|---|---|---|
| API 番号 | 認可済み API の番号です。 | 該当なし |
| API 名称 | 認可済み API の名称です。 | 該当なし |
| 説明 | API サービス説明です。 | 該当なし |
| パス | API 呼び出しパスです。 | 該当なし |
| リクエスト方式 | GET などの API 呼び出し方式です。 | 該当なし |
| 有効期限 | 認可有効日付または永久有効状態です。 | 該当なし |
| 認可状態 | 現在認可状態スイッチです。 | 該当なし |
| 作成者 | 認可レコードを作成したアカウントです。 | 該当なし |
| 作成時間 | 認可レコード作成時間です。 | 該当なし |
| 操作 | 【変更】【削除】入口を表示します。 | 該当なし |
API 認可を新規作成する
- 【API 認可】タブで【新規】をクリックします。
- 「API サービス」で対象 API サービスを選択します。
- 「永久有効にするか」で「はい」または「いいえ」を選択します。
- 「いいえ」を選択した場合、「有効期限」で開始日を入力します。
- 「有効期限」で終了日を入力します。
- 必要に応じて「説明」に認可説明を入力します。
- 必要に応じて「備考」に補足説明を入力します。
- 【確定】をクリックします。
- 「新規作成成功」の提示を確認します。
- 認可一覧で新規レコードを確認します。


API 認可追加成功結果を確認する
- 認可一覧で新規 API レコードを確認します。
- 有効期限、認可状態、作成情報を確認します。
- 必要に応じて【変更】入口を開きます。

API 認可変更入口を開く
- 【API 認可】一覧で対象レコードを探します。
- 【変更】をクリックします。
- 表示された API サービスと有効期限設定を確認します。
- 必要に応じて項目を調整し、【確定】をクリックします。
その他認可入口を確認する
- 認可一覧で対象レコードを確認します。
- 認可状態スイッチを確認します。
- 【削除】入口を確認します。
- 操作前に呼び出し側への影響を確認します。
よくある質問
- アプリケーションシークレットをリセットすると何に影響しますか?
既存の呼び出し側は旧シークレットを使えなくなる可能性があります。リセット前に呼び出し側へ新しいシークレットの更新タイミングを確認してください。
まとめ
【アプリケーション管理】では、API 呼び出し元の身分情報、資格情報、API 認可を管理します。操作時は アプリケーション名称、タイプ、シークレット、API 認可、有効期限を重点的に確認してください。
