コンテンツにスキップ

連携

連携設定(システム連携)

概要

管理者が外部システムとの API 連携に必要な WebAPI 登録用ワンタイムパスワードを発行・管理する画面。発行したパスワードを WebAPI 管理サイトに登録することで、WebAPI 経由での情報取得が可能になる。

アクセス権限:管理者ユーザーのみ。サイドバー「設定」→「外部連携」から遷移。


URL

ホーム画面(/home)上に Drawer として表示される。独立したURLは持たない。


画面構成

連携設定(システム連携)

「WebAPI登録用パスワード発行」カードと操作ボタンで構成されるシンプルなレイアウト。


パスワード未発行状態

表示要素 内容
説明文 「発行されたパスワードをWebAPI管理サイトに登録することで、WebAPIより情報の取得が可能となります。」
有効期限セレクト 現在時刻からの有効期限を選択(デフォルト:3日)
パスワード発行ボタン クリックで発行確認ダイアログを表示
有効期限の選択肢
選択肢 時間(時)
1時間 1
3時間 3
6時間 6
12時間 12
24時間 24
3日(デフォルト) 72
7日 168

パスワード発行済み状態

パスワード発行済み状態

表示要素 内容
説明文 「WebAPI登録用パスワードを発行しました。お客様のパスワードは以下となります。」
パスワード 発行されたパスワード文字列
有効期限 パスワードの有効期限(日本時間でフォーマット)
発行取消ボタン クリックで破棄確認ダイアログを表示
  • 画面を開いた際に既存パスワードの有無を API で確認し、状態を自動的に切り替える

ボタン・アクション

ボタン 表示条件 動作
パスワード発行 パスワード未発行時 発行確認ダイアログを開く
発行取消 パスワード発行済み時 破棄確認ダイアログを開く

ダイアログ

ダイアログ 内容
パスワード発行確認 「ワンタイムパスワードを発行します。よろしいですか?」キャンセル/発行
パスワード破棄確認 「発行されたパスワードを破棄します。よろしいですか?」キャンセル/破棄