Консоль партнера

Partner Console — это веб-интерфейс для управления вашей интеграцией с Performance Hub.

Если у вас еще нет доступа к Partner Console, свяжитесь с нами, отправив запрос партнера через основной сайт Performance Hub. Наша команда проведет вас через процесс подключения партнера и поможет настроить доступ к консоли.

Доступ к консоли

Для доступа к Partner Console вам понадобятся:

1. Partner ID — уникальный идентификатор, который Performance Hub выдает каждому партнеру
2. One-Time Password (OTP) — одноразовый код подтверждения, отправляемый на ваш адрес Partner Email

Войдите по адресу partner-api.performancehub.co/partner/v1/console

Что есть в консоли

Partner Console предоставляет инструменты для управления вашей интеграцией с Performance Hub:

• Secret Keys — создание ключей API с разными уровнями доступа (live, dryrun, read-only) и управление ими
• Integration Settings — настройка способа связи вашей интеграции с объектами
• Partner Details — просмотр и обновление сведений профиля партнера
• Logs — мониторинг активности API и устранение неполадок
• Connected Organisations — просмотр всех организаций, использующих вашу интеграцию
• Ask AI — мгновенная помощь по сочетанию клавиш ⌘I

Подробные сведения о каждой функции см. в разделе Функции Partner Console.

Функции Partner Console

Partner Console состоит из четырех основных разделов, доступных через вкладки навигации:

1. Секретные ключи

Управляйте секретными ключами API с полным контролем над типами доступа и разрешениями.

Основные возможности:

• Create New Keys — создание новых ключей API с определенными уровнями доступа
• Key Types:
  • Live — полный доступ на чтение и запись к рабочим данным
  • Dryrun — тестирование операций записи без влияния на рабочие данные (запись имитируется)
  • Read-only — доступ только на чтение для безопасного получения данных (операции записи заблокированы)
• Key Management — просмотр сведений о ключе и времени последнего использования, ротация и мгновенный отзыв ключей
• Key Filtering — фильтрация ключей по состоянию (All, Active, Revoked)
• Key Rotation — ротация ключей без простоя

Для каждого секретного ключа отображаются:

• Label — настраиваемое имя для удобной идентификации
• Key ID — уникальный идентификатор (в формате UUID)
• Secret — частично скрытый секретный ключ (видны первые 12 и последние 4 символа)
• Type — уровень доступа ключа (live, dryrun, read-only)
• Status — текущее состояние (active, revoked)
• Created — дата создания ключа
• Last Used — время последнего вызова API
• Actions — ротация или отзыв ключа

2. Настройки интеграции

Настройте способ связи вашей интеграции с объектами Performance Hub.

Основные возможности:

• Data Linking Method — выбор одного из двух способов связи:
  • Direct Link — использование идентификаторов объектов Performance Hub в вызовах API
  • Linking Identifier — использование собственных идентификаторов площадок (Branch ID, Store Number и т. п.)
  • Подробнее о способах связи партнера
• Linking Identifier Label — настройка названия поля, отображаемого для объектов (например, "Branch ID", "Location Code")
• Partner Prefix — уникальный префикс для ваших интеграций
• Integration Fields — настройка пользовательских полей, специфичных для вашей интеграции

3. Данные партнера

Просматривайте сведения профиля партнера и управляйте ими.

Редактируемые поля:

• Partner Email — основной контактный адрес электронной почты для уведомлений
• Description — краткое описание вашей интеграции
• Logo URL — URL-адрес логотипа партнера
• Website — сайт вашей компании или интеграции
• Category — категория интеграции
• Details — дополнительные сведения о партнере

Сведения только для чтения:

• Partner ID (уникальный идентификатор)
• Имя партнера
• Состояние интеграции
• Количество подключенных организаций

4. Журналы

Отслеживайте активность API и устраняйте неполадки интеграции.

Доступные данные:

• Журналы запросов API
• Коды состояния ответов
• Сообщения об ошибках
• Сведения о времени
• Полезная нагрузка запросов и ответов

Подключенные организации

Просматривайте все организации, включившие вашу интеграцию. На карточке каждой организации отображаются:

• Название организации
• Связанные бренды
• Количество активных объектов
• Состояние интеграции

Ask AI

Получайте мгновенную помощь по партнерским вопросам с помощью ИИ-помощника (сочетание клавиш ⌘I).

О чем можно спросить:

• Использование конечных точек API и примеры
• Аутентификация и управление секретными ключами
• Рекомендации по синхронизации данных
• Устранение распространенных неполадок интеграции
• Функции Partner Console и навигация по ней

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

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

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.

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): связующий идентификатор (внутренний идентификатор из системы управления участниками), настроенный на экране партнерских интеграций

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