Provare l'API di esportazione dei dati

Segua questa procedura per una breve introduzione all'API, utilizzando la pagina della documentazione interattiva come guida.

Prima di iniziare questa operazione, crei una chiave API utilizzando RICOH Account Administration.

Questa procedura illustra come eseguire le seguenti operazioni:

  1. Autenticazione della pagina di documentazione interattiva
  2. Recupero dell'elenco degli ID stampante per le stampanti del proprio account
  3. Recupero dello stato di una o più stampanti
  4. Richiesta di informazioni relative ai lavori associati a una o più di tali stampanti

Per utilizzare l'API di esportazione dei dati:

  1. Apra qui la documentazione interattiva dell'API di esportazione dei dati:
  2. Autenticarsi utilizzando una chiave API:
    1. Clicchi su Autorizza nella parte destra della pagina.
    2. Nella finestra di dialogo Autorizzazioni disponibili, immettere la chiave API nel campo Valore.
      Finestra di dialogo Autorizzazioni disponibili
    1. Clicchi su Autorizza per effettuare l'autenticazione.
    2. Fare clic su Close.
    Ora potete provare le funzioni API disponibili. Utilizzare questa interfaccia per acquisire familiarità con la sintassi prima di integrare l'API nelle proprie applicazioni.
  3. Recuperare l'elenco degli ID stampante per le stampanti definite nel proprio account.
    Per recuperare le informazioni relative allo stato dei lavori e delle stampanti, è necessario includere i valori dell'ID della stampante nelle richieste API. Gli ID delle stampanti non cambiano. Se si recuperano ora e si salvano i valori, è possibile utilizzare gli ID in altre chiamate API.
    1. Apra la sezione Stampanti, quindi apra l'endpoint GET /printers.
      Come potete vedere, per questo endpoint non sono richiesti parametri.
    2. Fare clic su Prova, quindi su Esegui.
    3. Esamini il corpo della risposta. Viene visualizzato un elenco di informazioni relative alle stampanti monitorate da RICOH Predictive Insight. La risposta è simile a questa:
      [
  {
    "printerName": "VC80_2",
    "printerId": "0bc6b7b3-8df9-4293-cdd4-5ae3162c4d4c",
    "engines": 2,
    "manufacturer": "Ricoh",
    "model": "RICOH Pro VC80000",
    "printerMode": "duplex",
    "printerType": "continuous_feed",
    "serialNumber": "Printer 1: 10-11111 and Printer 2: 10-11112",
    "connectionStatus": "not_connected"
  },
  {
    "printerName": "IP 5000",
    "printerId": "0f8726da-8q37-9c3l-8710-065d7c265122",
    "engines": 1,
    "manufacturer": "InfoPrint",
    "model": "InfoPrint 5000 GP v3.17.129",
    "printerMode": "simplex",
    "printerType": "continuous_feed",
    "serialNumber": "10-1111111",
    "connectionStatus": "connected"
  }
]

      Si prega di registrare i valori dei parametri printerId per ciascuna delle vostre stampanti.

  4. Richiedere la cronologia dello stato della stampante per una o più stampanti nel proprio sistema.
    1. Apra l'endpoint GET /printer-states.
    2. Clicchi su Prova.
    3. Accanto a printerId, faccia clic su Aggiungi elemento stringa.
    4. Sostituisca il testo nel campo con uno dei valori dell'ID della stampante che ha recuperato al punto .
      Per recuperare la cronologia degli stati di altre stampanti, fare nuovamente clic su Aggiungi elemento stringa e inserire un altro valore di ID stampante.
    5. Per il fuso orario, scegliere il fuso orario da utilizzare per i dati.
    6. Specifichi gli orari di inizio e di fine dell'intervallo di tempo oggetto del report. Lasci i campi vuoti per recuperare i dati relativi alle ultime 24 ore.
    7. Lasci i tre ultimi valori impostati sui valori predefiniti, in modo da poter visualizzare l'elenco completo delle informazioni che l'API è in grado di restituire.
    8. Clicchi su Esegui.
    9. Esamini il corpo della risposta. Per ogni motore della stampante viene visualizzato un elenco dei dati sullo stato della stampante, con una stanza per ogni modifica dello stato della stampante.
    10. Modifichi i valori dei parametri currentState, stateCategoryOnly e stateCategory, quindi faccia nuovamente clic su Esegui per osservare come cambia la risposta.
      • Lasciare questi parametri impostati sui valori predefiniti (non specificati) ha lo stesso effetto che impostarli su falso.
      • Potete utilizzarli singolarmente o in combinazione tra loro.
  5. Richieda informazioni sui lavori associati a una o più di tali stampanti:
    1. Sezione Lavori della pagina.
    2. Apra l'endpoint GET /jobs.
    3. Clicchi su Prova.
    4. Accanto a printerId, faccia clic su Aggiungi elemento stringa.
    5. Sostituisca il testo nel campo con uno dei valori dell'ID della stampante che ha recuperato al punto .
      Per recuperare le informazioni lavoro per altre stampanti, fare nuovamente clic su Aggiungi elemento stringa e inserire un altro valore di ID stampante.
    6. Per il fuso orario, scegliere il fuso orario da utilizzare per i dati.
    7. Specifichi gli orari di inizio e di fine dell'intervallo di tempo oggetto del report. Lasci i campi vuoti per recuperare i dati relativi alle ultime 24 ore.
    8. Per jobState, lasciare il valore vuoto per visualizzare l'intera gamma di risposte che l'API può restituire.
    9. Clicchi su Esegui.
    10. Esamini la risposta per visualizzare le informazioni lavoro restituiti.
    11. Modifichi il valore di jobState e faccia nuovamente clic su Esegui per osservare come cambia la risposta.
Argomento collegato: Utilizzo dell'API di esportazione dei dati