Metodi di collegamento dei partner

Partner e sistemi di gestione dei membri diversi identificano ogni struttura o sede con un proprio ID, ad esempio un ID filiale, un numero di negozio o un ID struttura. Esistono due modi per identificare le sedi durante la sincronizzazione o l'invio dei dati.

1. Collegamento Diretto

Quando invia i dati, il partner usa l'ID della struttura del sistema Performance Hub.

Ad esempio, il Partner A usa internamente l'ID branch_tokyo per una struttura a Tokyo. Per normalizzare i dati all'interno dell'ecosistema Performance Hub, però, assegniamo un nuovo ID a questa sede e a questo partner, ad esempio l'UUID: 550e8400-e29b-41d4-a716-446655440000.

I partner devono usare questo facility_id quando chiamano le nostre API per inviare dati.

Per ottenere il facility_id corretto per il collegamento (come richiesto dal metodo Direct Link), i partner possono chiamare l'endpoint API /partner/v1/facilities. Questo endpoint restituisce l'elenco di tutte le strutture che hanno attualmente attivato la tua integrazione partner nel Performance Hub, insieme ai relativi valori facility_id.

Esempio: 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. Identificativo di Collegamento

Il partner gestisce un proprio sistema con identificatori univoci per ogni sede (ad esempio "Branch ID", "Location Code", "Store Number"). Questo metodo di collegamento consente al partner di identificare le strutture del Performance Hub con il proprio identificatore anziché con il nostro ID della struttura.

Configurazione della struttura: quando una struttura attiva questo partner, le viene chiesto di indicare, nella configurazione della struttura all'interno del Performance Hub, l'identificatore univoco che il partner usa per identificare la sua sede.

Integrazione API: quando effettua chiamate API al Performance Hub, il partner può indicare nella richiesta il proprio identificatore univoco. Il Performance Hub cerca internamente il linking_identifier per associare la chiamata API alla struttura corretta.

Esempio: se nel suo sistema il partner chiama le sedi "Branch ID", imposta l'etichetta qui sotto su "Branch ID". Ogni struttura indicherà poi il proprio valore di Branch ID quando attiva l'integrazione, consentendo una sincronizzazione dei dati senza interruzioni tra i sistemi.

Esempio di configurazione dalla schermata Integrazioni della struttura (vista principale della struttura nel Performance Hub) che mostra l'identificatore di collegamento / ID interno del sistema di gestione dei membri configurato nella schermata delle integrazioni partner

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