Autenticaciones y Tokens de la API REST de BarTender Cloud
Pregunta
¿Cómo funciona la autenticación? ¿Qué son los Tokens?
Aplicable a
API REST de BarTender Cloud
Respuesta
La API REST de la Cloud requiere autenticación y las llamadas no pueden llegar a la puerta de enlace API. No hay opciones para usar autenticación básica o simplemente enviar comandos sin utilizar autenticación. Las llamadas no autorizadas serán rechazadas por el portal de autenticación y no se le permite continuar.
Aquí está la información básica sobre cómo funciona la autenticación.
¿Qué Son los Tokens?
En lugar de usar un nombre de usuario y una contraseña, la API utiliza tokens de acceso. Un token es una larga serie de caracteres alfanuméricos y símbolos que, al parecer, carece de sentido pero contiene información importante sobre quién está haciendo estas llamadas a la API y hacía dónde están dirigido. Un token generalmente se ve así:
Dentro de este token hay dos piezas clave de información
- ID de arrendatario: le dice a la API a qué espacio de arrendatario debe ir esta llamada
- ID de usuario: identifica la identidad de usuario de quién está realizando la llamada
Sin esta información, se no se puede extraer, el token se deniega y se devuelve la llamada a la API.
Esta información es generada por un proveedor de identidad, OAuth para ser específicos. Este es el mismo proveedor que nos permite iniciar sesión en Cloud a través de la interfaz web.
¿Dónde Puedes Encontrar el Token?
Los tokens se pueden ubicar en la interfaz Cloud en la configuración de su perfil o en la Sección Administrar cuenta Cloud. Si un espacio de arrendatario tiene una suscripción Automation, la opción API aparecerá en la parte inferior del menú a la izquierda.
¿Qué Aplicaciones Usan un Token?
Si bien todas las aplicaciones que realizan llamadas a la API finalmente usarán un token, solo las aplicaciones privadas como Insomnia o Postman definen un token explícitamente.
Aplicaciones web - interfaces personalizadas para realizar llamadas e interactuar con la API - utilice llamadas OAuth para crear un diálogo de inicio de sesión. Básicamente, esto genera un token de acceso después de que OAuth verifique la identidad del usuario y se comporte como cualquier otra llamada a la API.
Para obtener más información sobre cómo se usa la autenticación y cómo difiere entre los tipos de aplicaciones, ver Tipos de Aplicaciones de la API de REST en Cloud
Una Nota Especial Sobre las Impresoras y Tokens Locales
Para usar impresoras en un sistema cliente específico, el cliente debe iniciar sesión en Cloud al menos una vez para establecer una conexión. Esta configuración se hace automáticamente si se instala Print Gateway desde el cuadro de diálogo de impresión en la propia Cloud.
Si se instaló Print Gateway a través del instalador, no desde el cuadro de diálogo de impresión en Cloud, y no se inició sesión en Cloud para configurar Print Gateway, se puede utilizar un token que permitirá que Print Gateway se comunique con Cloud.
Este token especial se encuentra en la parte superior de la configuración de Print Gateway.
Este token solo es necesario si el sistema del cliente nunca ha iniciado sesión en Cloud para configurar Print Gateway. Si un Cliente ha iniciado sesión o ha instalado Print Gateway directamente desde el cuadro de diálogo de impresión, continúe usando el token de acceso proporcionado en la configuración de Cloud a través de la interfaz web.