Utilisation d'un service Web SOAP pour s’authentifier avec une application

Les objets d'unité d'entrée et de notification de service Web SOAP peuvent utiliser un service Web SOAP pour s'authentifier avec une application. RICOH ProcessDirector prend en charge l'authentification par clé API et par session. Les objets d'unité d'entrée s'authentifient lorsqu'ils interrogent l'entrée. Les objets de notification s'authentifient lorsqu'ils envoient un statut à l'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 SOAP 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. Le jeton est transmis 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.

Pour utiliser un service Web SOAP pour s'authentifier :
  1. Cliquez sur l'onglet Authentification sur l'unité d'entrée ou la notification de service Web SOAP.
  2. 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.
  3. 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.
    Si l'application exige des informations d'identification d'authentification dans l'URL, spécifiez-les en utilisant la syntaxe et le format requis.
  4. Pour la valeur de la propriété Charge de requête d'authentification, spécifiez le corps de la requête de services Web que l'unité d'entrée ou la notification soumet à l'application pour l'authentification.
    Dans ces exemples, la charge inclut trois éléments : <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.

  5. Définissez la propriété Requête SOAP d'authentification sur la requête SOAP créée par RICOH ProcessDirector lorsque vous avez importé le fichier WSDL.
    Supposons que vous voulez utiliser la requête SOAP AuthenticateUser. Vous avez ajouté PrintShop aux noms des requêtes SOAP lorsque vous les avez importées. Sélectionnez PrintShop-AuthenticateUser.
  6. 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.
  7. 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 l'authentification par clé d'API et par session, RICOH ProcessDirectorstocke les informations d'identification statiques ou le jeton renvoyés par l'application dans une propriété.
  • 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 SOAP, 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 au service Web.

Maintenant que vous avez spécifié les valeurs requises pour procéder à l'authentification avec l'application, effectuez la procédure permettant de définir et de configurer l'unité d'entrée ou la notification. Revenez à l'une de ces rubriques :
  • Préparation de la récupération de l'entrée des services Web SOAP
  • Préparation de l'envoi de statut à un service Web SOAP