Questo articolo è per i Titolari e gli Amministratori dello studio che collegano altri strumenti a bsport. Tratta la creazione, il monitoraggio e la revoca delle chiavi API in Impostazioni. Per le notifiche sugli eventi, consulta "Gestisci i tuoi webhook".
Per maggiori informazioni sull'API pubblica di bsport, consulta la documentazione dedicata
Panoramica
Una chiave API consente a uno strumento di cui ti fidi di leggere e aggiornare i dati del tuo studio tramite l'API di bsport. Strumenti di reportistica, integrazioni personalizzate e piattaforme di automazione usano le chiavi per connettersi.
Gestisci le chiavi da Impostazioni > Webhook e API, nella scheda API. Ogni chiave appartiene al tuo studio ed è collegata a un nome di strumento, così puoi vedere quale strumento usa quale chiave.
Chi può usarla:
Condizione | Cosa vedi |
Il tuo ruolo è Titolare o Amministratore e il tuo piano bsport include l'API pubblica (Build, Engage o Elevate) | La scheda API con le tue chiavi e il pulsante Crea chiave API. |
Il tuo ruolo è Titolare o Amministratore e il tuo piano bsport non include l'API pubblica | Il messaggio "Aggiorna il tuo piano per usare l'API". Contatta bsport per effettuare l'aggiornamento. |
Qualsiasi altro ruolo | Nessuna scheda API. La scheda Webhook resta disponibile se il tuo ruolo ha il permesso Webhook. |
L'API pubblica può anche essere aggiunta a uno studio al di fuori di questi piani. Contatta bsport per saperne di più.
Cosa puoi fare
Creare una chiave API per uno strumento.
Scegliere per quanto tempo la chiave rimane valida: 3 mesi, 6 mesi o 1 anno.
Vedere ogni chiave con il suo strumento, data di scadenza, data di creazione, contatto e stato.
Revocare una chiave quando smetti di usare uno strumento o sospetti una fuga di dati.
Aprire la documentazione API dal link in alto a destra della pagina.
Casi d'uso comuni
Come creare una chiave API
Vai su Impostazioni > Webhook e API e apri la scheda API.
Seleziona Crea chiave API.
Compila il modulo:
Nome dello strumento (obbligatorio): massimo 24 caratteri, usando lettere minuscole, cifre, trattini o trattini bassi, ad esempio
reporting-tool. Una chiave attiva non può condividere il nome dello strumento con un'altra chiave attiva.Scade tra: 3 mesi (predefinito), 6 mesi o 1 anno. La chiave smette di funzionare al termine di quel periodo.
Email di contatto (facoltativo): la persona che bsport contatta riguardo a questa chiave. Lascia vuoto per usare l'email del titolare dello studio.
Seleziona Crea.
Leggi l'avviso nel modulo. Una chiave garantisce pieno accesso amministrativo al tuo studio, inclusi i dati dei clienti e i pagamenti. Condividila solo con strumenti e persone di cui ti fidi.
Come salvare la tua chiave
Dopo aver selezionato Crea, la finestra Salva la tua chiave API mostra la chiave. Questa è l'unica volta che la vedi.
Seleziona Copia chiave e conservala in un gestore di password. Non condividerla via email o chat.
Seleziona Copia header per copiare ciò che il tuo strumento deve inviare con ogni richiesta.
Seleziona Chiudi.
Se chiudi la finestra prima di copiare, bsport ti chiede conferma. Se chiudi comunque, non potrai più vedere la chiave: crea una nuova chiave e revoca la prima.
Come collegare il tuo strumento
Il tuo strumento invia due header con ogni richiesta all'API di bsport:
Header | Valore |
| Il nome dello strumento che hai scelto. |
| La chiave che hai copiato. |
Gli endpoint e gli esempi si trovano nella documentazione API.
Come revocare una chiave
Nella scheda API, trova la chiave nell'elenco.
Seleziona Revoca chiave.
Conferma nella finestra Revocare la chiave API?
Lo strumento smette di funzionare immediatamente e questa azione non può essere annullata. La chiave resta nell'elenco con lo stato Revocata e la data di revoca. Il suo nome di strumento torna disponibile.
Come sostituire una chiave prima della scadenza
Le chiavi non possono essere modificate o estese. Per rinnovarne una:
Crea una nuova chiave con un nuovo nome di strumento, ad esempio
reporting-tool-2, oppure riutilizza il nome una volta che la vecchia chiave è scaduta o revocata.Aggiorna il tuo strumento con la nuova chiave.
Revoca la vecchia chiave.
Come funziona
Configurazione. Un Titolare o un Amministratore crea la chiave e la copia una volta.
Attivazione. La chiave funziona non appena viene creata. Il tuo strumento invia i due header con ogni richiesta.
Uso normale. L'elenco mostra lo stato di ogni chiave.
Dopo l'azione. Revoca una chiave per bloccarla subito, oppure lasciala scadere.
Stati della chiave
Stato | Significato |
Attiva | La chiave funziona e scade tra più di 30 giorni. |
In scadenza | La chiave funziona e scade entro 30 giorni. Pianifica la sua sostituzione. |
Scaduta | La chiave ha raggiunto la data di scadenza e non funziona più. |
Revocata | Hai revocato la chiave. Non funziona più. |
Nella colonna Contatto, Tu indica le chiavi che riportano la tua email.
Comportamenti importanti
Visualizzazione unica. bsport non memorizza la chiave in forma leggibile. Nessuno può mostrarla di nuovo, nemmeno bsport.
Limite di 50 chiavi. Uno studio può avere 50 chiavi non revocate. Le chiavi scadute contano fino a quando non le revochi. Al raggiungimento del limite, la pagina mostra un avviso e il modulo di creazione non può essere inviato: revoca una chiave scaduta per crearne un'altra.
Nomi di strumento univoci. Il nome non può corrispondere a una chiave attiva. Le chiavi scadute e revocate liberano il loro nome.
Accesso completo. Una chiave non è limitata a un'area specifica del tuo studio. Crea una chiave per ogni strumento, così puoi revocarne uno singolo senza influire sugli altri.
Cambi di piano. Se il tuo piano bsport non include più l'API pubblica, la scheda API mostra il messaggio di aggiornamento e bsport rifiuta nuove chiavi.
I webhook sono separati. Le chiavi API non creano webhook. Consulta "Gestisci i tuoi webhook".
Domande frequenti
Ho perso la mia chiave. Posso vederla di nuovo?
No. Crea una nuova chiave, aggiorna il tuo strumento e revoca quella persa.
Perché non vedo la scheda API?
La scheda è riservata a Titolari e Amministratori. Chiedi a uno di loro di creare la chiave.
Perché vedo "Aggiorna il tuo piano per usare l'API"?
Il tuo piano bsport non include l'API pubblica. È inclusa con Build, Engage ed Elevate. Contatta bsport per effettuare l'aggiornamento o aggiungerla.
A chi serve l'email di contatto?
È la persona che bsport contatta riguardo alla chiave. Se la lasci vuota, bsport usa l'email del titolare dello studio.
Posso scegliere una data di scadenza?
Il modulo offre 3 mesi, 6 mesi o 1 anno.
Revocare una chiave richiede tempo?
No. Lo strumento viene rifiutato immediatamente.