Bảng điều khiển đối tác

Partner Console cung cấp giao diện web để quản lý tích hợp của bạn với Performance Hub.

Nếu bạn chưa có quyền truy cập Partner Console, vui lòng liên hệ với chúng tôi bằng cách gửi yêu cầu hợp tác qua trang web chính của Performance Hub. Đội ngũ của chúng tôi sẽ hướng dẫn bạn qua quy trình tiếp nhận đối tác và giúp thiết lập quyền truy cập console.

Truy cập Console

Để truy cập Partner Console, bạn cần:

1. Partner ID - Mã định danh duy nhất mà Performance Hub cấp cho từng đối tác
2. One-Time Password (OTP) - Mã xác minh được gửi đến Partner Email của bạn

Đăng nhập tại partner-api.performancehub.co/partner/v1/console

Console có những gì

Partner Console cung cấp các công cụ để quản lý tích hợp của bạn với Performance Hub:

• Secret Keys - Tạo và quản lý khóa API với các cấp độ truy cập khác nhau (live, dryrun, read-only)
• Integration Settings - Cấu hình cách tích hợp của bạn liên kết với các cơ sở
• Partner Details - Xem và cập nhật thông tin hồ sơ đối tác của bạn
• Logs - Theo dõi hoạt động API và khắc phục sự cố
• Connected Organisations - Xem tất cả các tổ chức đang sử dụng tích hợp của bạn
• Ask AI - Nhận trợ giúp tức thì bằng phím tắt ⌘I

Để biết thông tin chi tiết về từng tính năng, hãy xem Các tính năng của Partner Console.

Các tính năng của Partner Console

Partner Console gồm bốn phần chính, có thể truy cập qua các thẻ điều hướng:

1. Khóa bí mật

Quản lý các khóa bí mật API với toàn quyền kiểm soát loại truy cập và quyền hạn.

Tính năng chính:

• Create New Keys - Tạo khóa API mới với các cấp độ truy cập cụ thể
• Các loại khóa:
  • Live - Toàn quyền đọc và ghi đối với dữ liệu thực tế (production)
  • Dryrun - Kiểm thử các thao tác ghi mà không ảnh hưởng đến dữ liệu thực tế (các thao tác ghi được mô phỏng)
  • Read-only - Quyền chỉ đọc để sử dụng dữ liệu an toàn (các thao tác ghi bị chặn)
• Quản lý khóa - Xem chi tiết khóa, thời điểm sử dụng gần nhất, xoay vòng khóa và thu hồi khóa ngay lập tức
• Lọc khóa - Lọc khóa theo trạng thái (All, Active, Revoked)
• Xoay vòng khóa - Xoay vòng khóa liền mạch mà không gây gián đoạn

Mỗi khóa bí mật hiển thị:

• Label - Tên tùy chỉnh để dễ nhận biết
• Key ID - Mã định danh duy nhất (định dạng UUID)
• Secret - Khóa bí mật được che một phần (hiển thị 12 ký tự đầu và 4 ký tự cuối)
• Type - Cấp độ truy cập của khóa (live, dryrun, read-only)
• Status - Trạng thái hiện tại (active, revoked)
• Created - Ngày tạo khóa
• Last Used - Thời điểm của lệnh gọi API gần nhất
• Actions - Xoay vòng hoặc thu hồi khóa

2. Cài đặt tích hợp

Cấu hình cách tích hợp của bạn liên kết với các cơ sở trong Performance Hub.

Tính năng chính:

• Data Linking Method - Chọn một trong hai phương thức liên kết:
  • Direct Link - Sử dụng ID cơ sở của Performance Hub cho các lệnh gọi API
  • Linking Identifier - Sử dụng mã định danh địa điểm của riêng bạn (Branch ID, Store Number, v.v.)
  • Tìm hiểu thêm về các phương thức liên kết đối tác
• Linking Identifier Label - Tùy chỉnh tên trường hiển thị cho các cơ sở (ví dụ: "Branch ID", "Location Code")
• Partner Prefix - Đặt tiền tố duy nhất cho các tích hợp của bạn
• Integration Fields - Cấu hình các trường tùy chỉnh dành riêng cho tích hợp của bạn

3. Chi tiết đối tác

Xem và quản lý thông tin hồ sơ đối tác của bạn.

Các trường có thể chỉnh sửa:

• Partner Email - Email liên hệ chính để nhận thông báo
• Description - Mô tả ngắn gọn về tích hợp của bạn
• Logo URL - URL dẫn đến logo đối tác của bạn
• Website - Trang web của công ty hoặc của tích hợp
• Category - Phân loại danh mục tích hợp
• Details - Thông tin bổ sung về đối tác

Thông tin chỉ đọc:

• Partner ID (mã định danh duy nhất)
• Tên đối tác
• Trạng thái tích hợp
• Số lượng tổ chức đã kết nối

4. Nhật ký

Theo dõi hoạt động API và khắc phục sự cố tích hợp.

Dữ liệu có sẵn:

• Nhật ký yêu cầu API
• Mã trạng thái phản hồi
• Thông báo lỗi
• Thông tin dấu thời gian
• Payload của yêu cầu/phản hồi

Các tổ chức đã kết nối

Xem tất cả các tổ chức đã bật tích hợp của bạn. Mỗi thẻ tổ chức hiển thị:

• Tên tổ chức
• Các thương hiệu liên kết
• Số lượng cơ sở đang hoạt động
• Trạng thái tích hợp

Ask AI

Nhận trợ giúp tức thì về các chủ đề liên quan đến đối tác bằng trợ lý AI (phím tắt ⌘I).

Bạn có thể hỏi về:

• Cách sử dụng endpoint API và ví dụ
• Xác thực và quản lý khóa bí mật
• Các phương pháp hay nhất để đồng bộ dữ liệu
• Khắc phục các sự cố tích hợp thường gặp
• Các tính năng và cách điều hướng trong Partner Console

Các phương thức liên kết đối tác

Mỗi đối tác hoặc hệ thống quản lý hội viên xác định từng cơ sở hoặc địa điểm bằng ID riêng của họ, chẳng hạn ID chi nhánh, số cửa hàng hoặc ID cơ sở. Chúng tôi có hai cách để xác định địa điểm khi đồng bộ hoặc đẩy dữ liệu.

1. Liên kết trực tiếp

Khi đẩy dữ liệu, đối tác sẽ sử dụng ID cơ sở từ hệ thống Performance Hub.

Ví dụ, với Đối tác A, ID nội bộ của họ cho một cơ sở ở Tokyo là branch_tokyo. Tuy nhiên, để chuẩn hóa dữ liệu trong hệ sinh thái Performance Hub, chúng tôi gán một ID mới cho địa điểm này và đối tác này, ví dụ UUID: 550e8400-e29b-41d4-a716-446655440000.

Đối tác nên sử dụng facility_id này khi gọi API của chúng tôi để đẩy dữ liệu.

Để lấy đúng facility_id cho việc liên kết (theo yêu cầu của phương thức Direct Link), đối tác có thể gọi endpoint API /partner/v1/facilities. Endpoint này sẽ trả về danh sách tất cả các cơ sở hiện đang bật tích hợp đối tác của bạn trong Performance Hub, cùng với các giá trị facility_id tương ứng.

2. Định danh liên kết

Đối tác duy trì hệ thống riêng với mã định danh duy nhất cho từng địa điểm (ví dụ: "Branch ID", "Location Code", "Store Number"). Phương thức liên kết này cho phép đối tác xác định các cơ sở trong Performance Hub bằng mã định danh của riêng họ thay vì ID cơ sở của chúng tôi.

Thiết lập cơ sở: Khi một cơ sở bật đối tác này, cơ sở đó sẽ được yêu cầu cung cấp mã định danh duy nhất mà đối tác dùng để xác định địa điểm của họ, trong phần cấu hình cơ sở trên Performance Hub.

Tích hợp API: Khi đối tác thực hiện lệnh gọi API đến Performance Hub, họ có thể cung cấp mã định danh duy nhất của riêng mình trong yêu cầu. Performance Hub sẽ tra cứu nội bộ linking_identifier để khớp lệnh gọi API với đúng cơ sở.

Ví dụ: Nếu đối tác gọi các địa điểm là "Branch ID" trong hệ thống của họ, hãy đặt nhãn bên dưới thành "Branch ID". Khi đó, mỗi cơ sở sẽ cung cấp giá trị Branch ID của mình khi bật tích hợp, giúp đồng bộ dữ liệu liền mạch giữa các hệ thống.

Ví dụ về cấu hình từ màn hình Tích hợp của cơ sở (giao diện cơ sở chính của Performance Hub), cho thấy mã định danh liên kết / ID nội bộ từ hệ thống quản lý hội viên được cấu hình trong màn hình tích hợp đối tác

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