Quelles API REST sont disponibles dans BarTender Cloud ?
Question
Quelles API sont disponibles ? Que fait chacun ?
Applicable à
- API REST BarTender Cloud
- Abonnement Automation
API de sécurité
L'API de sécurité gère tout ce qui concerne les utilisateurs, les autorisations, la gestion des groupes et gestion des rôles.
Les bases de la sécurité
La sécurité fonctionne un peu différemment dans la Cloud que dans le logiciel Windows de BarTender. La différence principale est qu'il n'y a pas de concept de dénégation d'accès.
Le logiciel Windows de BarTender dispose du concept Refuser, qui écrase toute autorisation Autoriser pour un utilisateur particulier tant que ce refus est activé (qu'il provienne d'un groupe ou explicitement défini pour l'utilisateur lui-même). Cela définit l'autorisation effective de l'utilisateur comme Toujours refuser peu importe si c'est autorisé ailleurs.
Cloud n'a rien d'aussi explicite et fonctionne plutôt à base d'un système d'autorisation "autorisé" ou "non autorisé". Il crée une union de toutes les sources (rôles, groupes, paramètres individuels) pour déterminer si un utilisateur est autorisé ou non à effectuer une action. Si un utilisateur est autorisé à faire quelque chose dans un groupe, il est autorisé à le faire même si dans un autre des groupes auquels il appartient cette autorisation n'est pas donnée. Par exemple, si l'utilisateur A appartient au groupe de gestion des documents (qui peut gérer les documents) mais appartient également au groupe d'opérateurs d'impression (qui a seulement l'autorisation d'impression), l'utilisateur A a l'autorisation pour gérer les documents parce c'est défini dans un des groupes.
Gestion des utilisateurs
L'API a les fonctions suivantes
- Créer un utilisateur
- Supprimer un utilisateur
- Mettre à jour les informations de l'utilisateur
Gestion des rôles
Les rôles sont essentiellement des conteneurs pour les autorisations. Ces autorisations sont attribuées à tous les utilisateurs contenus dans ce rôle spécifique.
Les rôles sont attribués aux groupes et aux utilisateurs pour définir leurs autorisations. Ces autorisations servent pour définir les autorisations sur des fichiers à travers de l'interface Web ou à travers de l'API. Ils peuvent également contrôler si des utilisateurs ou des groupes ont accès à des API spécifiques.
API des imprimantes
L'API des imprimantes (parfois appelée API de gestion d'impression) gère tout ce qui concerne les imprimantes. Cela inclut l'interrogation des imprimantes connectées, l'obtention d'informations sur l'imprimante et les états des travaux d'impression. Pour le moment, il n'y a pas d'appels d'API pour interroger Print Histoire.
De nombreux appels d'API sont gérés par le service de Contrôleur d'impression, qui communique avec le service Print Gateway exécuté localement sur les ordinateurs clients.
ID d'imprimante
Les ID d'imprimante sont des identifiants unique pour les imprimantes dans un espace locataire. Chaque imprimante est identifiée par le nom du client + le nom de l'imprimante
- imprimante :<nom_client>/<nom_imprimante>
Par exemple, si vous avez une imprimante en réseau avec le nom Zebra_105 et celle-ci est connectée à plusieurs clients, chaque client aurait son propre ID pour cette même imprimante. Ainsi, l'imprimante pourrait apparaître comme printer:mariopc/Zebra_105, printer:luigipc/Zebra_105 et printer:bowserpc/Zebra105 pour identifier de manière unique quel client va imprimer sur cette imprimante. Cela n'affecte pas la licence car la licence n'est pas basé sur le nombre des imprimantes, il n'y a donc pas de duplication d'imprimantes. C'est, simplement un identifiant pour que le contrôleur d'impression sache où envoyer le travail d'impression.
API librarian
L'API Librarian est l'API REST qui fonctionne avec les fichiers et les dossiers stockés dans Espace Librarian. Vous pouvez la considérer comme le gestionnaire de fichiers et de dossiers à travers d'appels API. Elle a accès aux deux espaces Librarian et peut travailler avec des fichiers et des dossiers dans les deux. L'API Librarian ne peut pas imprimer des documents.
URIs de librarian
L'espace Librarian dispose de ses propres URIs pour identifier un fichier ou un dossier ainsi que toute information supplémentaire nécessaire pour récupérer la version correct de l'Espace Librarian et aussi pour determiner quel est l'espace où se trouve le fichier ou le dossier. Les URIs sont utilisé non seulement dans l'API Librarian mais également dans l'API d'Action pour référencer n'importe quel fichier stocké dans l'espace Librarian. Les URIs de fichier sont utilisés par les deux API, mais, en général, les URIs de dossier sont utilisés seulement par l'API Librarian.
La syntaxe générale d'un URI est
- librarian://<space>/<path>[?parameter1=value1¶meter2=value2]
Les valeurs et les paramètres peuvent être chaînés à la fin à l'aide d'un &. Le ? est seulement nécessaire si l'URI inclut des paramètres.
Les deux espaces sont Main et $temp.
Exemples d'URI
Espace principal
- librarian://Main/Shipping/Label.btw
- librarian://Main/MyLabel.btw?version=3
Espace $temp
- librarian://$temp/Work/File.txt
- librarian://$temp/label.btw
API d'actions
L'API Cloud d'action indique à Cloud d'automatiser ou de d'actualiser les travaux d'impression. Alors que celle-ci ressemble à l'API REST de BarTender et a des actions similaires, L'API d'action ne peut prendre des appels qu'en YAML et ses actions sont limitées aux actions qui se puissent exécuter sans mettre en jeux la sécurité de l'environnement Cloud. Les actions sur les bases de données et actions comme par exemple Exécuter SQL ne sont pas incluses dans l'API. Pour une liste complète, vueillez consulter la documentation de l'API.
En plus d'imprimer des étiquettes, l'API d'action peut soliciter de l'information sur les actions en cours d'exécution et peut aussi exécuter certaines actions sur les dossiers et les fichiers. La plupart des tâches de dossier seront gérées par l'API Librarian.
Dépendance à d'autres API
Si vous ne connaissez pas l'emplacement exact ou l'adresse correcte d'une ressource , vous pouvez utiliser d'autres API pour trouver les informations désiré:
- API Librarian pour l'emplacement du fichier
- API d'impression pour le nom et les informations de l'imprimante.
Comme il s'agit d'API distinctes, vous aurez besoin de plusieurs appels pour récupérer l'informations nécessaires. Si vous le savez déjà, vous pouvez ignorer les appels supplémentaires et passer immédiatement à l'invocation des actions.