Partnerconsole

De Partner Console biedt een webinterface voor het beheren van je integratie met Performance Hub.

Heb je nog geen toegang tot de Partner Console? Neem dan contact met ons op door een partneraanvraag in te dienen via de Performance Hub-hoofdwebsite. Ons team begeleidt je door het onboardingproces voor partners en helpt je om toegang tot de console in te stellen.

Toegang tot de console

Voor toegang tot de Partner Console heb je het volgende nodig:

Partner ID - Een unieke identificatie die Performance Hub aan elke partner verstrekt
One-Time Password (OTP) - Een verificatiecode die naar je partner-e-mailadres wordt verzonden

Meld je aan op partner-api.performancehub.co/partner/v1/console

Wat de console bevat

De Partner Console biedt tools om je integratie met Performance Hub te beheren:

Secret Keys - Genereer en beheer API-sleutels met verschillende toegangsniveaus (live, dryrun, read-only)
Integration Settings - Configureer hoe je integratie aan faciliteiten wordt gekoppeld
Partner Details - Bekijk en werk de gegevens van je partnerprofiel bij
Logs - Volg API-activiteit en los problemen op
Connected Organisations - Bekijk alle organisaties die je integratie gebruiken
Ask AI - Krijg direct hulp met de sneltoets ⌘I

Zie Functies van de Partner Console voor uitgebreide informatie over elke functie.

Functies van de Partner Console

De Partner Console bevat vier hoofdsecties die je via de navigatietabbladen opent:

1. Geheime sleutels

Beheer je geheime API-sleutels met volledige controle over toegangstypen en machtigingen.

Belangrijkste functies:

Create New Keys - Genereer nieuwe API-sleutels met specifieke toegangsniveaus
Sleuteltypen:
- Live - Volledige lees- en schrijftoegang tot productiegegevens
- Dryrun - Test schrijfbewerkingen zonder productiegegevens te beïnvloeden (schrijfbewerkingen worden gesimuleerd)
- Read-only - Alleen-lezentoegang voor veilig gebruik van gegevens (schrijfbewerkingen worden geblokkeerd)
Sleutelbeheer - Bekijk sleutelgegevens en tijdstempels van laatste gebruik, roteer sleutels en trek sleutels direct in
Sleutels filteren - Filter sleutels op status (All, Active, Revoked)
Sleutelrotatie - Roteer sleutels naadloos zonder downtime

Bij elke geheime sleutel wordt het volgende weergegeven:

Label - Aanpasbare naam zodat je de sleutel makkelijk herkent
Key ID - Unieke identificatie (UUID-indeling)
Secret - Gedeeltelijk afgeschermde geheime sleutel (de eerste 12 en laatste 4 tekens zijn zichtbaar)
Type - Toegangsniveau van de sleutel (live, dryrun, read-only)
Status - Huidige status (active, revoked)
Created - Datum waarop de sleutel is gegenereerd
Last Used - Tijdstempel van de meest recente API-aanroep
Actions - Sleutel roteren of intrekken

2. Integratie-instellingen

Configureer hoe je integratie aan Performance Hub-faciliteiten wordt gekoppeld.

Belangrijkste functies:

Data Linking Method - Kies tussen twee koppelmethoden:
- Direct Link - Gebruik faciliteit-ID's van Performance Hub voor API-aanroepen
- Linking Identifier - Gebruik je eigen locatie-identificaties (Branch ID, Store Number, enzovoort)
- Meer informatie over koppelmethoden voor partners
Linking Identifier Label - Pas de veldnaam aan die aan faciliteiten wordt getoond (bijvoorbeeld "Branch ID", "Location Code")
Partner Prefix - Stel een uniek voorvoegsel in voor je integraties
Integration Fields - Configureer aangepaste velden die specifiek zijn voor je integratie

3. Partnergegevens

Bekijk en beheer de gegevens van je partnerprofiel.

Bewerkbare velden:

Partner Email - Primair contact-e-mailadres voor meldingen
Description - Korte beschrijving van je integratie
Logo URL - URL naar je partnerlogo
Website - De website van je bedrijf of integratie
Category - Categorie-indeling van de integratie
Details - Aanvullende partnergegevens

Alleen-lezengegevens:

Partner-ID (unieke identificatie)
Partnernaam
Integratiestatus
Aantal gekoppelde organisaties

4. Logboeken

Volg API-activiteit en los integratieproblemen op.

Beschikbare gegevens:

Logboeken van API-verzoeken
Statuscodes van responses
Foutmeldingen
Tijdstempelgegevens
Payloads van verzoeken en responses

Verbonden organisaties

Bekijk alle organisaties die je integratie hebben ingeschakeld. Elke organisatiekaart toont:

Organisatienaam
Gekoppelde merken
Aantal actieve faciliteiten
Integratiestatus

Ask AI

Krijg direct hulp bij partneronderwerpen met de AI-assistent (sneltoets ⌘I).

Vraag bijvoorbeeld naar:

Gebruik van API-endpoints en voorbeelden
Authenticatie en beheer van geheime sleutels
Best practices voor gegevenssynchronisatie
Het oplossen van veelvoorkomende integratieproblemen
Functies en navigatie van de Partner Console

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.

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

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