Automatizza l'inserimento dei dati dei KPI con l'API RESTful
Automatizza la lettura e la scrittura dei dati per i KPI con l'API RESTful. Automatizza l'accesso ai tuoi dati per strumenti aziendali di terze parti.
Informazioni generali
- Documentazione. La documentazione per le chiamate API è disponibile qui.
- Webhook. Gli avvisi in BSC Designer possono essere configurati per inviare webhook. span>
- Limitazioni. Un account ha un limite di 100 chiamate API all'ora per ciascun utente esperto.
Per iniziare
Troverai di seguito alcune istruzioni che ti aiuteranno a iniziare.
Token di autorizzazione
Le chiamate API richiedono una chiave API o un token di autorizzazione temporaneo.
Per creare una nuova chiave API segui questi passaggi:
- Vai alla sezione Impostazioni
- Passa alla scheda Integrazioni
- Clicca sul pulsante Aggiungi chiave API
Utilizza il parametro Chiave API ottenuto nelle intestazioni di tutte le altre chiamate API:
POST /rest/login HTTP/1.1
Ospite: https://www.webbsc.com
Tipo di contenuto: application/json
Token: replace_with_obtained_token
Ottenere ID per le Scorecard ed i KPI
Le chiamate API relative al KPI richiedono l'ID della scorecard e il GUID del KPI.
Ottenere l'ID della scorecard
L'ID della scorecard può essere trovato utilizzando la chiamata API o manualmente. Per trovare manualmente l'ID della scorecard:
- Vai alla sezione Le mie scorecard
- Apri la scorecard
- L'URL della scorecard sarà qualcosa del genere: https://www.webbsc.com/s/123456
- Il numero alla fine è l'ID della scorecard
Ottenere il GUID del KPI
Il GUID del KPI può essere trovato utilizzando la chiamata API o manualmente. Per trovare il GUID manualmente:
- Apri la scorecard
- Seleziona Strumenti > Esporta valori degli indicatori
- Segui i passaggi per arrivare alla pagina Anteprima dei risultati dell'esportazione
- La colonna GUID nella tabella di anteprima conterrà il GUID del KPI
Scrivere e leggere dei valori utilizzando l'API
Utilizzare lo KPI Value Controller per scrivere e leggere i dati per i KPI.
- Ricorda di usare il token nell'intestazione delle richieste
- Le date devono essere nel formato AAAA-MM-GG (ad esempio “2017-06-30”)
- I dati vengono inviati e ricevuti in formato JSON
- Per ottimizzare i numeri della chiamata usa le richieste batch
- Per leggere valori raggruppati, calcolati o ereditati, usa il Controller dei valori raggruppati
Guarda questo esempio di utilizzo dell'API.