Métodos de vinculación de socios

Cada socio o sistema de gestión de miembros identifica cada instalación o ubicación con su propio ID, como un ID de sucursal, un número de tienda o un ID de instalación. Tenemos dos formas de identificar las ubicaciones al sincronizar o enviar datos.

1. Enlace directo

Al enviar datos, el socio usa el ID de instalación del sistema del Performance Hub.

Por ejemplo, el ID interno que usa el socio A para una instalación en Tokio es branch_tokyo. Pero, para normalizar los datos dentro del ecosistema del Performance Hub, asignamos un nuevo ID a esta ubicación y a este socio, por ejemplo el UUID 550e8400-e29b-41d4-a716-446655440000.

Los socios deben usar este facility_id al llamar a nuestras API para enviar datos.

Para obtener el facility_id correcto para la vinculación (como exige el método Direct Link), los socios pueden llamar al endpoint de la API /partner/v1/facilities. Este endpoint devuelve una lista de todas las instalaciones que tienen habilitada tu integración de socio en el Performance Hub, junto con sus valores de facility_id correspondientes.

Ejemplo: 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. Identificador de enlace

El socio mantiene su propio sistema con identificadores únicos para cada ubicación (por ejemplo, "Branch ID", "Location Code" o "Store Number"). Este método de vinculación permite al socio identificar las instalaciones del Performance Hub con su propio identificador en lugar de nuestro ID de instalación.

Configuración de la instalación: cuando una instalación habilita a este socio, se le pide que indique, en la configuración de la instalación dentro del Performance Hub, el identificador único que el socio usa para identificar su ubicación.

Integración con la API: cuando el socio llama a la API del Performance Hub, puede proporcionar su propio identificador único en la solicitud. El Performance Hub busca internamente el linking_identifier para asociar la llamada a la API con la instalación correcta.

Ejemplo: si el socio llama "Branch ID" a las ubicaciones en su sistema, establece la etiqueta de abajo en "Branch ID". Luego, cada instalación proporcionará su valor de Branch ID al habilitar la integración, lo que permite sincronizar los datos entre los sistemas sin problemas.

Ejemplo de configuración desde una pantalla de integraciones de la instalación (vista principal de la instalación en Performance) que muestra el identificador de vinculación o ID interno del sistema de gestión de miembros configurado en la pantalla de integraciones de socios

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