Utilisation des services Web
Préparation de RICOH ProcessDirector à recevoir des demandes de service Web
Avant de pouvoir soumettre des demandes de services Web, vous devez créer un utilisateur et un mot de passe RICOH ProcessDirector pour les services Web à utiliser. Assurez-vous que l'ID utilisateur dispose des droits d'accès appropriés dans RICOH ProcessDirector pour effectuer les actions du service Web. Pour les exemples de ce chapitre, les droits Opérateur sont suffisants. Si vous utilisez le protocole LDAP (Lightweight Directory Access Protocol) pour l'authentification, créez un utilisateur dans LDAP pour les services Web à utiliser. L'utilisateur LDAP doit appartenir à un groupe qui dispose des droits d'accès appropriés dans RICOH ProcessDirector.
Tous les utilisateurs devant modifier leur mot de passe lors de leur première connexion, connectez-vous à l'interface utilisateur de RICOH ProcessDirector à l'aide de l'ID utilisateur que vous venez de créer et modifiez le mot de passe. Si certains de vos mots de passe doivent expirer après une période donnée, vous devez vous connecter et modifier ce mot de passe si nécessaire.
Préparation des demandes de service Web
Lorsque vous créez des demandes, gardez les points suivants à l'esprit :
- L'utilisateur des services Web doit se connecter avant toute action.
Pour soumettre des demandes de service Web, vous devez d'abord utiliser le service Web GET /users/login pour vous connecter à RICOH ProcessDirector en tant qu'utilisateur de service Web, et recevoir une marque d'accréditation. Cette marque doit être incluse dans l'en-tête de toutes les demandes de service Web que vous soumettez jusqu'à ce que vous soumettiez le service Web POST /users/logout/{name}.
- Les noms de propriété doivent être exprimés au format de la base de données, et non
au format de l'interface utilisateur.
Lorsque vous incluez un nom de propriété dans une demande, vous devez utiliser le nom de propriété de la base de données. Par exemple, si vous souhaitez utiliser GET /objects/{objectType} pour récupérer la valeur Classe d'un travail, insérez Job.Class comme valeur attribute dans la demande. Les noms de propriété de la base de données sont disponibles dans l'aide de champ de chaque propriété, dans le système d'aide du produit, dans les résultats envoyés par certains services Web et dans Noms des propriétés de base de données.
- Les valeurs de propriété doivent être exprimées au format de la base de données, et
non au format de l'interface utilisateur.
Lorsque vous incluez une valeur dans une requête, vous devez vous assurer qu'il s'agit d'une valeur valide. Généralement, les champs numériques nécessitent des valeurs numériques et les champs de texte nécessitent des valeurs de texte. Cependant, certaines propriétés présentent des listes limitées de valeurs.
Toute propriété qui fournit une liste déroulante peut uniquement accepter certaines valeurs. En outre, les valeurs qui apparaissent dans ces listes ne sont pas toujours les mêmes que celles enregistrées dans la base de données. Par exemple, dans l'interface utilisateur, les valeurs pour la propriété Agrafe incluent :
- 2 à gauche
- 2 à droite
- Coin supérieur gauche
- Coin supérieur gauche à la verticale
- Coin inférieur gauche
- 2_at_left
- 2_at_right
- Top_left
- Top_left_vertical
- Bottom_left
Dans les demandes de service Web, vous devez utiliser la valeur de la base de données. Les valeurs de la base de données pour les propriétés sont disponibles dans le système d'aide du produit et dans Noms des propriétés de base de données.
-
Les propriétés de travail positionnelles doivent inclure les noms de la phase, de l'étape et du flot de travaux dans cet ordre, après le nom de la propriété. Mettez chacun de ces trois noms entre crochets.
Cet exemple de chaîne JSON spécifie un fichier de contrôle sur un système Linux, en tant que valeur de la propriété de travail Identifier le fichier de contrôle PDF (nom de la base de données Job.IdentifyPDFControlFile) :
"Job.IdentifyPDFControlFile[Prepare][IdentifyPDFDocuments][PullPDFSample]":"/aiw/aiw1/testfiles/PullPDF.ctl"
La propriété de travail se trouve à l'étape IdentifyPDFDocuments de la phase Préparer du flot de travaux PullPDFSample.