Partner-Verknüpfungsmethoden

Verschiedene Partner oder Mitgliederverwaltungssysteme identifizieren jede Einrichtung bzw. jeden Standort anhand ihrer eigenen ID, etwa einer Filial-ID, einer Filialnummer oder einer Einrichtungs-ID. Für die Identifizierung von Standorten beim Synchronisieren oder Übertragen von Daten gibt es zwei Möglichkeiten.

1. Direkter Link

Beim Übertragen von Daten verwendet der Partner die Einrichtungs-ID aus dem Performance Hub-System.

Beispiel: Partner A verwendet für eine Einrichtung in Tokio intern die ID branch_tokyo. Um die Daten im Performance Hub-Ökosystem zu normalisieren, weisen wir diesem Standort für diesen Partner jedoch eine neue ID zu, zum Beispiel die UUID 550e8400-e29b-41d4-a716-446655440000.

Partner sollten diese facility_id verwenden, wenn sie unsere APIs aufrufen, um Daten zu übertragen.

Um die richtige facility_id für die Verknüpfung zu erhalten (wie bei der Methode Direct Link erforderlich), können Partner den API-Endpunkt /partner/v1/facilities aufrufen. Dieser Endpunkt gibt eine Liste aller Einrichtungen zurück, bei denen Ihre Partnerintegration im Performance Hub derzeit aktiviert ist, zusammen mit den zugehörigen facility_id-Werten.

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

2. Verknüpfungskennung

Der Partner pflegt ein eigenes System mit eindeutigen Kennungen für jeden Standort (z. B. „Branch ID“, „Location Code“, „Store Number“). Mit dieser Verknüpfungsmethode kann der Partner Einrichtungen im Performance Hub anhand seiner eigenen Kennung statt unserer Einrichtungs-ID identifizieren.

Konfiguration der Einrichtung: Wenn eine Einrichtung diesen Partner aktiviert, wird sie aufgefordert, in ihrer Einrichtungskonfiguration im Performance Hub die eindeutige Kennung anzugeben, mit der der Partner ihren Standort identifiziert.

API-Integration: Wenn der Partner API-Aufrufe an den Performance Hub sendet, kann er seine eigene eindeutige Kennung in der Anfrage angeben. Der Performance Hub sucht intern den linking_identifier, um den API-Aufruf der richtigen Einrichtung zuzuordnen.

Beispiel: Wenn der Partner Standorte in seinem System als „Branch ID“ bezeichnet, legen Sie die Bezeichnung unten auf „Branch ID“ fest. Jede Einrichtung gibt dann beim Aktivieren der Integration ihren Branch-ID-Wert an, was eine nahtlose Datensynchronisierung zwischen den Systemen ermöglicht.

Beispielkonfiguration aus einem Integrationsbildschirm der Einrichtung (Hauptansicht der Einrichtung im Performance Hub), die den Linking Identifier bzw. die interne ID aus dem Mitgliederverwaltungssystem zeigt, wie sie im Bildschirm für Partnerintegrationen konfiguriert ist

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