Consola de socios

La Partner Console ofrece una interfaz web para administrar tu integración con el Performance Hub.

Si todavía no tienes acceso a la Partner Console, comunícate con nosotros enviando una consulta de socio desde el sitio web principal del Performance Hub. Nuestro equipo te guiará durante el proceso de incorporación de socios y te ayudará a configurar el acceso a la consola.

Acceder a la consola

Para acceder a la Partner Console, necesitas:

1. Partner ID: un identificador único que el Performance Hub proporciona a cada socio
2. One-Time Password (OTP): un código de verificación que se envía a tu Partner Email

Inicia sesión en partner-api.performancehub.co/partner/v1/console

Qué incluye la consola

La Partner Console ofrece herramientas para administrar tu integración con el Performance Hub:

• Secret Keys: genera y administra claves de API con distintos niveles de acceso (live, dryrun, read-only)
• Integration Settings: configura cómo se vincula tu integración con las instalaciones
• Partner Details: consulta y actualiza la información de tu perfil de socio
• Logs: supervisa la actividad de la API y soluciona problemas
• Connected Organisations: consulta todas las organizaciones que usan tu integración
• Ask AI: obtén ayuda al instante con el atajo ⌘I

Para obtener información detallada sobre cada función, consulta Funciones de la Partner Console.

Funciones de la Partner Console

La Partner Console incluye cuatro secciones principales, a las que se accede desde las pestañas de navegación:

1. Claves secretas

Administra tus claves secretas de API con control total sobre los tipos de acceso y los permisos.

Funciones principales:

• Create New Keys: genera nuevas claves de API con niveles de acceso específicos
• Tipos de clave:
  • Live: acceso completo de lectura y escritura a los datos de producción
  • Dryrun: prueba operaciones de escritura sin afectar los datos de producción (las escrituras se simulan)
  • Read-only: acceso de solo lectura para consumir datos de forma segura (las operaciones de escritura se bloquean)
• Administración de claves: consulta los detalles de las claves y las marcas de tiempo del último uso, rota claves y revócalas al instante
• Filtrado de claves: filtra las claves por estado (All, Active, Revoked)
• Rotación de claves: rota claves sin interrupciones del servicio

Cada clave secreta muestra:

• Label: nombre personalizable para identificarla fácilmente
• Key ID: identificador único (formato UUID)
• Secret: clave secreta parcialmente oculta (se ven los primeros 12 y los últimos 4 caracteres)
• Type: nivel de acceso de la clave (live, dryrun, read-only)
• Status: estado actual (active, revoked)
• Created: fecha en que se generó la clave
• Last Used: marca de tiempo de la llamada a la API más reciente
• Actions: rotar o revocar la clave

2. Configuración de integración

Configura cómo se vincula tu integración con las instalaciones del Performance Hub.

Funciones principales:

• Data Linking Method: elige entre dos métodos de vinculación:
  • Direct Link: usa los ID de instalación del Performance Hub en las llamadas a la API
  • Linking Identifier: usa tus propios identificadores de ubicación (ID de sucursal, número de tienda, etc.)
  • Más información sobre los métodos de vinculación de socios
• Linking Identifier Label: personaliza el nombre del campo que ven las instalaciones (por ejemplo, "Branch ID" o "Location Code")
• Partner Prefix: define un prefijo único para tus integraciones
• Integration Fields: configura campos personalizados específicos de tu integración

3. Detalles de socio

Consulta y administra la información de tu perfil de socio.

Campos editables:

• Partner Email: correo electrónico de contacto principal para las notificaciones
• Description: breve descripción de tu integración
• Logo URL: URL del logotipo de tu empresa asociada
• Website: sitio web de tu empresa o de tu integración
• Category: clasificación de la categoría de la integración
• Details: información adicional del socio

Información de solo lectura:

• Partner ID (identificador único)
• Nombre del socio
• Estado de la integración
• Número de organizaciones conectadas

4. Registros

Supervisa la actividad de la API y soluciona problemas de la integración.

Datos disponibles:

• Registros de solicitudes a la API
• Códigos de estado de las respuestas
• Mensajes de error
• Información de marcas de tiempo
• Cargas útiles de solicitudes y respuestas

Organizaciones conectadas

Consulta todas las organizaciones que habilitaron tu integración. La tarjeta de cada organización muestra:

• Nombre de la organización
• Marcas asociadas
• Número de instalaciones activas
• Estado de la integración

Ask AI

Obtén ayuda al instante sobre temas relacionados con los socios con el asistente de IA (atajo ⌘I).

Puedes preguntar sobre:

• Uso de los endpoints de la API y ejemplos
• Autenticación y administración de claves secretas
• Prácticas recomendadas para sincronizar datos
• Solución de problemas comunes de integración
• Funciones y navegación de la Partner Console

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.

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

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