Utilizzo di un servizio Web REST per autenticarsi con un'applicazione
Per l'autenticazione della chiave API, inserire un codice di autorizzazione in una proprietà Credenziali statiche o definire un ID utente HTTP e una password. Il dispositivo di input o la notifica trasmette il codice di autorizzazione o l'ID utente HTTP e la password al servizio Web, che scambia i dati. Il servizio Web si autentica quindi con l'applicazione e restituisce una risposta.
Per l'autenticazione della sessione, inserire le credenziali di autenticazione (ID utente e password) e altri valori in una serie di proprietà della richiesta di autenticazione. Il dispositivo di input o la notifica per prima cosa richiama un servizio Web REST per autenticarsi con l'applicazione. Una volta che l'autenticazione è avvenuta con successo, il servizio Web restituisce un token al dispositivo di input o alla notifica. Il dispositivo di input o la notifica trasmette quindi il token nella chiamata al servizio Web, che scambia i dati.
- Se l'applicazione consente una sessione per utente, configurare i dispositivi di input e le notifiche per chiamare i servizi Web con diversi ID utente e password.
- L'autenticazione della sessione avviene quando ogni servizio Web chiama e non è richiesta alcuna disconnessione. Verificare che la lunghezza della sessione per ciascuna serie di credenziali sia inferiore al tempo che intercorre tra le chiamate al servizio Web. Ad esempio, la sessione per un dispositivo di input termina dopo 10 minuti. Al momento della configurazione del dispositivo di input, specificare un intervallo di polling superiore a 10 minuti.
Per ottenere una chiave API o delle credenziali di autenticazione per un'applicazione, contattare la compagnia che ospita l'applicazione. Per i requisiti inerenti a formato e sintassi, fare riferimento alla documentazione dell'applicazione.
- Fare clic sulla scheda Autenticazione sul dispositivo di input o la notifica del servizio Web REST.
- Seguire le istruzioni per il tipo di autenticazione richiesto dall'applicazione:
- Per l'autenticazione della chiave API, specificare il codice di autenticazione come
valore della proprietà Credenziali statiche.
Lasciare vuote tutte le altre proprietà. La procedura risulta quindi completata.
- Per l'autenticazione della sessione, lasciare vuota la proprietà Credenziali statiche. Passare alla fase successiva e specificare le altre proprietà.
- Per l'autenticazione della chiave API, specificare il codice di autenticazione come
valore della proprietà Credenziali statiche.
- Configurare la proprietà URL richiesta di autenticazione sull'URL RICOH ProcessDirector usata per autenticarsi con l'applicazione.
- Specificare le credenziali di autenticazione inserendo i valori richiesti dall'applicazione
in una o più di queste proprietà: Payload richiesta di autenticazione, Intestazione richiesta di autenticazione, e Parametri richiesta di autenticazione.
- Per il valore della proprietà Payload richiesta, specificare il corpo (se presente) della richiesta di autorizzazione inoltrata all'applicazione.
In questi esempi, il payload include tre elementi XML: <Credentials>, <Name>, e <Password>. Il valore dell'elemento <Password> è un simbolo che utilizza la proprietà Password richiesta autenticazione.
Questo esempio utilizza la proprietà Password richiesta autenticazione per i dispositivi di input:
<Credentials> <Name>myname</Name> <Password>${WebService.AuthRequestPwd}</Password> </Credentials>
Questo esempio utilizza la proprietà Password richiesta autenticazione per le notifiche:
<Credentials> <Name>myname</Name> <Password>${WSNotification.WebService.AuthRequestPwd}</Password> </Credentials>
Il dispositivo di input o la notifica risolve il simbolo quando invia la richiesta di autenticazione.
- Impostare i valori per le proprietà Intestazione richiesta e Parametri richiesta, come richiesto.
Ciascun campo intestazione o parametro è una coppia parola chiave/valore. Ciascuna coppia deve figurare su una riga distinta e deve essere separata da due punti (:) o il segno uguale (=).
La parola chiave e il valore possono essere composti da più parole. RICOH ProcessDirector utilizza i primi due punti o il primo segno uguale su ciascuna riga per separare le parole nella coppia parola chiave/valore.
Questi esempi contengono due parametri: nome e pwd. Il valore della parola chiave pwd è un simbolo che utilizza la proprietà Password richiesta autenticazione.
Questo esempio utilizza la proprietà Password richiesta autenticazione per i dispositivi di input:
name:myname pwd:${WebService.AuthRequestPwd}
Questo esempio utilizza la proprietà Password richiesta autenticazione per le notifiche:
name:myname pwd:${WSNotification.WebService.AuthRequestPwd}
Il simbolo si risolve all'invio della richiesta di autenticazione.
- Per il valore della proprietà Payload richiesta, specificare il corpo (se presente) della richiesta di autorizzazione inoltrata all'applicazione.
- Impostare le proprietà Metodo richiesta e Tipo contenuto richiesta con i valori richiesti dal servizio Web.
- Impostare la proprietà Attributo risposta autenticazione con l'espressione XPath che identifica le credenziali per la sessione nella risposta dal servizio Web.
- Impostare la proprietà Password richiesta autenticazione con la password dell'account dell'applicazione.La password è codificata quando archiviata in RICOH ProcessDirector.
- Per i dispositivi di input, la proprietà è WebService.Credenziali.
- Per le notifiche, la proprietà è WSNotifica.WebService.Credenziali.
Quando si specificano i valori sulla scheda Richiesta per un dispositivo di input o una notifica del servizio Web, dettagliare la proprietà WebService.Credenziali o WSNotifica.WebService.Credenziali come simbolo.
RICOH ProcessDirector sostituisce il valore delle credenziali statiche o del token per il simbolo quando trasmette la richiesta a un servizio Web.
- Preparazione per il recupero dell'input dei servizi Web REST.
- Preparazione per l'invio di uno stato ad un servizio Web REST.