Crea e usa le chiavi API di Vitruve

L'API di Vitruve permette a un altro sistema di leggere i dati della tua organizzazione: recuperare allenamenti e dati di allenamento, elencare gli utenti della tua organizzazione e alimentare dashboard personalizzate, strumenti di analisi, automazioni o il tuo data warehouse. Un'API (Application Programming Interface) è il tramite che permette a due sistemi di scambiarsi dati in modo sicuro.

È adatta ad allenatori, analisti di dati e sviluppatori che vogliono valorizzare ulteriormente i dati di Vitruve. Per collegare un partner già pronto come RockDaisy, TeamBuildr o FYTT, crea invece la chiave di quel partner in Integrazioni → Esporta.

RequisitiCopia il link

• Sei il Proprietario dell'organizzazione.
• L'organizzazione ha il piano Professional (chiamato Pro sul sito di assistenza).

Se Accesso API non compare in Impostazioni, manca uno di questi requisiti. Vedi Piano e accesso.

Crea una chiave APICopia il link

1. Apri Impostazioni: sul web o su desktop, l'ingranaggio nella barra laterale; su mobile, Altro (...) in basso a destra, poi Impostazioni.
2. Seleziona Accesso API.
3. Seleziona il pulsante + in alto a destra.

4. In Crea chiave API, inserisci un Nome (obbligatorio, ad esempio lo strumento che la userà) e una Descrizione facoltativa.
5. Seleziona Salva.

Verifica: la chiave compare nell'elenco con il suo nome e un valore abbreviato. Usa il pulsante di copia per copiare la chiave completa; l'app mostra Chiave API copiata negli appunti.

Crea una chiave per ogni strumento o integrazione, così puoi revocarne una senza bloccare le altre.

Leggi la documentazioneCopia il link

Il riferimento completo per sviluppatori, con tutti gli endpoint, le risposte di esempio e i codici di errore, è il riferimento dell'API di Vitruve, in inglese. Se non l'hai mai usata, inizia dal Quickstart.

Chiama l'APICopia il link

Ogni richiesta deve includere la chiave in questo header:

X-API-Key: your_key_here

Ogni chiave è limitata all'organizzazione che l'ha creata. L'URL di base è https://api-next.vitruve.fit/v1 e l'API legge con GET e può anche creare, aggiornare ed eliminare atleti, squadre, assegnazioni degli allenatori, i tuoi esercizi, profili carico-velocità e report sugli infortuni, nei limiti del tuo piano.

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

Copre atleti, allenatori, squadre, allenamenti con le relative serie e ripetizioni, programmi, modelli, profili carico-velocità, leaderboards, wellness e infortuni. Gli elenchi sono paginati e una chiave può inviare 30 richieste al minuto (limiti di frequenza).

Risposte di errore comuni:

Per l'elenco completo, vedi i codici di errore.

Revoca una chiaveCopia il link

1. Apri Impostazioni → Accesso API.
2. Seleziona Revoca accanto alla chiave.
3. Conferma con Revoca chiave.

La chiave smette di funzionare immediatamente: le richieste che la usano vengono rifiutate, il che può bloccare qualsiasi sistema che dipenda ancora da essa. Non puoi più visualizzare né modificare una chiave revocata. Crea una nuova chiave e aggiorna l'altro sistema se ha ancora bisogno di accedere.

Se una chiamata non va a buon fineCopia il link

• 401: controlla il nome dell'header X-API-Key, che la chiave sia stata copiata per intero e che non sia stata revocata.
• 403 "Your plan no longer includes API access": le chiavi seguono il piano a ogni richiesta. Smettono di funzionare quando l'organizzazione lascia Professional o il suo abbonamento termina, e tornano a funzionare quando il piano viene ripristinato.
• Nessun allenamento restituito: per impostazione predefinita, l'elenco degli allenamenti include solo le sessioni completate. Amplia from e to, oppure controlla status=pending.
• La voce Accesso API è scomparsa: il piano potrebbe essere cambiato, oppure la proprietà è stata trasferita. Solo il Proprietario di un'organizzazione Professional può gestire le chiavi.

Per assistenza sull'API, scrivi a support@vitruve.fit.