Utiliser l’API REST BarTender |
L'API REST de BarTender fournit des points de terminaison REST que vous pouvez utiliser pour automatiser votre système sur une plate-forme non Windows ou sur le réseau en utilisant le format de fichier YAML ou JSON ou un script BTXML existant. En utilisant l'API REST de BarTender, vous pouvez utiliser la plupart des types de langages de programmation, y compris C#, Java, Perl ou Python, et la plupart des environnements de développement intégrés (IDE) pour créer vos scripts d'automatisation.
|
|
L’automatisation de BarTender à l’aide de l’API REST BarTender doit être réalisée par des programmateurs qui connaissent les API REST. |
L'API REST de BarTender utilise le même service d'intégration BarTender et le même service de planificateur d'impression que ceux utilisés par Integration Builder et Process Builder. La communication avec le serveur a lieu sur le port 5159.
Pour l'envoi de scripts et la réception de réponses, l'API prend en charge les charges utiles de données aux formats JSON, YAML et BTXML. A YAML reference document is included in the BarTender installation; for more information, refer to Available Actions in the Actions API. Pour en savoir plus sur BTXML, consultez
L’API prend en charge les technologies suivantes :
Partage de ressources inter-origine (CORS) pour que les points de terminaison REST soient accessibles à partir de sites Web provenant de n'importe où
Plusieurs schémas d'authentification, dont l'authentification de base, l'authentification intégrée (Microsoft Negotiate) et Windows Challenge/Response (NTLM)
|
|
Pour des raisons de sécurité, l'authentification de base est désactivée par défaut. Vous pouvez activer l'authentification de base en définissant son paramètre sur « true » dans le fichier de configuration appsettings.json. Ce fichier est installé dans le répertoire suivant : C:\Program Files\Seagull\BarTender 2022\net6.0 |
HTTPS sécurisé
Pour utiliser l'API REST de BarTender, les conditions suivantes sont requises :
Vous exécutez l'édition Automation ou Enterprise de BarTender 2022.
Le port 5159 est ouvert afin que l'API puisse recevoir les commandes REST.
Vous disposez des autorisations nécessaires pour vous connecter au serveur et pour administrer les intégrations telles que configurées dans la console d'administration.
Accès à l'API pour la documentation et les tests des points de terminaison
Décrit les applications que vous pouvez utiliser pour accéder à l'API REST de BarTender et pour tester vos scripts d'automatisation.
Décrit les commandes de l'API REST de BarTender que vous pouvez utiliser pour créer vos scripts et fournit des exemples de code.