Introduction

À partir de BarTender 2021, les développeurs peuvent désormais interagir avec Print Portal grâce à un ensemble complet d’API REST. Vous pouvez effectuer la plupart des opérations via notre API REST pour authentifier les utilisateurs, lister les dossiers, étiquettes et imprimantes existants, ainsi que imprimer des étiquettes en envoyant des requêtes et en récupérant les résultats au format JSON.

Cet article propose un aperçu rapide des API REST de Print Portal. Il vous guidera à travers la méthode d’authentification de l’API REST et montrera comment utiliser l’outil Swagger pour tester les API.

Points de terminaison et méthodes

L’API REST de Print Portal est conçue selon les principes RESTful et prend en charge les deux méthodes HTTP les plus courantes : GET et POST.  

L’API REST de Print Portal donne accès aux ressources via des URI de points de terminaison. Tous les points de terminaison de l’API Print Portal partagent l’URL de base suivante :

{URL de base Print Portal}/BarTender 

Un point de terminaison spécifique doit être utilisé lors de l’envoi de requêtes à l’API REST. Print Portal API V1 se compose de 4 points de terminaison regroupés comme suit :

Tableau 1-1 Points de terminaison et méthodes de l’API REST Print Portal.

/api/v1/Authenticate

/api/v1/print

/api/v1/libraries/{id}

/api/v1/printers/{printerName}

Authentification 

Lorsque l’authentification est activée, avant d’accéder aux ressources de Print Portal, la requête doit provenir d’un utilisateur authentifié. Si l’authentification réussit, un jeton sera renvoyé. 

Pour générer un jeton d’authentification, envoyez une requête POST à

{URL de base Print Portal}/BarTender/api/v1/Authenticate

avec le corps suivant :

{
 "userName": "UserName@Domain",
 "password": "Password"
}

cela retournera une structure utilisateur JSON contenant une propriété token :

{
 "success": true,
 "token": "string",
 "expires_in": 0
}

Lors de l’appel des points de terminaison de l’API REST, toutes les requêtes suivantes doivent inclure un en-tête Authorization au format suivant :

Authorization: Bearer <TokenString>

Premiers pas avec Swagger UI

Print Portal inclut également un système de spécification d’API REST appelé Swagger. Swagger UI vous permet de visualiser et d’interagir avec les ressources de l’API sans avoir à implémenter la logique. Considérez Swagger comme un système d’aide pour l’API REST qui fournit des explications, un environnement d’exécution pour tester les requêtes et des descriptions pour chaque fonction.  

Vous pouvez accéder à Swagger en ajoutant swagger après BarTender dans l’URL de base de Print Portal, par exemple :

{URL de base Print Portal}/BarTender/swagger/

La présentation Swagger est divisée en deux parties, ce qui est important pour trouver la bonne information. La partie supérieure contient les explications des fonctions de l’API et la possibilité de tester les requêtes API. La partie inférieure, intitulée « Models », fournit une explication pour chaque fonction et ses exigences.

Comme mentionné précédemment, Swagger UI offre des fonctionnalités pratiques pour faciliter et accélérer les tests d’une API lors du déploiement. Par exemple, pour tester l’authentification, développez l’élément correspondant en haut pour voir les exigences d’authentification.

Sélectionnez le bouton « Try it out » puis saisissez votre nom d’utilisateur et votre mot de passe au format suivant :

Puis cliquez sur le grand bouton bleu Execute :

Vous obtiendrez alors une réponse de succès (si l’authentification PrintPortal est activée et que le nom d’utilisateur et le mot de passe sont corrects) ainsi que le jeton d’authentification à utiliser pour les futurs appels à l’API REST.

Plus d’informations

Pour plus d’informations afin de vous aider à démarrer avec l’automatisation de Print Portal, vous pouvez consulter le système d’aide de Print
Portal.