Konsola partnerska

Partner Console to interfejs webowy do zarządzania integracją z Performance Hub.

Jeśli nie masz jeszcze dostępu do Partner Console, skontaktuj się z nami, wysyłając zapytanie partnerskie za pośrednictwem głównej witryny Performance Hub. Nasz zespół przeprowadzi Cię przez proces wdrażania partnera i pomoże skonfigurować dostęp do konsoli.

Dostęp do konsoli

Aby uzyskać dostęp do Partner Console, potrzebujesz:

1. Partner ID — unikatowego identyfikatora, który Performance Hub przydziela każdemu partnerowi
2. One-Time Password (OTP) — kodu weryfikacyjnego wysyłanego na adres Partner Email

Zaloguj się na stronie partner-api.performancehub.co/partner/v1/console

Co zawiera konsola

Partner Console udostępnia narzędzia do zarządzania integracją z Performance Hub:

• Secret Keys — generowanie kluczy API o różnych poziomach dostępu (live, dryrun, read-only) i zarządzanie nimi
• Integration Settings — konfigurowanie sposobu łączenia integracji z obiektami
• Partner Details — wyświetlanie i aktualizowanie informacji w profilu partnera
• Logs — monitorowanie aktywności API i rozwiązywanie problemów
• Connected Organisations — przeglądanie wszystkich organizacji korzystających z integracji
• Ask AI — natychmiastowa pomoc za pomocą skrótu ⌘I

Szczegółowe informacje o każdej funkcji znajdziesz w sekcji Funkcje Partner Console.

Funkcje Partner Console

Partner Console zawiera cztery główne sekcje dostępne z kart nawigacji:

1. Klucze tajne

Zarządzaj tajnymi kluczami API z pełną kontrolą nad typami dostępu i uprawnieniami.

Najważniejsze funkcje:

• Create New Keys — generowanie nowych kluczy API o określonych poziomach dostępu
• Typy kluczy:
  • Live — pełny dostęp do odczytu i zapisu danych produkcyjnych
  • Dryrun — testowanie operacji zapisu bez wpływu na dane produkcyjne (zapisy są symulowane)
  • Read-only — dostęp tylko do odczytu, umożliwiający bezpieczne pobieranie danych (operacje zapisu są blokowane)
• Zarządzanie kluczami — wyświetlanie szczegółów klucza i znaczników czasu ostatniego użycia, rotacja kluczy i natychmiastowe unieważnianie kluczy
• Filtrowanie kluczy — filtrowanie kluczy według stanu (All, Active, Revoked)
• Rotacja kluczy — płynna rotacja kluczy bez przestojów

Dla każdego tajnego klucza wyświetlane są:

• Label — konfigurowalna nazwa ułatwiająca identyfikację
• Key ID — unikatowy identyfikator (w formacie UUID)
• Secret — częściowo zamaskowany tajny klucz (widoczne pierwsze 12 i ostatnie 4 znaki)
• Type — poziom dostępu klucza (live, dryrun, read-only)
• Status — bieżący stan (active, revoked)
• Created — data wygenerowania klucza
• Last Used — znacznik czasu ostatniego wywołania API
• Actions — rotacja lub unieważnienie klucza

2. Ustawienia integracji

Skonfiguruj sposób łączenia integracji z obiektami Performance Hub.

Najważniejsze funkcje:

• Data Linking Method — wybór jednej z dwóch metod łączenia:
  • Direct Link — używanie identyfikatorów obiektów Performance Hub w wywołaniach API
  • Linking Identifier — używanie własnych identyfikatorów lokalizacji (Branch ID, Store Number itp.)
  • Więcej informacji o metodach łączenia partnerów
• Linking Identifier Label — dostosowanie nazwy pola wyświetlanej obiektom (np. „Branch ID”, „Location Code”)
• Partner Prefix — ustawienie unikatowego prefiksu dla integracji
• Integration Fields — konfigurowanie pól niestandardowych specyficznych dla integracji

3. Szczegóły partnera

Przeglądaj informacje w profilu partnera i zarządzaj nimi.

Pola edytowalne:

• Partner Email — główny adres e-mail do kontaktu, na który wysyłane są powiadomienia
• Description — krótki opis integracji
• Logo URL — adres URL logo partnera
• Website — witryna firmy lub integracji
• Category — kategoria integracji
• Details — dodatkowe informacje o partnerze

Informacje tylko do odczytu:

• Partner ID (unikatowy identyfikator)
• Nazwa partnera
• Stan integracji
• Liczba połączonych organizacji

4. Logi

Monitoruj aktywność API i rozwiązuj problemy z integracją.

Dostępne dane:

• Dzienniki żądań API
• Kody stanu odpowiedzi
• Komunikaty o błędach
• Informacje o znacznikach czasu
• Treść żądań i odpowiedzi

Połączone organizacje

Przeglądaj wszystkie organizacje, które włączyły Twoją integrację. Na karcie każdej organizacji wyświetlane są:

• Nazwa organizacji
• Powiązane marki
• Liczba aktywnych obiektów
• Stan integracji

Ask AI

Uzyskaj natychmiastową pomoc w tematach związanych z partnerstwem za pomocą asystenta AI (skrót ⌘I).

O co można zapytać:

• Sposób korzystania z punktów końcowych API i przykłady
• Uwierzytelnianie i zarządzanie tajnymi kluczami
• Sprawdzone metody synchronizacji danych
• Rozwiązywanie typowych problemów z integracją
• Funkcje Partner Console i nawigacja

Metody łączenia partnerów

Różni partnerzy i systemy zarządzania członkami identyfikują każdy obiekt lub lokalizację za pomocą własnego identyfikatora, takiego jak identyfikator oddziału, numer sklepu lub identyfikator obiektu. Dostępne są dwa sposoby identyfikowania lokalizacji podczas synchronizowania lub przesyłania danych.

1. Bezpośredni link

Podczas przesyłania danych partner używa identyfikatora obiektu z systemu Performance Hub.

Na przykład wewnętrzny identyfikator Partnera A dla obiektu w Tokio to branch_tokyo. Aby jednak znormalizować dane w ekosystemie Performance Hub, przypisujemy tej lokalizacji i temu partnerowi nowy identyfikator, na przykład UUID: 550e8400-e29b-41d4-a716-446655440000.

Partnerzy powinni używać tego facility_id podczas wywoływania naszych interfejsów API w celu przesyłania danych.

Aby uzyskać prawidłowy facility_id do łączenia (wymagany w metodzie Direct Link), partnerzy mogą wywołać punkt końcowy API /partner/v1/facilities. Zwraca on listę wszystkich obiektów, które mają obecnie włączoną integrację partnera w Performance Hub, wraz z odpowiadającymi im wartościami facility_id.

2. Identyfikator powiązania

Partner prowadzi własny system z unikatowymi identyfikatorami dla każdej lokalizacji (np. „Branch ID”, „Location Code”, „Store Number”). Ta metoda łączenia pozwala partnerowi identyfikować obiekty Performance Hub za pomocą własnego identyfikatora zamiast naszego identyfikatora obiektu.

Konfiguracja obiektu: Gdy obiekt włącza tego partnera, zostaje poproszony o podanie w konfiguracji obiektu w Performance Hub unikatowego identyfikatora, którym partner oznacza tę lokalizację.

Integracja API: Podczas wywoływania interfejsów API Performance Hub partner może podać w żądaniu własny unikatowy identyfikator. Performance Hub wewnętrznie wyszukuje wartość linking_identifier, aby dopasować wywołanie API do właściwego obiektu.

Przykład: Jeśli partner nazywa lokalizacje w swoim systemie „Branch ID”, ustaw poniższą etykietę na „Branch ID”. Każdy obiekt poda wtedy swoją wartość Branch ID podczas włączania integracji, co umożliwi płynną synchronizację danych między systemami.

Przykładowa konfiguracja z ekranu integracji obiektu (główny widok obiektu w Performance Hub) przedstawiająca identyfikator łączący / identyfikator wewnętrzny z systemu zarządzania członkami, skonfigurowany na ekranie integracji partnera

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

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