¿Qué APIs REST Están Disponibles en BarTender Cloud?
Pregunta
¿Qué APIs están disponibles? ¿Qué hace cada una?
Aplicable a
- API REST de BarTender Cloud
- Suscripciones Automation
API de Seguridad
La API de seguridad administra todo lo relacionado con usuarios, permisos, administración de grupos y gestión de roles.
Conceptos básicos de seguridad
La seguridad funciona un poco diferente en Cloud que en la instalación local de BarTender. La diferencia clave es que no existe el concepto de denegación de permiso.
La instalación local de BarTender tiene un concepto de Denegar, siempre que esa denegación esté actíva(ya sea de un grupo o establecido explícitamente en el propio usuario) sobrescribe cualquier permiso Permitir para un usuario en particular. Esto establece el permiso efectivo del usuario como Siempre negar sin importar si algo está permitido en otro lugar.
Cloud no tiene nada tan explícito y en su lugar opera en un sistema de permisos "permitido" o "no permitido". Crea una unión de todas las fuentes (roles, grupos, configuraciones individuales) para determinar si a un usuario se le permite una acción o no. Si a un usuario se le permite hacer algo en un grupo, se le permite hacer esa cosa incluso si otro de los grupos del usuario no tiene un permiso "permitir" correspondiente. Por ejemplo, si el Usuario A pertenece al grupo de gestión de documentos (que puede administrar documentos) pero también pertenece al grupo de operadores de impresión (que solo tiene permisos para imprimir), el usuario A tiene permisos para administrar documentos porque uno de los grupos lo dice.
Gestión de usuarios
La API puede hacer lo siguiente
- Crear un usuario
- Eliminar un usuario
- Actualizar la información del usuario
Gestión de roles
Los roles son esencialmente contenedores de permisos. Estos permisos se asignan a todos los usuarios contenidos dentro de ese rol específico.
Los roles se asignan a grupos y usuarios para establecer sus permisos. Estos permisos se pueden usar para establecer permisos en archivos a través de la interfaz web o a través de la API. También pueden controlar si los usuarios o grupos tienen acceso a APIs específicas.
API de Impresoras
La API de impresoras (a veces llamada API de administración de impresión) maneja todo lo relacionado con las impresoras. Esto incluye consultar las impresoras conectadas, obtener información de la impresora y estados de los trabajos de impresión. Por el momento, no hay llamadas a la API para consultar el historial de impresión.
Muchas de las llamadas API son manejadas por el servicio de Print Controller, que se comunica con el servicio de Print Gateway ejecutándose localmente en los equipos cliente.
ID de impresora
Los ID de impresora son un medio único para identificar una impresora dentro de un espacio de arrendatario. Cada impresora se identifica por el nombre del cliente + el nombre de la impresora
- impresora:<nombre del cliente>/<nombre_impresora>
Por ejemplo, si una Zebra fuera una impresora de red y estuviera conectada a varios clientes, cada cliente tendría su propia identificación para esta misma impresora. Entonces la impresora podría aparecer como impresora: mariopc/Zebra_105, impresora: luigipc/Zebra_105 e impresora: bowserpc/Zebra105 para identificar de forma única qué cliente va a imprimir en esta impresora. Esto no afecta a la concesión de licencias, ya que la impresora no determina la concesión de licencias, por lo que no hay duplicación. Simplemente un identificador para decirle al Servicio Print Controller donde enviar el trabajo de impresión.
API de Librarian
La API de Librarian es la API REST que funciona con archivos y carpetas almacenados en el Espacio Librarian. Puede considerarse como administrador de archivos y carpetas a través de llamadas API. Tiene acceso a ambos espacios de Librarian y puede trabajar con archivos y carpetas en ambos. La API de Librarian no imprime documentos.
URI de Librarian
El espacio de Librarian tiene sus propios URIs que sirven para identificar archivos o carpetas y también para cualquier información adicional necesaria para recuperar la versión correcta dentro del Espacio de Librarian y sirve también para saber en qué espacio se encuentra el archivo o la carpeta. Las URIs no solo se usan en la API de Librarian sino también en la API de Acción para hacer referencia a cualquier archivo almacenado en el espacio de Librarian. Las URIs de archivo son utilizadas por ambas API, pero las URIs de carpeta por lo general, solo los utiliza la API de Librarian.
La sintaxis general para una URI es
- Librarian://<espacio>/<ruta>[?parameter1=Valor1¶meter2=valor2]
Los valores y parámetros se pueden ser añadido al final usando un &. El ? es solo necesario si los parámetros están presentes.
Los dos espacios son Main y $temp.
Ejemplos de URI
Espacio Main
- librarian://Main/Shipping/Label.btw
- librarian://Main/MyLabel.btw?version=3
Espacio $temp
- librarian://$temp/Work/File.txt
- librarian://$temp/label.btw
API de Acción
La API de acción en Cloud le dice a Cloud que automatice o actualice los trabajos de impresión. Aunque esto se asemeja a la API REST de BarTender y tiene acciones similares, la API de acción solo puede recibir llamadas en YAML y las acciones están limitadas a las que se consideren seguros para ejecutar en un entorno Cloud. Acciones de base de datos y acciones como Ejecutar SQL no están incluidas en la API. Para obtener una lista completa, consulte la documentación de la API.
Además de imprimir etiquetas, API de acción puede recuperar información sobre acciones actuales en ejecución, así como realizar algunas acciones en carpetas y archivos. La mayoría de las tareas de carpetas serán manejadas por la API de Librarian.
Dependencia de otras APIs
Si no conoce la ubicación exacta de un recurso o la dirección correcta, puede usar otras API para encontrar la información:
- API de Librarian para la ubicación del archivo
- API de impresión para el nombre y la información de la impresora.
Como se trata de APIs independientes, necesitará más de una llamada para recuperar la Información deseada. Si ya lo sabe, puede saltarse las llamadas adicionales y hacer la llamada de acción de inmediato.