Utilisation d'un service Web REST pour s’authentifier avec une application
Pour l’authentification par clé d’API, vous placez un code d’autorisation dans une propriété Informations d’identification statiques ou définissez un ID utilisateur et un mot de passe HTTP. L’unité d’entrée ou la notification transmet le code d’autorisation ou l’ID utilisateur et le mot de passe HTTP au service Web qui échange les données. Le service Web procède ensuite à l’authentification avec l’application et renvoie une réponse.
Pour l’authentification par session, vous placez des informations d’identification d’authentification (ID utilisateur et mot de passe) et d’autres valeurs dans un ensemble de propriétés de demande d’authentification. L’unité d’entrée ou la notification commence par appeler un service Web REST pour procéder à l’authentification avec l’application. Une fois l’authentification exécutée, le service Web renvoie un jeton à l’unité d’entrée ou à la notification. L’unité d’entrée ou la notification transmet alors le jeton dans l’appel au service Web qui échange les données.
- Si l'application autorise une session par utilisateur, configurez vos unités d'entrée et vos notifications pour qu'elles appellent les services Web avec différents ID et mots de passe.
- L'authentification par session s'effectue avec chaque appel de service Web et aucune déconnexion n'est requise. Assurez-vous que la durée de la session de chaque ensemble d'informations d'identification est plus courte que l'intervalle entre les appels adressés au service Web. Supposons, par exemple, que la session d'une unité d'entrée expire après 10 minutes. Lorsque vous configurez l'unité d'entrée, spécifiez un intervalle d'interrogation supérieur à 10 minutes.
Pour obtenir un clé d'API ou des informations d'identification pour une application, contactez l'entreprise qui héberge l'application. Pour plus d'informations sur les exigences de format et de syntaxe, reportez-vous à la documentation de l'application.
- Cliquez sur l'onglet Authentification sur l'unité d'entrée ou la notification de service Web REST.
- Suivez les instructions relatives au type d'authentification requis par l'application
:
- Pour l'authentification par clé d'API, spécifiez le code d'authentification comme
valeur de la propriété Informations d'identification statiques.
Laissez toutes les autres propriétés vides. Cette procédure est terminée.
- Pour l'authentification par session, laissez la propriété Informations d'identification statiques vide. Passez à l'étape suivante et spécifiez les autres propriétés.
- Pour l'authentification par clé d'API, spécifiez le code d'authentification comme
valeur de la propriété Informations d'identification statiques.
- Définissez la propriété URL de requête d'authentification sur l'URL utilisée par RICOH ProcessDirector pour procéder à l'authentification avec l'application.
- Spécifiez les informations d'identification d'authentification en entrant les valeurs
requises par l’application dans une ou plusieurs des propriétés suivantes : Charge de requête d'authentification, En-tête de requête d'authentification et Paramètres de requête d'authentification.
- Pour la valeur de la propriété Charge de la requête, spécifiez le corps (le cas échéant) de la requête d’autorisation Web que l'unité
d'entrée ou la notification soumet à l’application.
Dans ces exemples, la charge inclut trois éléments XML : <Credentials>, <Name> et <Password>. La valeur de l'élément <Password> est un symbole qui utilise la propriété Mot de passe de requête d'authentification.
Dans cet exemple, la propriété Mot de passe de requête d'authentification est utilisée pour des unités d'entrée :
<Credentials> <Name>myname</Name> <Password>${WebService.AuthRequestPwd}</Password> </Credentials>
Dans cet exemple, la propriété Mot de passe de requête d'authentification est utilisé pour des notifications :
<Credentials> <Name>myname</Name> <Password>${WSNotification.WebService.AuthRequestPwd}</Password> </Credentials>
L'unité d'entrée ou la notification résout le symbole lorsqu'elle envoie la requête d'authentification.
- Définissez les valeurs des propriétés En-tête de la requête et Paramètres de la requête, en fonction des exigences.
Chaque champ ou paramètre d’en-tête est une paire mot-clé/valeur. Chaque paire doit figurer sur une ligne indépendante et être séparée par un signe deux-points (:) ou égal (=).
Le mot-clé et la valeur peuvent être plusieurs mots. RICOH ProcessDirector utilise le premier signe deux-points ou égal de chaque ligne pour séparer les mots en paire mot-clé/valeur.
Les exemples suivants contiennent deux paramètres : name et pwd. La valeur du mot-clé pwd est un symbole qui utilise la propriété Mot de passe de requête d'authentification.
Dans cet exemple, la propriété Mot de passe de requête d'authentification est utilisée pour des unités d'entrée :
name:myname pwd:${WebService.AuthRequestPwd}
Dans cet exemple, la propriété Mot de passe de requête d'authentification est utilisé pour des notifications :
name:myname pwd:${WSNotification.WebService.AuthRequestPwd}
L'unité d'entrée ou la notification résout le symbole lorsqu'elle envoie la requête d'authentification.
- Pour la valeur de la propriété Charge de la requête, spécifiez le corps (le cas échéant) de la requête d’autorisation Web que l'unité
d'entrée ou la notification soumet à l’application.
- Définissez la valeur des propriétés Méthode de demande et Type de contenu de demande sur les valeurs requises par le service Web.
- Définissez la propriété Attribut de la réponse d'authentification sur l'expression XPath qui identifie les informations d'identification de la session dans la réponse du service Web.
- Définissez la propriété Mot de passe de requête d'authentification sur le mot de passe de votre compte associé à l'application.Le mot de passe est crypté lorsqu'il est stocké dans RICOH ProcessDirector.
- Pour les unités d'entrée, cette propriété est WebService.Credential.
- Pour les notifications, cette propriété est WSNotification.WebService.Credential.
Lorsque vous spécifiez des valeurs sous l'onglet Requête pour une unité d'entrée ou notification de service Web REST, vous spécifiez la propriété WebService.Credential ou WSNotification.WebService.Credential sous forme de symbole.
RICOH ProcessDirector remplace le symbole par la valeur des informations d'identification ou du jeton lorsqu'il transmet la requête à un service Web.
- Préparation de la récupération de l’entrée des services Web REST.
- Préparation de l'envoi de statut à un service Web REST