L’interface utilisateur et la documentation de Print Portal font référence aux dossiers racines pour décrire les dossiers que vous avez configurés afin de les rendre disponibles dans Print Portal. L’API REST fait référence à ces dossiers sous le nom de « bibliothèques ». Vous verrez la différence en faisant la requête d’une liste (ou l’énumération) des dossiers racines. Lorsque vous énumérez le contenu d’un dossier racine (bibliothèque), tous les sous-dossiers et les éléments qui les composent (sous-dossiers ou documents) sont répertoriés.
Une API REST est un style architectural logiciel pour l’acquisition et la manipulation de représentations textuelles du contenu des ressources Web. L’API REST Print Portal représente les données au format JSON, de sorte que les données soumises et renvoyées sont au format JSON.
Les exemples de ce tutoriel commencent par des requêtes d’URL et la réponse, à l'aide du navigateur. Vous trouverez également des exemples JavaScript pour élaborer des requêtes par programme.
Pour les étapes de ce tutoriel, comme le navigateur est installé sur le même client que Print Portal, « localhost » est utilisé dans la chaîne de l’URI.
Print Portal contient un système de spécification d’API REST appelé Swagger. Swagger peut être considéré comme un système d’aide de l’API REST qui procure des explications pour chaque fonction et un environnement d’exécution pour tester les requêtes.
|
|
Pour visualiser l’interface Swagger, ajoutez « swagger » après « BarTender » dans l’URI BarTender, comme suit : http://localhost/BarTender/swagger/ |
La présentation de Swagger est divisée en deux moitiés. La section supérieure contient l’explication des fonctions de l’API et la fonctionnalité permettant de tester les requêtes d’API. La section inférieure, intitulée Modèles, contient une explication de chaque fonction et les paramètres nécessaires. Par exemple, si vous voulez connaître la valeur de printRequestID, accédez à la section Modèles, puis cliquez sur PrintRequest pour afficher une liste d’arguments et leurs définitions, dont l’un est printRequestID.