Méthodes de liaison des partenaires

Chaque partenaire ou système de gestion des membres identifie chaque installation ou site par son propre ID, comme un ID d'agence, un numéro de magasin ou un ID d'installation. Nous proposons deux façons d'identifier les sites lors de la synchronisation ou de l'envoi de données.

1. Lien direct

Lors de l'envoi de données, le partenaire utilise l'ID d'installation du système Performance Hub.

Par exemple, pour le partenaire A, l'ID interne d'une installation à Tokyo est branch_tokyo. Mais pour normaliser les données au sein de l'écosystème Performance Hub, nous attribuons un nouvel ID à ce site et à ce partenaire, par exemple l'UUID : 550e8400-e29b-41d4-a716-446655440000.

Les partenaires doivent utiliser ce facility_id lorsqu'ils appellent nos API pour envoyer des données.

Pour obtenir le facility_id correct à utiliser pour la liaison (comme l'exige la méthode Direct Link), les partenaires peuvent appeler l'endpoint d'API /partner/v1/facilities. Cet endpoint renvoie la liste de toutes les installations pour lesquelles votre intégration partenaire est actuellement activée dans Performance Hub, avec leurs valeurs facility_id correspondantes.

Exemple : 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. Identifiant de liaison

Le partenaire gère son propre système avec des identifiants uniques pour chaque site (par exemple, « Branch ID », « Location Code », « Store Number »). Cette méthode de liaison permet au partenaire d'identifier les installations Performance Hub à l'aide de son propre identifiant plutôt que de notre ID d'installation.

Configuration de l'installation : lorsqu'une installation active ce partenaire, elle est invitée à saisir, dans la configuration de son installation dans Performance Hub, l'identifiant unique que le partenaire utilise pour identifier son site.

Intégration API : lorsque le partenaire effectue des appels API vers Performance Hub, il peut fournir son propre identifiant unique dans la requête. Performance Hub recherche alors en interne le linking_identifier pour associer l'appel API à la bonne installation.

Exemple : si le partenaire désigne les sites par « Branch ID » dans son système, définissez le libellé ci-dessous sur « Branch ID ». Chaque installation fournira alors sa valeur Branch ID lors de l'activation de l'intégration, ce qui permet une synchronisation transparente des données entre les systèmes.

Exemple de configuration depuis un écran d'intégrations d'installation (vue principale de l'installation dans Performance Hub) montrant l'identifiant de liaison / l'ID interne du système de gestion des membres configuré dans l'écran des intégrations partenaires

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