API di esportazione dei dati

L'API di esportazione dei dati è un'API REST che mette a disposizione quattro endpoint. È possibile utilizzare tali endpoint per scaricare informazioni relative alle proprie stampanti e ai processi da esse elaborati, nonché sugli stati operativi di tali stampanti nel corso del tempo e sugli eventi che hanno generato messaggi di avviso o di errore sulla stampante.

È possibile utilizzare l'API di esportazione dei dati per importare RICOH Predictive Insight data negli strumenti di business intelligence, nei data warehouse, nei dashboard e nelle altre applicazioni della propria organizzazione.

Autenticazione

È possibile creare e gestire le chiavi API in RICOH Account Administration. È possibile creare tutte le chiavi necessarie: una per ogni applicazione che scarica dati oppure una chiave da utilizzare a livello dell’intera organizzazione. Impostino la data di scadenza in base alle proprie procedure di sicurezza e procedano alla rotazione delle chiavi secondo necessità. È possibile impostare il periodo di sovrapposizione, in modo che sia la vecchia chiave che quella nuova funzionino per un certo numero di giorni. Se necessario, è possibile eliminare una chiave per disattivarla immediatamente.

La chiave API contiene anche l'identità del proprio tenant; per questo motivo non è necessario specificare alcun parametro relativo al tenant o all'account in nessuna richiesta. Chiunque disponga del valore della chiave può inviare richieste a nome del proprio tenant; pertanto, è necessario proteggere le chiavi API con la stessa cura con cui si proteggerebbe una password.

Endpoint disponibili

L'API comprende i seguenti endpoint:

/printers
Restituisce l'elenco delle stampanti presenti nel Suo account, includendo il nome della stampante, il modello, il produttore, il numero di serie, i motori e lo stato attuale della connessione.
/jobs
Restituisce i dettagli a livello di lavoro relativi a una o più stampanti, inclusi i tempi, le copie stampate, le pagine, le impressioni, i fogli, la lunghezza del rotolo e il consumo di inchiostro e di scaricamento per ciascun canale di colore. Per impostazione predefinita, la risposta copre le ultime 24 ore.
/printer-states
Restituisce lo stato operativo di ciascun motore della stampante, sotto forma di cronologia aggregata relativa a un intervallo di tempo oppure solo come stato attuale. È possibile recuperare gli stati effettivi della stampante, quali: Stampa, Preparazione, Manutenzione o Sospensione; in alternativa, tali stati possono essere raggruppati nelle seguenti categorie: up, down, idle o unknown.

Suggerimento: L'endpoint /printer-states riporta le informazioni sullo stato per ciascun motore della stampante, non per ciascuna stampante. Una stampante dotata di più motori restituisce una riga per ciascun motore.

/printer-interventions
Restituisce gli eventi che hanno causato avvisi o errori su una o più stampanti, quali un inceppamento della carta o l’esaurimento della carta. Ogni evento viene riportato per un singolo motore di stampa, indicando l’ora di inizio, l’ora di fine, la durata, un codice che identifica la condizione e, se presente, il nome del lavoro in corso di stampa. Per impostazione predefinita, la risposta copre le ultime 24 ore. È possibile richiedere le descrizioni degli eventi in una qualsiasi delle lingue supportate.

Verifica dell'API

È disponibile una pagina di documentazione interattiva che Le consente di esaminare ciascun endpoint, visualizzarne i parametri accettati e provare richieste di esempio direttamente dal Suo browser. Per aprire la pagina, si rechi all'indirizzo:

Per inviare richieste dalla pagina della documentazione o dalle proprie applicazioni, è necessario innanzitutto creare una chiave API. È possibile creare e gestire le chiavi API in Account Administration.

Argomento collegato: Utilizzo dell'API di esportazione dei dati