파트너 콘솔

Partner Console은 Performance Hub와의 통합을 관리할 수 있는 웹 인터페이스를 제공합니다.

아직 Partner Console에 액세스할 수 없다면 Performance Hub 기본 웹사이트에서 파트너 문의를 제출하여 연락해 주십시오. 저희 팀이 파트너 온보딩 과정을 안내하고 콘솔 액세스 설정을 도와드립니다.

콘솔 액세스

Partner Console에 액세스하려면 다음이 필요합니다.

  1. Partner ID - Performance Hub가 각 파트너에게 제공하는 고유 식별자
  2. One-Time Password (OTP) - 파트너 이메일로 전송되는 인증 코드

partner-api.performancehub.co/partner/v1/console에서 로그인하십시오.

partner-console-dashboard.png

콘솔 구성

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 키를 생성합니다
  • 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 - 두 가지 연결 방법 중에서 선택합니다.
  • 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")를 갖춘 자체 시스템을 운영합니다. 이 연결 방법을 사용하면 파트너가 Performance Hub의 시설 ID 대신 자체 식별자로 Performance Hub 시설을 식별할 수 있습니다.

시설 설정: 시설에서 이 파트너를 활성화하면 Performance Hub의 시설 구성에서 파트너가 해당 위치를 식별하는 데 사용하는 고유 식별자를 입력하라는 메시지가 표시됩니다.

API 통합: 파트너가 Performance Hub에 API를 호출할 때 요청에 자체 고유 식별자를 제공할 수 있습니다. Performance Hub는 내부적으로 linking_identifier를 조회하여 API 호출을 올바른 시설과 일치시킵니다.

예시: 파트너가 자체 시스템에서 위치를 "Branch ID"라고 부른다면 아래 레이블을 "Branch ID"로 설정하십시오. 그러면 각 시설이 통합을 활성화할 때 Branch ID 값을 제공하므로 시스템 간에 데이터를 원활하게 동기화할 수 있습니다.

partner-console-facilities-partner-config.png 시설 통합 화면(Performance Hub 기본 시설 보기)의 구성 예시로, 파트너 통합 화면에 구성된 회원 관리 시스템의 연결 식별자/내부 ID를 보여 줍니다

예시: Direct Link

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"
      }
    ]
  }'

예시: Linking Identifier

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"
      }
    ]
  }'