Open topic with navigation

BarTender fournit une documentation complète pour les points de terminaison de l'API ainsi que des exemples d'actions aux formats YAML, JSON et BTXML. Vous pouvez consulter cette documentation après avoir installé BarTender en utilisant ReDoc, qui est inclus dans le fichier d'installation BarTender.

Pour consulter l’API en utilisant ReDoc

Avant de concevoir vos propres applications pour travailler avec l'API, vous pouvez utiliser un outil pour tester la manière dont l'API peut être utilisé. Vous pouvez utiliser l'un des nombreux outils populaires, tels qu'Insomnia et Postman, pour accéder aux points de terminaison de l'API.

Pour accéder aux points de terminaison de l'API à l'aide d'Insomnia

Considérations relatives à la connexion à distance

Si vous exécutez BarTender sur un ordinateur qui utilise une connexion à distance, tenez compte des directives suivantes lorsque vous accédez à l'API REST, à la fois pour exécuter l'API et pour récupérer la documentation de l'API :

• Vous devez configurer Microsoft Internet Information Services (IIS) et installer Print Portal sur le serveur qui exécute l'API REST de BarTender.

• Pour accéder aux points de terminaison de l’API, utilisez « http://<hostname or IP address>/BarTender/api/actions ».

• Pour accéder à la documentation ReDoc, utilisez « http://<hostname ou l’adresse IP>/BarTender/api/actions/reference/index.html ».

• Le navigateur peut vous demander de saisir vos informations d'identification pour l'authentification.

• Si vous êtes un utilisateur du domaine et que l'ordinateur distant que vous utilisez se trouve dans le même domaine Windows, vous pouvez utiliser votre compte de domaine pour vous connecter. Sinon, un compte local de cet ordinateur distant est nécessaire.

Dépannage

Lorsque vous exécutez l'API REST, les erreurs suivantes peuvent se produire :

• 401 : Indique que le client HTTP n'a pas réussi à se connecter à l'ordinateur spécifié dans l'URL.

• 403 : Indique que la demande de connexion provient d'un utilisateur qui n'a pas le droit d'administrer des intégrations. Pour exécuter des actions ou des scripts BTXML en utilisant l'API, un utilisateur doit avoir spécifié Autoriser pour la permission Gérer les intégrations dans la console d’administration.