Para ver la API utilizando ReDoc
Acceso a la API para la documentación y comprobación de puntos finales |
BarTender proporciona una documentación completa sobre los puntos de conexión API junto con ejemplos de acciones en formatos YAML, JSON y BTXML. Puede ver esta documentación después de instalar BarTender utilizando ReDoc, que se incluye en el archivo de instalación de BarTender.
Para ver la API utilizando ReDoc
Antes de diseñar sus propias aplicaciones para trabajar con la API, es posible que quiera utilizar una herramienta para probar cómo se puede utilizar la API. Puede utilizar una de varias herramientas populares, como Insomnia y Postman, para acceder a los puntos finales de la API.
Para acceder a los puntos finales de la API utilizando Insomnia
Si ejecuta BarTender en un ordenador que utiliza una conexión remota, tenga en cuenta las siguientes directrices cuando acceda a la API REST, tanto para ejecutar la API como para recuperar la documentación de la misma:
Debe configurar Microsoft Internet Information Services (IIS) e instalar Print Portal en el servidor que está ejecutando la API REST de BarTender.
Para acceder a los puntos finales de la API, utilice "http://<nombre del host o dirección IP>/BarTender/api/actions".
Para acceder a la documentación de ReDoc, utilice "http://<nombre de host o dirección IP>/BarTender/api/actions/reference/index.html".
Es posible que el navegador le pida que introduzca sus credenciales para la autentificación.
Si es un usuario de dominio y el ordenador remoto que está ejecutando se encuentra en el mismo dominio de Windows, puede utilizar su cuenta de dominio para iniciar sesión. De lo contrario, se requiere una cuenta local del ordenador remoto.
Cuando ejecute la API REST, pueden producirse los siguientes errores:
401: Indica que el cliente HTTP no ha podido iniciar sesión en el ordenador especificado en la URL.
403: Indica que la solicitud de inicio de sesión procede de un usuario que no tiene permiso para administrar integraciones. Para ejecutar acciones o archivos de comandos BTXML utilizando la API, un usuario debe tener especificado el permiso Permitir para administrar integraciones en Administration Console.