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 功能和导航