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:
  • 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