合作伙伴控制台

Partner Console 提供一个网页界面，用于管理您与 Performance Hub 的集成。

如果您尚无 Partner Console 访问权限，请通过 Performance Hub 官方网站提交合作伙伴咨询与我们联系。我们的团队将引导您完成合作伙伴入驻流程，并帮助您设置控制台访问权限。

访问控制台

要访问 Partner Console，您需要：

1. Partner ID：Performance Hub 为每个合作伙伴提供的唯一标识符
2. 一次性密码（OTP）：发送到您的 Partner Email 的验证码

在 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 包含四个主要部分，可通过导航选项卡访问：

1. 密钥

管理您的 API 密钥，全面控制访问类型和权限。

主要功能：

• Create New Keys：生成具有特定访问级别的新 API 密钥
• 密钥类型：
  • 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：在两种关联方式中选择：
  • Direct Link：在 API 调用中使用 Performance Hub 设施 ID
  • Linking Identifier：使用您自己的位置标识符（Branch ID、Store Number 等）
  • 详细了解合作伙伴关联方式
• Linking Identifier Label：自定义向设施显示的字段名称（例如“Branch ID”“Location Code”）
• Partner Prefix：为您的集成设置唯一前缀
• Integration Fields：配置您的集成专用的自定义字段

3. 合作伙伴详情

查看和管理您的合作伙伴资料信息。

可编辑字段：

• Partner Email：用于接收通知的主要联系邮箱
• Description：您的集成的简要说明
• Logo URL：您的合作伙伴徽标的 URL
• Website：您的公司或集成网站
• Category：集成类别分类
• Details：其他合作伙伴信息

只读信息：

• Partner ID（唯一标识符）
• 合作伙伴名称
• 集成状态
• 已连接组织数量

4. 日志

监控 API 活动并排查集成问题。

可用数据：

• API 请求日志
• 响应状态码
• 错误消息
• 时间戳信息
• 请求/响应负载

已连接的组织

查看已启用您的集成的所有组织。每张组织卡片显示：

• 组织名称
• 关联品牌
• 活跃设施数量
• 集成状态

Ask AI

使用 AI 助手（⌘I 快捷键）即时获取合作伙伴相关主题的帮助。

可询问的内容：

• API 端点的用法和示例
• 身份验证和密钥管理
• 数据同步最佳实践
• 排查常见集成问题
• Partner Console 功能和导航

合作伙伴关联方式

不同的合作伙伴或会员管理系统会使用各自的 ID 来标识每个设施或位置，例如分店 ID、门店编号或设施 ID。在同步或推送数据时，我们提供两种标识位置的方式。

1. 直接链接

推送数据时，合作伙伴使用 Performance Hub 系统中的设施 ID。

例如，合作伙伴 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 主设施视图）中的示例配置，显示在合作伙伴集成屏幕中配置的来自会员管理系统的关联标识符/内部 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"
      }
    ]
  }'