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.

Przykład: 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. 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

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