Utilizzo della documentazione RICOH ProcessDirector REST API

RICOH ProcessDirector fornisce REST API per l'integrazione del servizio Web. Con queste API viene fornita una documentazione interattiva che offre test in diretta e informazioni per ogni API disponibile.

La documentazione REST API include molte API che un'applicazione può usare per l'integrazione con RICOH ProcessDirector. È possibile utilizzare la documentazione REST API e l'interfaccia di test per collaudare le impostazioni dei parametri. Quando si utilizza l'interfaccia per collaudare i servizi Web, è possibile accedere al server primario di RICOH ProcessDirector. Azioni quali la creazione, l'eliminazione e l'abilitazione di oggetti sono eseguite sul server primario e si riflettono nell'interfaccia utente di RICOH ProcessDirector. Di conseguenza, si consiglia di creare oggetti appositamente per i test.

Queste operazioni mostrano come richiedere i file di registro per un oggetto usando le REST API. Queste operazioni consentono di accedere a RICOH ProcessDirector, richiedere i file di registro per la stampante di esempio e disconnettersi.

  1. Aprire un browser Web e inserire il proprio nome host o indirizzo IP RICOH ProcessDirector nella barra degli indirizzi. Aggiungere /restapi/ alla fine del nome host o dell'indirizzo IP per accedere alla documentazione REST API. Ad esempio, http://hostname:15080/restapi/
  2. Nella sezione relativa agli utenti, fare clic su Espandi operazioni e individuare GET /users/login.
  3. Accedere a RICOH ProcessDirector inserendo le proprie credenziali RICOH ProcessDirector:
    • Per il parametro name, inserire il proprio nome utente RICOH ProcessDirector.
    • Per il parametro pwd, inserire la password associata al proprio nome utente RICOH ProcessDirector.
  4. Fare clic su Provalo!
    La documentazione REST API utilizza i valori inseriti per creare un comando cURL e un URL di richiesta. Quindi inoltra la richiesta all'URL interessato e disconnette l'utente.

    RICOH ProcessDirector invia una risposta indicando l'avvenuto accesso. La risposta include informazioni aggiuntive, inclusi il token e le azioni che possono essere eseguite da questo ID utente.

  5. Nella casella Corpo risposta, individuare e copiare il valore del token.

  6. Nella sezione relativa agli oggetti, fare clic su Espandi operazioni. Scorrere in basso fino a individuare GET /objects/log/{objectType}/{name}.
  7. Recuperare i messaggi di registro per la stampante di esempio inserendo questi parametri:
    1. Per il parametro token, incollare il token copiato in precedenza.
    2. Per il parametro objectType, digitare Stampante.
    3. I valori per objectType sono sensibili alla distinzione tra maiuscole e minuscole. È possibile utilizzare il servizio Web GET /util/objecttypes per ottenere l'elenco dei tipi di oggetti disponibili sul proprio sistema. Il servizio Web GET /util/objecttypes si trova nella sezione util.
    4. Per il parametro name, digitare Esempio.
  8. Fare clic su Provalo!
    Le voci di registro per la stampante di esempio vengono restituite nella casella Corpo risposta.

    Vengono restituiti anche i valori cURL e URL di richiesta.

  9. Nella sezione relativa agli utenti, fare clic su Espandi operazioni e individuare POST /users/logout/{name}.
  10. Disconnettersi da RICOH ProcessDirector:
    • Per il parametro token, incollare il token copiato in precedenza.
    • Per il parametro name, inserire il proprio nome utente RICOH ProcessDirector.
  11. Fare clic su Provalo!
    Verrà eseguita la disconnessione da RICOH ProcessDirector.

  12. Con alcune API sono inclusi valori di esempio. Con i valori di esempio, è possibile copiare una stringa di codice di esempio nel campo del corpo e modificarla per eseguire il test.

    Queste operazioni mostrano come utilizzare una REST API per connettersi a una hot folder. Queste operazioni consentono di accedere a RICOH ProcessDirector, impostare il dispositivo di input in modo da accettare i file da HotFolderPDF e disconnettersi.

  13. Aprire un browser Web e inserire il proprio nome host o indirizzo IP RICOH ProcessDirector nella barra degli indirizzi. Aggiungere /restapi/ alla fine del nome host o dell'indirizzo IP per accedere alla documentazione REST API. Ad esempio, http://hostname:15080/restapi/
  14. Nella sezione relativa agli utenti, fare clic su Espandi operazioni e individuare GET /users/login.
  15. Accedere a RICOH ProcessDirector inserendo le proprie credenziali RICOH ProcessDirector:
    • Per il parametro name, inserire il proprio nome utente RICOH ProcessDirector.
    • Per il parametro pwd, inserire la password associata al proprio nome utente RICOH ProcessDirector.
  16. Fare clic su Provalo!
    La documentazione REST API utilizza i valori inseriti per creare un comando cURL e un URL di richiesta. Quindi inoltra la richiesta all'URL interessato e disconnette l'utente.

    RICOH ProcessDirector invia una risposta indicando l'avvenuto accesso. La risposta include informazioni aggiuntive, inclusi il token e le azioni che possono essere eseguite da questo ID utente.

  17. Nella casella Corpo risposta, individuare e copiare il valore del token.
  18. Nella sezione relativa agli oggetti, fare clic su Espandi operazioni. Scorrere in basso fino a individuare POST /objects/{objectType}/connect.
  19. Connettersi a HotFolderPDF inserendo questi parametri:
    1. Per il parametro token, incollare il token copiato in precedenza.
    2. Per il parametro objectType, digitare InputDevice.
      I valori per objectType sono sensibili alla distinzione tra maiuscole e minuscole. È possibile utilizzare il servizio Web GET /util/objecttypes per ottenere l'elenco dei tipi di oggetti disponibili sul proprio sistema. Il servizio Web GET /util/objecttypes si trova nella sezione util.
    3. Per il parametro relativo al corpo, fare clic sul valore di esempio. Il testo all'interno del valore di esempio viene copiato nel parametro relativo al corpo. Sostituire la parola “stringa” con “HotFolderPDF”. Assicurarsi che il nome dell'oggetto sia compreso tra i doppi apici.
  20. Fare clic su Provalo!
    Le proprietà e le impostazioni per HotFolderPDF vengono restituite nella casella Corpo risposta. Vengono restituiti anche il codice e le intestazioni della risposta.
  21. Nella sezione relativa agli utenti, fare clic su Espandi operazioni e individuare POST /users/logout/{name}.
  22. Disconnettersi da RICOH ProcessDirector:
    • Per il parametro token, incollare il token copiato in precedenza.
    • Per il parametro name, inserire il proprio nome utente RICOH ProcessDirector.
  23. Fare clic su Provalo!
    Verrà eseguita la disconnessione da RICOH ProcessDirector.

Related information:

Preparazione per l'invio di lavori tramite i servizi Web
Preparazione per l'invio di lavori tramite i servizi Web
Preparazione per l'invio di lavori tramite i servizi Web
Argomento collegato: Utilizzo di Servizi Web