Introducción

En BarTender 2021 y versiones posteriores, los programadores ahora pueden interactuar con Print Portal a través de un conjunto completo de APIs REST. Puedes realizar la mayoría de las operaciones mediante nuestra API REST para autenticar usuarios, listar carpetas, etiquetas e impresoras existentes, y imprimir etiquetas enviando consultas y obteniendo resultados en formato JSON.

Este artículo tiene como objetivo ofrecer una breve descripción general de las APIs REST de Print Portal. Te guiará por el método de autenticación de la API REST y mostrará cómo usar la herramienta swagger para probar la API.

Endpoints y Métodos

La API REST de Print Portal está diseñada siguiendo los principios RESTful y, por lo tanto, soporta los dos métodos HTTP más comunes: GET y POST.  

La API REST de Print Portal proporciona acceso a los recursos a través de URIs de Endpoint. Todos los endpoints de la API de Print Portal tienen la siguiente URL base:

{Print Portal Base URL}/BarTender 

Se debe usar un endpoint específico al enviar solicitudes a la API REST. Print Portal API V1 consta de 4 endpoints que se agrupan de la siguiente manera:

Tabla 1-1 Endpoints y Métodos de la API REST de Print Portal.

/api/v1/Authenticate

/api/v1/print

/api/v1/libraries/{id}

/api/v1/printers/{printerName}

Autenticación 

Cuando la autenticación está habilitada, antes de poder acceder a los recursos de Print Portal, la solicitud debe provenir de un usuario autenticado. Si la autenticación es exitosa, se devolverá un token. 

Para generar un token de autenticación, envía una solicitud POST a

{Print Portal Base URL}/BarTender/api/v1/Authenticate

con el siguiente cuerpo:

{
 "userName": "UserName@Domain",
 "password": "Password"
}

esto devolverá una estructura de usuario en formato JSON que contiene una propiedad token:

{
 "success": true,
 "token": "string",
 "expires_in": 0
}

Al llamar a los endpoints de la API REST, todas las solicitudes futuras deben incluir un encabezado Authorization con el siguiente formato:

Authorization: Bearer <TokenString>

Primeros pasos con Swagger UI

Print Portal también incluye un sistema de especificación de API REST llamado swagger. Swagger UI te permite visualizar e interactuar con los recursos de la API sin necesidad de tener la lógica de implementación lista. Piensa en swagger como un sistema de ayuda para la API REST que ofrece explicaciones, un entorno para probar solicitudes y detalles de cada función.  

Puedes acceder a swagger escribiendo swagger después de BarTender en la URL base de Print Portal, por ejemplo:

{Print Portal Base URL}/BarTender/swagger/

La presentación de swagger está dividida en dos partes, y esto es importante para encontrar la información correcta. La sección superior contiene las explicaciones de las funciones de la API y la posibilidad de probar solicitudes de la API. La sección inferior, titulada “Models”, ofrece una explicación de cada función y sus requisitos.

Como ya se mencionó, Swagger UI ofrece funciones muy útiles para ahorrar tiempo y hacer que probar una API al implementarla sea sencillo y rápido. Por ejemplo, para probar la autenticación, expande el elemento correspondiente en la parte superior para ver los requisitos de autenticación.

Selecciona el botón “Try it out” y agrega tu nombre de usuario y contraseña con el siguiente formato:

Luego haz clic en el gran botón azul Execute:

Esto devolverá un resultado exitoso (cuando la autenticación de PrintPortal esté habilitada y se ingresen correctamente el usuario y la contraseña) y el token de autenticación que se debe usar en futuras llamadas a la API REST.

Más información

Para obtener información adicional que te ayude a comenzar a automatizar Print Portal, puedes consultar el sistema de ayuda de Print Portal.