Scheda Chiavi API

La scheda Chiavi API è disponibile solo se il Suo account dispone di un abbonamento a RICOH Predictive Insight. Per visualizzare la scheda e utilizzare i tasti, è necessario disporre di un accesso di tipo Amministratore al sito Account Administration.

I due collegamenti nella parte superiore della scheda consentono di visualizzare le informazioni di riferimento relative all'API di esportazione dei dati:

Introduzione alle chiavi API

Apre la guida relativa all'API di esportazione dei dati, nella quale è possibile trovare informazioni su come iniziare a utilizzare le chiavi API, nonché sugli endpoint disponibili, sui campi restituiti da ciascuno di essi e sui limiti applicabili alle richieste.

Apri l'Esploratore API

Apre la pagina della documentazione interattiva relativa all'API, dove è possibile esaminare ciascun endpoint, visualizzare i parametri che accetta e inviare richieste di esempio direttamente dal proprio browser. Per inviare una richiesta da quella pagina è necessario il valore di una chiave API.

Di seguito sono indicate le azioni che si possono eseguire in questa scheda:

• Visualizzi tutte le chiavi definite per il Suo account e le relative proprietà, quali: Nome, Stato e Data di scadenza.

  La tabella non riporta il valore di una chiave.

• Creare una chiave.

  Fare clic su Crea chiave API. Le chiavi sono solitamente attive entro 30 secondi, ma sono possibili ritardi.

• Si prega di monitorare le richieste API dell'account rispetto ai limiti dell'abbonamento.

  Il riquadro sopra la tabella delle chiavi API mostra il piano di utilizzo dell'account e il numero massimo di chiamate API consentite in un periodo di 30 giorni. Tenga traccia del numero di chiamate effettuate negli ultimi 30 giorni.

• Modifichi il nome, la descrizione o la data di scadenza di una chiave esistente.

  Fare clic con il pulsante destro del mouse su una riga e selezionare Modifica chiave API. La modifica di una chiave non ne altera il valore, pertanto le applicazioni che già utilizzano tale chiave continuano a funzionare.

• Ruotare una chiave per sostituirne il valore.

  Fare clic con il pulsante destro del mouse su una riga e selezionare Ruota chiave API. Impostare un periodo di sovrapposizione in modo che sia il valore attuale sia quello nuovo rimangano validi per alcuni giorni, consentendo così di avere il tempo necessario per aggiornare le proprie applicazioni. La chiave con il nuovo valore è solitamente disponibile entro 30 secondi, ma sono possibili dei ritardi.

• Eliminare una chiave.

  Fare clic con il pulsante destro del mouse su una riga e selezionare Elimina immediatamente.

  Nota:
  • L'eliminazione di una chiave comporta la sua rimozione dal sistema entro un minuto, sebbene possano verificarsi dei ritardi. Le chiavi eliminate subiscono la rimozione definitiva. Se si tenta di inviare una richiesta API utilizzando una chiave dopo averla eliminata, la richiesta non va a buon fine.
  • L'eliminazione di una chiave elimina tutte le versioni della stessa. Se si ruota una chiave e poi la si elimina, entrambe le versioni della chiave vengono eliminate, anche se il periodo di sovrapposizione è ancora attivo.

Le chiavi non sono limitate alle singole stampanti. Chiunque disponga del valore di una chiave può inviare richieste a nome del Suo account. Condivida le chiavi esclusivamente con le persone incaricate dello sviluppo delle integrazioni e le sostituisca periodicamente in conformità con le vostre procedure di sicurezza.

Facendo clic su , l'icona degli strumenti, si apre un menu dal quale è possibile aggiornare le informazioni della tabella e gestire le colonne della tabella.