Question

Comment fonctionne l'authentification? Que sont les jetons?

Applicable à 

API REST BarTender Cloud

Réponse

L'API REST Cloud nécessite une authentification et, sans elle, les appels ne peuvent pas atteindre la passerelle API. Il n'y a pas d'options pour utiliser une authentification de base ou simplement envoyer des commandes sans aucune authentification. Les appels non autorisés seront rejetés par le porteil d'authentification et ne seront pas autorisés à continuer.

Voici les informations de base sur le fonctionnement de l'authentification.

Que sont les jetons?

Au lieu d'utiliser un nom d'utilisateur et un mot de passe, l'API utilise des jetons d'accès. Un jeton est une longue série de caractères alphanumériques et de symboles qui n'ont apparemment pas de sens mais contient des informations importantes sur qui effectue les appels d'API et vers où ils sont dirigés. Un jeton ressemble généralement à ceci :

Ce jeton contient deux informations clés

• ID de locataire - indique à l'API à quel espace de locataire cet appel doit aller
• ID utilisateur - identifie l'identité de l'utilisateur qui passe l'appel

Sans ces informations, le jeton est refusé et l'appel d'API est renvoyé.

Ces informations sont générées par un fournisseur d'identité, OAuth pour être précis. C'est le même fournisseur qui nous permet de nous connecter à Cloud á travers de l'interface Web.

Où pouvez-vous trouver le jeton?

Les jetons peuvent être situés dans l'interface Cloud sous les paramètres de votre profil ou la section Gérer le compte Cloud. Si un espace locataire a un abonnement Automation, l'option API apparaîtra en bas du menu de gauche.

Quelles applications utilisent un jeton ?

Alors que toutes les applications effectuant des appels d'API utiliseront finalement un jeton, seuls les des applications comme Insomnia ou Postman définissent explicitement un jeton.

Applications Web - interfaces personnalisées conçues pour passer des appels et interagir avec l'API - utilisent les appels OAuth pour créer un dialogue de connexion. À la base, cela génère un jeton d'accès après qu'OAuth ait vérifié l'identité de l'utilisateur et pour autant se comporte un peu comme tout autre appel à l'API.

Pour plus d'informations sur l'utilisation de l'authentification et sur les différences entre les types d'applications, voir Types d'applications de l'API Cloud REST

Remarque spéciale sur les imprimantes et les jetons locaux

Pour utiliser des imprimantes sur un système client spécifique, le client doit se connecter à Cloud au moins une fois pour établir une connexion. Cette configuration se fait automatiquement si vous installez Print Gateway à partir de la boîte de dialogue d'impression dans Cloud lui-même.

Si vous avez installé Print Gateway à travers du programme d'installation, et non à partir de la boîte de dialogue d'impression cloud, et vous ne vous avez pas connecté à Cloud pour configurer la Print Gateway, il existe un jeton spécial qui permet à cet Print Gateway de communiquer avec Cloud.

Ce jeton spécial est situé en haut des paramètres de Print Gateway.

Ce jeton n'est nécessaire que si le système client ne s'est jamais connecté à Cloud pour configurer Print Gateway. Si un Client s'est connecté ou a installé le Print Gateway directement à partir de la boîte de dialogue d'impression, continuez à utiliser le jeton d'accès fourni dans les paramètres Cloud de l'interface Web.