パートナーコンソール

Partner Console は、Performance Hub との連携を管理するための Web インターフェイスです。

Partner Console へのアクセス権をまだお持ちでない場合は、Performance Hub メイン Web サイトからパートナーに関するお問い合わせをお送りください。担当チームがパートナーのオンボーディング手順をご案内し、コンソールへのアクセスの設定をお手伝いします。

コンソールへのアクセス

Partner Console にアクセスするには、次のものが必要です。

1. Partner ID - Performance Hub が各パートナーに発行する一意の識別子
2. ワンタイムパスワード（OTP） - パートナーのメールアドレス宛てに送信される確認コード

partner-api.performancehub.co/partner/v1/console からログインします。

コンソールの機能

Partner Console には、Performance Hub との連携を管理するための次のツールが用意されています。

• Secret Keys - さまざまなアクセスレベル（live、dryrun、read-only）の API キーを生成、管理します
• Integration Settings - 連携を施設とリンクする方法を設定します
• Partner Details - パートナーのプロフィール情報を表示、更新します
• Logs - API のアクティビティを監視し、問題をトラブルシューティングします
• Connected Organisations - 連携を使用しているすべての組織を確認します
• Ask AI - ⌘I ショートカットですぐにヘルプを利用できます

各機能の詳細については、Partner Console の機能を参照してください。

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 の機能とナビゲーション

パートナーのリンク方法

パートナーや会員管理システムは、支店 ID、店舗番号、施設 ID など、それぞれ独自の ID で各施設や拠点を識別しています。データの同期や送信の際に拠点を識別する方法は 2 種類あります。

1. ダイレクトリンク

データを送信する際、パートナーは Performance Hub システムの施設 ID を使用します。

たとえば、Partner A では、東京の施設の内部 ID が branch_tokyo であるとします。Performance Hub のエコシステム内でデータを正規化するため、この拠点とこのパートナーに対して新しい ID（たとえば UUID: 550e8400-e29b-41d4-a716-446655440000）を割り当てます。

パートナーは、データを送信するために API を呼び出す際、この facility_id を使用する必要があります。

リンクに使用する正しい facility_id（Direct Link 方式で必要）を取得するには、パートナーは /partner/v1/facilities API エンドポイントを呼び出します。このエンドポイントは、現在 Performance Hub でパートナー連携が有効になっているすべての施設の一覧を、対応する facility_id の値とともに返します。

2. 連携識別子

パートナーは、各拠点の一意の識別子（「Branch ID」、「Location Code」、「Store Number」など）を独自のシステムで管理しています。このリンク方法では、パートナーは当社の施設 ID ではなく、独自の識別子を使用して Performance Hub の施設を識別できます。

施設の設定: 施設がこのパートナーを有効にすると、パートナーがその拠点の識別に使用している一意の識別子を、Performance Hub 内の施設設定で入力するよう求められます。

API 連携: パートナーが Performance Hub に API 呼び出しを行う際、リクエストに独自の一意の識別子を指定できます。Performance Hub は内部で linking_identifier を検索し、API 呼び出しを正しい施設に照合します。

例: パートナーのシステムで拠点を「Branch ID」と呼んでいる場合は、下のラベルを「Branch ID」に設定します。各施設は連携を有効にする際に自分の Branch ID の値を入力するため、システム間でデータをシームレスに同期できます。

施設の統合画面（Performance Hub メインの施設ビュー）での設定例。パートナー連携画面で設定された、会員管理システムのリンク識別子/内部 ID が表示されています

curl -X POST https://partner-api.performancehub.co/partner/v1/membership-plans \
  -u sk_live_YOUR_PARTNER_SECRET_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "membership_plans": [
      {
        "membership_plan_id": "plan_unlimited_monthly",
        "facility_id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Unlimited Monthly Access",
        "billing_cycle": "monthly",
        "price": 10058,
        "currency": "JPY"
      }
    ]
  }'

curl -X POST https://partner-api.performancehub.co/partner/v1/membership-plans \
  -u sk_live_YOUR_PARTNER_SECRET_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "membership_plans": [
      {
        "membership_plan_id": "plan_unlimited_monthly",
        "linking_identifier": "branch_tokyo",
        "name": "Unlimited Monthly Access",
        "billing_cycle": "monthly",
        "price": 10058,
        "currency": "JPY"
      }
    ]
  }'