Cuenta y ajustes

Crea y usa claves de la API de Vitruve

Genera una clave API en Ajustes, llama a la API de Vitruve con la cabecera X-API-Key y revoca las claves que ya no necesites.

La API de Vitruve permite que otro sistema lea los datos de tu organización: obtener entrenamientos y datos de entrenamiento, listar los usuarios de tu organización y alimentar paneles personalizados, herramientas de análisis, automatizaciones o tu propio almacén de datos. Una API (interfaz de programación de aplicaciones) es el mensajero que permite a dos sistemas intercambiar datos de forma segura.

Es adecuada para entrenadores, analistas de datos y desarrolladores que quieren sacar más partido a los datos de Vitruve. Para conectar un socio ya preparado, como RockDaisy, TeamBuildr o FYTT, crea la clave de ese socio en Integraciones → Exportar.

Requisitos

  • Eres el Propietario de la organización.
  • La organización tiene el plan Professional (llamado Pro en el sitio de soporte).

Si Acceso API no aparece en Ajustes, falta alguno de estos requisitos. Consulta Plan y acceso.

Crea una clave API

  1. Abre Ajustes: en la web o en el escritorio, el engranaje de la barra lateral; en el móvil, Más (...) abajo a la derecha y después Ajustes.
  2. Selecciona Acceso API.
  3. Selecciona el botón + de la parte superior derecha.
La página Acceso API de la web con el botón más, el libro de la documentación, el botón para copiar una clave y su botón Revocar numerados del uno al cuatro.
App web, Ajustes, Acceso API para el Propietario de una organización Professional: (1) + para crear una clave, (2) la documentación de la API, (3) copiar la clave completa, (4) Revocar.
  1. En Crear clave API, introduce un Nombre (obligatorio, por ejemplo la herramienta que la va a usar) y una Descripción opcional.
  2. Selecciona Guardar.
La ventana Crear clave API rellena con un nombre y una descripción de ejemplo, con el botón Guardar marcado con el uno.
App web, Ajustes, Acceso API, Crear clave API con datos de ejemplo: (1) Guardar crea la clave.

Comprueba: la clave aparece en la lista con su nombre y un valor abreviado. Usa el botón de copiar para copiar la clave completa; la app muestra Clave API copiada al portapapeles.

Crea una clave por cada herramienta o integración, para poder revocar una sin romper las demás.

Trata la clave como una contraseña

Cualquiera que tenga la clave puede leer los datos de tu organización a través de la API. Guárdala en los ajustes seguros del otro sistema, nunca en documentos compartidos ni en código público.

Consulta la documentación

La referencia completa para desarrolladores, con todos los endpoints, ejemplos de respuesta y códigos de error, es la referencia de la API de Vitruve, en inglés. ¿Es la primera vez que la usas? Empieza por la guía Quickstart.

Llama a la API

Cada solicitud debe incluir la clave en esta cabecera:

X-API-Key: your_key_here

Cada clave está limitada a la organización que la creó. La URL base es https://api-next.vitruve.fit/v1 y la API lee con GET y también puede crear, actualizar y eliminar atletas, equipos, asignaciones de entrenadores, tus propios ejercicios, perfiles carga-velocidad y reportes de lesiones, dentro de lo que permite tu plan.

curl "https://api-next.vitruve.fit/v1/athletes?limit=5" \
  -H "X-API-Key: your_key_here"

Cubre atletas, entrenadores, equipos, entrenamientos con sus series y repeticiones, programas, plantillas, perfiles carga-velocidad, leaderboards, wellness y lesiones. Las listas están paginadas y una clave puede enviar 30 solicitudes por minuto (límites de uso).

Respuestas de error habituales:

CódigoSignificado
401 UnauthorizedFalta la clave API, no es válida o se ha revocado.
400 Bad requestUn parámetro no válido o desconocido. El mensaje indica cuál.
404 Not foundEl recurso no existe en tu organización.
429 Too many requestsHas superado el límite de uso. Espera los segundos que indique Retry-After.

Consulta Códigos de error para verlos todos.

Revoca una clave

  1. Abre Ajustes → Acceso API.
  2. Selecciona Revocar junto a la clave.
  3. Confirma con Revocar clave.
La confirmación Revocar clave API, que explica que la clave se desactiva de inmediato, con Cancelar y Revocar clave.
App web, Ajustes, Acceso API, Revocar: la confirmación. Selecciona Cancelar para conservar la clave.

La clave deja de funcionar de inmediato: se rechazan las solicitudes que la usan, lo que puede romper cualquier sistema que siga dependiendo de ella. Ya no puedes ver ni editar una clave revocada. Crea una clave nueva y actualiza el otro sistema si todavía necesita acceso.

Si una llamada falla

  • 401: comprueba que la cabecera se llama X-API-Key, que la clave se copió completa y que no se ha revocado.
  • 403 "Your plan no longer includes API access": las claves siguen el plan en cada solicitud. Dejan de funcionar cuando la organización deja el plan Professional o termina su suscripción, y vuelven a funcionar en cuanto se restablece el plan.
  • No se devuelve ningún entrenamiento: de forma predeterminada, la lista de entrenamientos solo incluye las sesiones completadas. Amplía from y to, o consulta status=pending.
  • Ha desaparecido la entrada Acceso API: puede que haya cambiado el plan o que se haya transferido la propiedad. Solo el Propietario de una organización Professional puede gestionar claves.

Para obtener ayuda con la API, escribe a support@vitruve.fit.

En esta página