Utilisation de la documentation sur les API REST RICOH ProcessDirector

RICOH ProcessDirector fournit des API REST pour l'intégration de services Web. La documentation interactive est fournie avec ces API et comprend des tests en direct et des informations pour chaque API disponible.

La documentation sur les API REST contient de nombreuses API qu'une application peut utiliser pour s'intégrer à RICOH ProcessDirector. Vous pouvez utiliser la documentation sur les API REST et l'interface de test pour tester vos paramètres. Lorsque vous utilisez l'interface pour tester des services Web, vous accédez au serveur principal RICOH ProcessDirector. Des actions telles que la création, la suppression et l'activation d'objets sont exécutées sur le serveur principal et figurent dans l'interface utilisateur RICOH ProcessDirector. Par conséquent, nous vous suggérons de créer des objets spécifiquement à des fins de test.

Ces étapes montrent comment demander des fichiers journaux pour un objet utilisant des API REST. Elles vous permettent de vous connecter à RICOH ProcessDirector, de demander des fichiers journaux pour l'imprimante exemple et de vous déconnecter.

  1. Ouvrez un navigateur Web et saisissez votre nom d'hôte RICOH ProcessDirector ou votre adresse IP dans la barre d'adresse. Ajoutez /restapi/ à la fin de votre nom d'hôte ou adresse IP pour accéder à la documentation sur les API REST. Par exemple, http://nom_hôte:15080/restapi/
  2. Dans la section users, cherchez POST /users/login.
  3. Cliquez sur Essayer.
  4. Connectez-vous à RICOH ProcessDirector en saisissant vos identifiants RICOH ProcessDirector :
    • Pour le paramètre name, saisissez votre nom d'utilisateur RICOH ProcessDirector.
    • Pour le paramètre pwd, saisissez le mot de passe associé à votre nom d'utilisateur RICOH ProcessDirector.
  5. Cliquez sur Exécuter.
    La documentation sur les API REST utilise les valeurs saisies pour créer une commande Curl et une URL de demande. Elle soumet ensuite la demande à l'URL de demande et vous connecte.

    RICOH ProcessDirector envoie une réponse indiquant si vous avez réussi à vous connecter. La réponse comprend des informations supplémentaires, dont la marque et les actions que cet ID utilisateur est autorisé à faire.

  6. Dans la case Corps de réponse, cherchez et copiez la valeur de la marque.

  7. Dans la section objects, faites défiler les informations jusqu'à trouver POST /objects/log/{objectType}/{name}.
  8. Cliquez sur Essayer.
  9. Récupérez les messages de journal pour l'imprimante exemple en saisissant les paramètres suivants :
    1. Pour le paramètre token, collez la marque que vous avez précédemment copiée.
    2. Pour le paramètre objectType, saisissez Printer.
      Les valeurs d'objectType sont sensibles à la casse. Vous pouvez utiliser le service Web POST /util/objecttypes pour obtenir une liste des types d'objets disponibles sur votre système. Le service Web POST /util/objecttypes se trouve dans la section util.
    3. Pour le paramètre name, saisissez Sample.
  10. Cliquez sur Exécuter.
    Les entrées de journal de l'imprimante exemple sont renvoyées dans la case Corps de réponse.

    Les valeurs Curl et URL de demande sont également renvoyées.

  11. Dans la section users, cherchez POST /users/logout/{name}.
  12. Cliquez sur Essayer.
  13. Déconnectez-vous de RICOH ProcessDirector :
    • Pour le paramètre token, collez la marque que vous avez précédemment copiée.
    • Pour le paramètre name, saisissez votre nom d'utilisateur RICOH ProcessDirector.
  14. Cliquez sur Exécuter.
    Vous êtes déconnecté de RICOH ProcessDirector.

  15. Les valeurs d'exemples sont fournies avec certaines API. Avec des valeurs d'exemple, vous pouvez mettre à jour l'exemple de code et le modifier pour le tester.

    Ces étapes démontrent comment utiliser une API REST pour connecter un dossier dynamique à l'aide d'une valeur d'exemple. Elles vous permettent de vous connecter à RICOH ProcessDirector, de définir l'Unité d'entrée pour accepter les fichiers à partir de HotFolderPDF et de vous déconnecter.

  16. Ouvrez l'interface de l'API REST comme indiqué ci-dessus.
  17. Dans la section users, cherchez POST /users/login.
  18. Cliquez sur Essayer.
  19. Connectez-vous à RICOH ProcessDirector en saisissant vos identifiants RICOH ProcessDirector :
    • Pour le paramètre name, saisissez votre nom d'utilisateur.
    • Pour le paramètre pwd, saisissez le mot de passe associé à votre nom d'utilisateur.
  20. Cliquez sur Exécuter.
  21. Dans la case Corps de réponse, cherchez et copiez la valeur de la marque.
  22. Dans la section objects, faites défiler les informations jusqu'à trouver POST /objects/{objectType}/connect.
  23. Cliquez sur Essayer.
  24. Connectez HotFolderPDF en saisissant les paramètres suivants :
    1. Pour le paramètre token, collez la marque que vous avez précédemment copiée.
    2. Pour le paramètre objectType, saisissez InputDevice.
      Les valeurs d'objectType sont sensibles à la casse. Vous pouvez utiliser le service Web POST /util/objecttypes pour obtenir une liste des types d'objets disponibles sur votre système. Le service Web POST /util/objecttypes se trouve dans la section util.
    3. Pour le paramètre body, cliquez sur Edit Value. Un exemple de texte s'affiche dans une zone de code. Remplacez le mot “string” par “HotFolderPDF”. Assurez-vous que les guillemets entourent le nom de l'objet.
  25. Cliquez sur Exécuter.
    Les propriétés et les paramètres de HotFolderPDF sont renvoyés dans la case Corps de réponse. Le Code de réponse et les En-têtes de réponse sont également renvoyés.
  26. Dans la section users, cherchez POST /users/logout/{name}.
  27. Cliquez sur Essayer.
  28. Déconnectez-vous de RICOH ProcessDirector :
    • Pour le paramètre token, collez la marque que vous avez précédemment copiée.
    • Pour le paramètre name, saisissez votre nom d'utilisateur RICOH ProcessDirector.
  29. Cliquez sur Exécuter.
    Vous êtes déconnecté de RICOH ProcessDirector.

Related information:

Préparation à l'envoi de travaux à l'aide de services Web
Rubrique parente : Services Web de RICOH ProcessDirector