Способы связи партнера

Разные партнеры и системы управления участниками идентифицируют каждый объект или площадку по собственному идентификатору, например по идентификатору филиала, номеру магазина или идентификатору объекта. Мы поддерживаем два способа идентификации площадок при синхронизации или отправке данных.

1. Прямая ссылка

При отправке данных партнер использует идентификатор объекта из системы Performance Hub.

Например, у партнера A внутренний идентификатор объекта в Токио — branch_tokyo. Но чтобы нормализовать данные в экосистеме Performance Hub, мы назначаем этой площадке и этому партнеру новый идентификатор, например UUID: 550e8400-e29b-41d4-a716-446655440000.

При вызове наших API для отправки данных партнерам следует использовать этот facility_id.

Чтобы получить правильный facility_id для связи (как требуется в способе Direct Link), партнеры могут вызвать конечную точку API /partner/v1/facilities. Она возвращает список всех объектов, у которых в Performance Hub сейчас включена ваша партнерская интеграция, вместе с соответствующими значениями facility_id.

Пример: 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. Идентификатор связи

Партнер ведет собственную систему с уникальными идентификаторами для каждой площадки (например, "Branch ID", "Location Code", "Store Number"). Этот способ связи позволяет партнеру идентифицировать объекты Performance Hub по собственному идентификатору, а не по нашему идентификатору объекта.

Настройка объекта: когда объект включает этого партнера, ему будет предложено указать в конфигурации объекта в Performance Hub уникальный идентификатор, которым партнер обозначает эту площадку.

Интеграция через API: при вызове API Performance Hub партнер может указывать в запросе собственный уникальный идентификатор. Performance Hub выполнит внутренний поиск по linking_identifier, чтобы сопоставить вызов API с нужным объектом.

Пример: если в системе партнера площадки называются "Branch ID", задайте для метки ниже значение "Branch ID". Тогда каждый объект при включении интеграции укажет свое значение Branch ID, что обеспечит беспрепятственную синхронизацию данных между системами.

Пример конфигурации на экране интеграций объекта (основное представление объекта в Performance Hub): связующий идентификатор (внутренний идентификатор из системы управления участниками), настроенный на экране партнерских интеграций

Пример: 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"
      }
    ]
  }'