Este artículo es para propietarios y administradores de estudios que conectan otras herramientas a bsport. Incluye cómo crear, controlar y revocar claves API en Configuración. Para las notificaciones de eventos, consulta "Gestiona tus webhooks".
Para más información sobre la API pública de bsport, consulta la documentación específica
Descripción general
Una clave API permite que una herramienta de confianza lea y actualice los datos de tu estudio a través de la API de bsport. Las herramientas de informes, las integraciones personalizadas y las plataformas de automatización usan claves para conectarse.
Gestiona las claves desde Configuración > Webhooks y API, en la pestaña API. Cada clave pertenece a tu estudio y está vinculada al nombre de una herramienta, así que puedes ver qué herramienta usa cada clave.
Quién puede usarla:
Condición | Lo que ves |
Tu rol es Propietario o Administrador, y tu plan de bsport incluye la API pública (Build, Engage o Elevate) | La pestaña API con tus claves y el botón Crear clave API. |
Tu rol es Propietario o Administrador, y tu plan de bsport no incluye la API pública | El mensaje "Mejora tu plan para usar la API". Contacta con bsport para mejorarlo. |
Cualquier otro rol | No hay pestaña API. La pestaña Webhooks sigue disponible si tu rol tiene el permiso de Webhook. |
La API pública también se puede añadir a un estudio fuera de estos planes. Contacta con bsport para solicitarlo.
Qué puedes hacer
Crear una clave API para una herramienta.
Elegir durante cuánto tiempo sigue siendo válida la clave: 3 meses, 6 meses o 1 año.
Ver todas las claves con su herramienta, fecha de caducidad, fecha de creación, contacto y estado.
Revocar una clave cuando dejes de usar una herramienta o sospeches de una filtración.
Abrir la documentación de la API desde el enlace en la parte superior derecha de la página.
Casos de uso habituales
Cómo crear una clave API
Ve a Configuración > Webhooks y API y abre la pestaña API.
Selecciona Crear clave API.
Completa el formulario:
Nombre de la herramienta (obligatorio): hasta 24 caracteres, usando letras minúsculas, dígitos, guiones o guiones bajos, por ejemplo
reporting-tool. Una clave activa no puede compartir el nombre de herramienta con otra clave activa.Caduca en: 3 meses (predeterminado), 6 meses o 1 año. La clave deja de funcionar al final de ese periodo.
Correo de contacto (opcional): a quién contacta bsport sobre esta clave. Déjalo vacío para usar el correo del propietario del estudio.
Selecciona Crear.
Lee el aviso del formulario. Una clave da acceso completo de administrador a tu estudio, incluidos los datos de clientes y los pagos. Compártela solo con herramientas y personas de confianza.
Cómo guardar tu clave
Después de seleccionar Crear, la ventana Guarda tu clave API muestra la clave. Esta es la única vez que la ves.
Selecciona Copiar clave y guárdala en un gestor de contraseñas. No la compartas por correo ni por chat.
Selecciona Copiar cabeceras para copiar lo que tu herramienta debe enviar con cada solicitud.
Selecciona Cerrar.
Si cierras la ventana antes de copiarla, bsport te pide que lo confirmes. Si cierras de todos modos, no podrás volver a ver la clave: crea una nueva y revoca la primera.
Cómo conectar tu herramienta
Tu herramienta envía dos cabeceras con cada solicitud a la API de bsport:
Cabecera | Valor |
| El nombre de herramienta que elegiste. |
| La clave que copiaste. |
Encontrarás los endpoints y ejemplos en la documentación de la API.
Cómo revocar una clave
En la pestaña API, busca la clave en la lista.
Selecciona Revocar clave.
Confirma en la ventana ¿Revocar clave API?.
La herramienta deja de funcionar de inmediato y no se puede deshacer. La clave permanece en la lista con el estado Revocada y la fecha de revocación. Su nombre de herramienta vuelve a estar disponible.
Cómo reemplazar una clave antes de que caduque
Las claves no se pueden editar ni ampliar. Para renovar una:
Crea una nueva clave con un nuevo nombre de herramienta, por ejemplo
reporting-tool-2, o reutiliza el nombre una vez que la clave antigua haya caducado o sido revocada.Actualiza tu herramienta con la nueva clave.
Revoca la clave antigua.
Cómo funciona
Configuración. Un propietario o administrador crea la clave y la copia una vez.
Activación. La clave funciona en cuanto existe. Tu herramienta envía las dos cabeceras con cada solicitud.
Uso normal. La lista muestra el estado de cada clave.
Después de la acción. Revoca una clave para detenerla de inmediato, o deja que caduque.
Estados de las claves
Estado | Significado |
Activa | La clave funciona y caduca en más de 30 días. |
Caduca pronto | La clave funciona y caduca en menos de 30 días. Planifica su reemplazo. |
Caducada | La clave llegó a su fecha de caducidad y ya no funciona. |
Revocada | Revocaste la clave. Ya no funciona. |
En la columna Contacto, Tú marca las claves que tienen tu propio correo.
Comportamientos importantes
Visualización única. bsport no guarda la clave en un formato legible. Nadie puede volver a mostrarla, ni siquiera bsport.
Límite de 50 claves. Un estudio puede tener 50 claves no revocadas. Las claves caducadas cuentan hasta que las revocas. Al llegar al límite, la página muestra un aviso y no se puede enviar el formulario de creación: revoca una clave caducada para crear otra.
Nombres de herramienta únicos. El nombre no puede coincidir con el de una clave activa. Las claves caducadas y revocadas liberan su nombre.
Acceso completo. Una clave no se limita a un área de tu estudio. Crea una clave por herramienta, así podrás revocar una sola herramienta sin afectar a las demás.
Cambios de plan. Si tu plan de bsport deja de incluir la API pública, la pestaña API muestra el mensaje de mejora y bsport rechaza nuevas claves.
Los webhooks son independientes. Las claves API no crean webhooks. Consulta "Gestiona tus webhooks".
Preguntas frecuentes
Perdí mi clave. ¿Puedo volver a verla?
No. Crea una nueva clave, actualiza tu herramienta y revoca la que perdiste.
¿Por qué no tengo pestaña API?
La pestaña es solo para propietarios y administradores. Pide a uno de ellos que cree la clave.
¿Por qué veo "Mejora tu plan para usar la API"?
Tu plan de bsport no incluye la API pública. Está incluida en Build, Engage y Elevate. Contacta con bsport para mejorarlo o añadirlo.
¿Para quién es el correo de contacto?
Es la persona con la que contacta bsport sobre la clave. Si lo dejas vacío, bsport usa el correo del propietario del estudio.
¿Puedo elegir una fecha de caducidad?
El formulario ofrece 3 meses, 6 meses o 1 año.
¿Revocar una clave tarda tiempo?
No. La herramienta se rechaza de inmediato.