Tipos de Aplicaciones para la API REST de BarTender Cloud
Pregunta
¿Qué tipos de aplicaciones pueden realizar llamadas RESTful a la API REST? ¿Cuáles son las diferencias?
Aplicable a
- API REST de BarTender Cloud
- Suscripciones Automation
Respuesta
Al realizar llamadas a la API REST, la aplicación debe enviar un token y estar autorizada antes de que el API Gateway procese las llamadas. Si bien ambos tipos requieren un token para pasar por el portal de seguridad, el método para obtener el token es diferente.
Los dos tipos de aplicaciones son:
- Aplicaciones privadas/directas: Insomnio, Postman, etc.
- Aplicaciones web: aplicaciones personalizadas
Aplicaciones Privadas
Las aplicaciones privadas, a veces llamadas aplicaciones directas, envían una llamada API directamente a la API REST y no realicen ninguna llamada adicional fuera de estas llamadas API. Aplicaciones como Insomnia y Postman entran en esta categoría.
Una aplicación directa usa un token para pasar a través del portal de seguridad y hacer Llamadas a la API.
El token se debe recuperar manualmente desde la interfaz web de Cloud y se encuentra en la sección API de Cloud en la configuración de su perfil o en Administrar cuenta en Cloud:
Para aplicaciones directas, el token de seguridad debe enviarse con todas las llamadas a la API. En Insomnia, por ejemplo, la pestaña Auth puede llevar el token. El token está en la lista como un token portador (un token de autorización otorgado por el portador del mensaje, es decir Insomnia). Una vez que haya seleccionado la opción de token, pegue su token y se transportará junto con el mensaje de la API.
Aplicaciones Web
Las aplicaciones web están diseñadas en lenguajes como C# y actúan como una interfaz alternativa. Permite las interacciones del usuario, incluido el inicio de sesión para autenticarse con Cloud. Este tipo de aplicaciones tienen pasos adicionales para recuperar un token y, en última instancia, pasar por el portal de seguridad y realizar llamadas a la API. Aquí puede ver el proceso de autorización de manera resumida.
¿Por qué elegir esto en lugar de una aplicación directa si impliquen tantos pasos adicionales? El proceso de autenticación con el proveedor de identidad de OAuth actualiza la seguridad token en cada inicio de sesión y el usuario nunca tiene que lidiar con tokens directamente. Todo es manejado por OAuth y la propia aplicación. Luego, una vez que la aplicación tiene un token válido, entonces puede comenzar a enviar llamadas API y pasar a través del portal de Seguridad.
Las aplicaciones web deben estar registradas en la propia Cloud. Esto asegura que sólo las aplicaciones autorizadas pueden trabajar con la Cloud. Cualquier cosa no autorizada se le negará el acceso. El registro se encuentra en la interfaz web de Cloud en la sección API de la Cloud en la configuración de su perfil de usuario o en Administrar cuenta Cloud.
Al registrar una aplicación web, se le harán una serie de preguntas sobre la aplicación en sí. Cada campo tiene una breve descripción (salvo Nombre y Descripción, que son suficientemente obvios) para garantizar que la información correcta llegue al lugar correcto y la aplicación esté debidamente registrada.
Todas las aplicaciones aparecerán en la lista bajo la sección Registro de aplicaciones web
En el lanzamiento, tendrán acceso a varios ejemplos de cómo escribir una aplicación web personalizada y cómo generar el diálogo de autenticación. Puede encontrarlos y más información aquí en nuestra Ayuda de BarTender Cloud.