Partner Console の機能

Partner Console には、ナビゲーションタブからアクセスできる 4 つの主要なセクションがあります。

1. シークレットキー

アクセスの種類と権限を細かく制御しながら、API シークレットキーを管理します。

主な機能:

  • Create New Keys - 特定のアクセスレベルを持つ新しい API キーを生成します
  • Key Types:
    • Live - 本番データへの完全な読み取り/書き込みアクセス
    • Dryrun - 本番データに影響を与えずに書き込み操作をテストします(書き込みはシミュレートされます)
    • Read-only - データを安全に利用するための読み取り専用アクセス(書き込み操作はブロックされます)
  • Key Management - キーの詳細や最終使用日時を確認し、キーのローテーションや即時の失効を行います
  • Key Filtering - ステータス(All、Active、Revoked)でキーを絞り込みます
  • Key Rotation - ダウンタイムなしでキーをシームレスにローテーションします

各シークレットキーには次の情報が表示されます。

  • Label - 識別しやすいようにカスタマイズできる名前
  • Key ID - 一意の識別子(UUID 形式)
  • Secret - 一部が伏せ字になったシークレットキー(先頭 12 文字と末尾 4 文字が表示されます)
  • Type - キーのアクセスレベル(live、dryrun、read-only)
  • Status - 現在の状態(active、revoked)
  • Created - キーが生成された日付
  • Last Used - 最新の API 呼び出しのタイムスタンプ
  • Actions - キーのローテーションまたは失効

2. 統合設定

連携を Performance Hub の施設とリンクする方法を設定します。

主な機能:

  • Data Linking Method - 次の 2 つのリンク方法から選択します。
    • Direct Link - API 呼び出しに Performance Hub の施設 ID を使用します
    • Linking Identifier - 独自の拠点識別子(支店 ID、店舗番号など)を使用します
    • パートナーのリンク方法の詳細
  • Linking Identifier Label - 施設に表示されるフィールド名をカスタマイズします(例: 「Branch ID」、「Location Code」)
  • Partner Prefix - 連携に使用する一意のプレフィックスを設定します
  • Integration Fields - 連携に固有のカスタムフィールドを設定します

3. パートナー詳細

パートナーのプロフィール情報を表示、管理します。

編集可能なフィールド:

  • Partner Email - 通知を受け取る主要な連絡先メールアドレス
  • Description - 連携の簡単な説明
  • Logo URL - パートナーロゴの URL
  • Website - 会社または連携の Web サイト
  • Category - 連携のカテゴリ分類
  • Details - パートナーに関するその他の情報

読み取り専用の情報:

  • Partner ID(一意の識別子)
  • パートナー名
  • 連携のステータス
  • 接続されている組織の数

4. ログ

API のアクティビティを監視し、連携の問題をトラブルシューティングします。

利用できるデータ:

  • API リクエストログ
  • レスポンスのステータスコード
  • エラーメッセージ
  • タイムスタンプ情報
  • リクエスト/レスポンスのペイロード

接続された組織

連携を有効にしているすべての組織を表示します。各組織のカードには次の情報が表示されます。

  • 組織名
  • 関連付けられたブランド
  • 有効な施設の数
  • 連携のステータス

Ask AI

AI アシスタント(⌘I ショートカット)を使用して、パートナーに関するトピックのヘルプをすぐに利用できます。

質問できる内容:

  • API エンドポイントの使い方と例
  • 認証とシークレットキーの管理
  • データ同期のベストプラクティス
  • 連携でよくある問題のトラブルシューティング
  • Partner Console の機能とナビゲーション