Koppelmethoden voor partners

Verschillende partners of ledenbeheersystemen identificeren elke faciliteit of locatie met hun eigen ID, zoals een vestigings-ID, winkelnummer of faciliteit-ID. Er zijn twee manieren om locaties te identificeren bij het synchroniseren of pushen van gegevens.

1. Directe koppeling

Bij het pushen van gegevens gebruikt de partner het faciliteit-ID uit het Performance Hub-systeem.

Partner A gebruikt bijvoorbeeld intern het ID branch_tokyo voor een faciliteit in Tokio. Om de gegevens binnen het Performance Hub-ecosysteem te normaliseren, kennen wij voor deze locatie en deze partner een nieuw ID toe, bijvoorbeeld de UUID 550e8400-e29b-41d4-a716-446655440000.

Partners gebruiken dit facility_id wanneer ze onze API's aanroepen om gegevens te pushen.

Om het juiste facility_id voor de koppeling te verkrijgen (zoals vereist bij de methode Direct Link), kunnen partners het API-endpoint /partner/v1/facilities aanroepen. Dit endpoint retourneert een lijst van alle faciliteiten die je partnerintegratie momenteel in Performance Hub hebben ingeschakeld, samen met de bijbehorende facility_id-waarden.

Voorbeeld: 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. Koppeling identificatie

De partner beheert een eigen systeem met unieke identificaties voor elke locatie (bijvoorbeeld "Branch ID", "Location Code", "Store Number"). Met deze koppelmethode kan de partner Performance Hub-faciliteiten identificeren met de eigen identificatie in plaats van met ons faciliteit-ID.

Configuratie van de faciliteit: Wanneer een faciliteit deze partner inschakelt, wordt gevraagd om in de faciliteitconfiguratie in de Performance Hub de unieke identificatie op te geven die de partner gebruikt om die locatie te identificeren.

API-integratie: Wanneer de partner API-aanroepen naar Performance Hub doet, kan de partner de eigen unieke identificatie in het verzoek meegeven. Performance Hub zoekt intern de linking_identifier op om de API-aanroep aan de juiste faciliteit te koppelen.

Voorbeeld: Als de partner locaties in het eigen systeem "Branch ID" noemt, stel je het label hieronder in op "Branch ID". Elke faciliteit geeft dan de eigen Branch ID-waarde op bij het inschakelen van de integratie, zodat gegevens naadloos tussen de systemen worden gesynchroniseerd.

Voorbeeldconfiguratie uit het integratiescherm van een faciliteit (hoofdweergave van de faciliteit in Performance Hub) met de koppelidentificatie / het interne ID uit het ledenbeheersysteem, geconfigureerd in het scherm met partnerintegraties

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