Console partenaire

La Partner Console fournit une interface web pour gérer votre intégration avec Performance Hub.

Si vous n'avez pas encore accès à la Partner Console, contactez-nous en envoyant une demande de partenariat via le site principal de Performance Hub. Notre équipe vous accompagnera tout au long du processus d'intégration des partenaires et vous aidera à configurer votre accès à la console.

Accéder à la console

Pour accéder à la Partner Console, vous avez besoin de :

Partner ID - Un identifiant unique fourni par Performance Hub à chaque partenaire
Mot de passe à usage unique (OTP) - Un code de vérification envoyé à votre adresse e-mail de partenaire

Connectez-vous sur partner-api.performancehub.co/partner/v1/console

Contenu de la console

La Partner Console fournit des outils pour gérer votre intégration avec Performance Hub :

Secret Keys - Générez et gérez des clés API avec différents niveaux d'accès (live, dryrun, read-only)
Integration Settings - Configurez la façon dont votre intégration est liée aux installations
Partner Details - Consultez et mettez à jour les informations de votre profil de partenaire
Logs - Surveillez l'activité de l'API et résolvez les problèmes
Connected Organisations - Consultez toutes les organisations qui utilisent votre intégration
Ask AI - Obtenez une aide instantanée avec le raccourci ⌘I

Pour plus d'informations sur chaque fonctionnalité, consultez Fonctionnalités de la Partner Console.

Fonctionnalités de la Partner Console

La Partner Console comprend quatre sections principales accessibles via les onglets de navigation :

1. Clés secrètes

Gérez vos clés secrètes API en contrôlant entièrement les types d'accès et les autorisations.

Fonctionnalités principales :

Création de clés - Générez de nouvelles clés API avec des niveaux d'accès spécifiques
Types de clés :
- Live - Accès complet en lecture et en écriture aux données de production
- Dryrun - Testez les opérations d'écriture sans affecter les données de production (les écritures sont simulées)
- Read-only - Accès en lecture seule pour une consommation des données en toute sécurité (opérations d'écriture bloquées)
Gestion des clés - Consultez les détails des clés et leur date de dernière utilisation, effectuez la rotation des clés et révoquez-les instantanément
Filtrage des clés - Filtrez les clés par statut (All, Active, Revoked)
Rotation des clés - Effectuez la rotation des clés en toute transparence, sans interruption de service

Chaque clé secrète affiche :

Label - Nom personnalisable pour une identification facile
Key ID - Identifiant unique (format UUID)
Secret - Clé secrète partiellement masquée (les 12 premiers et les 4 derniers caractères sont visibles)
Type - Niveau d'accès de la clé (live, dryrun, read-only)
Status - État actuel (active, revoked)
Created - Date de génération de la clé
Last Used - Horodatage de l'appel API le plus récent
Actions - Rotation ou révocation de la clé

2. Paramètres d'intégration

Configurez la façon dont votre intégration est liée aux installations Performance Hub.

Fonctionnalités principales :

Data Linking Method - Choisissez entre deux méthodes de liaison :
- Direct Link - Utilisez les ID d'installation Performance Hub pour les appels API
- Linking Identifier - Utilisez vos propres identifiants de site (Branch ID, Store Number, etc.)
- En savoir plus sur les méthodes de liaison des partenaires
Linking Identifier Label - Personnalisez le nom du champ affiché aux installations (par exemple, « Branch ID », « Location Code »)
Partner Prefix - Définissez un préfixe unique pour vos intégrations
Integration Fields - Configurez des champs personnalisés propres à votre intégration

3. Détails du partenaire

Consultez et gérez les informations de votre profil de partenaire.

Champs modifiables :

Partner Email - Adresse e-mail de contact principale pour les notifications
Description - Brève description de votre intégration
Logo URL - URL du logo de votre entreprise partenaire
Website - Site web de votre entreprise ou de votre intégration
Category - Catégorie de l'intégration
Details - Informations complémentaires sur le partenaire

Informations en lecture seule :

Partner ID (identifiant unique)
Nom du partenaire
Statut de l'intégration
Nombre d'organisations connectées

4. Journaux

Surveillez l'activité de l'API et résolvez les problèmes d'intégration.

Données disponibles :

Journaux des requêtes API
Codes de statut des réponses
Messages d'erreur
Informations d'horodatage
Charges utiles des requêtes et des réponses

Organisations connectées

Consultez toutes les organisations qui ont activé votre intégration. Chaque carte d'organisation affiche :

Le nom de l'organisation
Les marques associées
Le nombre d'installations actives
Le statut de l'intégration

Ask AI

Obtenez une aide instantanée sur les sujets liés aux partenaires grâce à l'assistant IA (raccourci ⌘I).

Questions possibles :

Utilisation des endpoints de l'API et exemples
Authentification et gestion des clés secrètes
Bonnes pratiques de synchronisation des données
Résolution des problèmes d'intégration courants
Fonctionnalités et navigation de la Partner Console

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.

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

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