API Gateway
Definiciones
Un API Gateway es una herramienta de gestión de APIs que permite crear o utilizar APIs de terceros en un solo lugar, siendo así una solución rápida y práctica de administración de APIs. Actúa como un proxy reverso para aceptar todas las llamadas a las APIs, agregar los diversos servicios necesarios para ejecutarlas y devolver el resultado apropiado.
Con esto en mente, para facilitar la creación de tus flujos en diferentes integraciones, la solución de API Gateway de Skyone Studio fue creada para ser tu centro de gestión de APIs, contando con autenticación Basic (con usuario y contraseña) para uno o más usuarios y enrutamiento (creación de rutas). Además, puedes no solo administrar APIs externas, sino también crear una API desde cero para usarla dentro de un flujo en Skyone Studio.
Crear un API Gateway
Puedes crear uno o más API Gateways para controlar diferentes APIs, ya sean externas o creadas dentro de Skyone Studio. Para eso, sigue los siguientes pasos:
En la pestaña API Gateway, haz clic en "Crear API Gateway":
En la ventana modal, ingresa el Nombre del API Gateway, Descripción (Opcional), elige un Grupo (por defecto es "default") e Imagen (Opcional).
Para finalizar, haz clic en "Crear".
Cómo editar un API Gateway
Para editar el API Gateway, solo haz clic en el elemento deseado. Luego serás dirigido a la pantalla de edición. Los pasos para la edición se dividen en cada ítem:
Nombre y Descripción:
Haz clic sobre "Nombre" o "Descripción" para que el área se vuelva editable.
Después de realizar los cambios, haz clic fuera del área de edición o presiona la tecla Enter para guardar.
Imagen:
Para cambiar la imagen, pasa el cursor y haz clic en "Editar".
Después de cambiarla, haz clic en "Guardar".
Copiar un API Gateway
Para copiar un API Gateway, basta con hacer clic en "Copiar URL".
Eliminar un API Gateway
Para eliminar un API Gateway, haz clic en "Eliminar", ubicado en los tres puntos de la zona de edición del API Gateway.
Escribe el nombre para confirmar la eliminación y haz clic en "Eliminar" para finalizar.
Versión
Con esta funcionalidad es posible crear diferentes versiones para una misma API, que pueden contener distintas rutas y permisos de acceso.
Creación de una Versión:
En API Gateway, haz clic en el ítem deseado.
Haz clic en "Nueva versión".
Ingresa el Nombre de la versión y haz clic en "Próximo Paso".
Crea una nueva ruta (más información abajo) y haz clic en "Guardar cambios".
Editar una Versión:
En API Gateway, haz clic en el ítem deseado.
En "Versiones", selecciona la versión a modificar y haz clic en "Editar".
Para finalizar, haz clic en "Guardar cambios".
Eliminar una Versión:
En API Gateway, haz clic en el ítem deseado.
En "Versiones", selecciona la versión a eliminar y haz clic en "Eliminar".
En la ventana modal, escribe el nombre para confirmar y haz clic en "Eliminar".
Rutas
Una ruta es una dirección (URL) que lleva a un flujo, es decir, un endpoint de acceso a tu API en Skyone Studio.
Por ejemplo: puedes crear una ruta llamada "/productos" para usar en todos los flujos que trabajan con productos (guardar, listar, eliminar), utilizando una o más versiones. Con los diferentes métodos HTTP, el API Gateway de Skyone Studio facilita tanto el uso como la creación de APIs para distintas actividades en tus flujos.
El API Gateway permite crear dos tipos de rutas: HTTP y Trigger.
Ruta HTTP
Al crear una ruta HTTP (que siempre utiliza una API externa), puedes mapear una URL diferente al endpoint original. Ejemplo: el endpoint externo es "/orders/approve", y puedes crear una ruta interna como "/pedidos/aprobar".
De esta manera, la API externa se usa con una URL personalizada y con control de acceso por usuario.
Pasos para crear una ruta HTTP:
Con la versión ya creada, haz clic en "Próximos pasos".
Haz clic en "Crear nueva ruta".
Completa los datos:
URL de la ruta (puede ser distinta a la original).
Métodos (GET, POST, PUT, PATCH, DELETE).
Tipo de ruta: HTTP.
Protocolo (HTTP o HTTPS), Host y Puerto.
Path original (endpoint).
Límite de ejecuciones (número y período).
Opcional: marca "Ruta protegida" y selecciona el usuario con acceso.
Haz clic en "Guardar ruta".
Ruta Trigger
Una ruta Trigger no utiliza API externa. Sirve para realizar operaciones internas en tus flujos, con control opcional por usuario registrado.
Pasos para crear una ruta Trigger:
Con la versión ya creada, haz clic en "Próximos pasos".
Haz clic en "Crear nueva ruta".
Completa los datos:
URL de la ruta.
Métodos (GET, POST, PUT, PATCH, DELETE).
Tipo de ruta: Trigger.
Límite de ejecuciones.
Opcional: Ruta protegida con usuario asignado.
Haz clic en "Guardar ruta".
Editar Rutas
Dentro de una versión del API Gateway, selecciona la ruta deseada, haz clic en "Editar", realiza los cambios y luego guarda.
Límite de ejecuciones
Es posible gestionar la cantidad de ejecuciones de tu API Gateway a través del Límite de Ejecuciones, es decir, determinar el número máximo de veces que la API puede ser solicitada durante un período de tiempo.
Para ello, en la edición de una ruta, selecciona el número y la unidad de tiempo (segundo, minuto u hora) deseados.
Para finalizar, haz clic en "Guardar Cambios".
La unidad de tiempo se contabiliza por segundo, minuto u hora exactos. Por ejemplo: imagina que tienes una ruta con límite configurado en 2 por minuto. Aunque la llamada comience a las 08:45:55, el límite se mantiene hasta las 08:45:59, ya que a las 08:46:00 comenzará un nuevo ciclo de ejecuciones.Permite definir la cantidad máxima de veces que la API será ejecutada en un período de tiempo.
Eliminar Rutas
Para eliminar, en cualquier momento, una ruta creada:
Dentro de la versión de tu API Gateway, selecciona el ítem que deseas eliminar y haz clic en "Eliminar".
En la ventana modal, escribe el nombre para confirmar la eliminación y haz clic en "Eliminar" para finalizar la acción.
Usuarios
Si deseas restringir el acceso a uno o más usuarios, puedes hacerlo utilizando un método de autenticación (Basic u oAuth2).
Crear Usuarios
Para crear un usuario en el API Gateway, sigue estos pasos:
En API Gateway, haz clic en la pestaña "Usuarios".
Haz clic en "Agregar usuario".
Personaliza el nombre de usuario.
Elige el tipo de autenticación: Basic u oAuth2, y sigue la configuración de acuerdo con el tipo seleccionado.
Para finalizar la configuración del usuario con autenticación Basic, ingresa la Contraseña y luego haz clic en "Guardar usuario".
Para finalizar la configuración del usuario con autenticación oAuth2, haz clic en "Guardar usuario".
Después de crear el usuario, la pantalla mostrará los datos Client ID y Client Secret. Copia esta información e insértala en el endpoint para generar el access_token.
Los usuarios creados se listan en la pestaña "Usuarios" del API Gateway.
Editar Usuarios
Para editar un usuario:
En API Gateway, en la pestaña Usuarios, haz clic en el ícono de "Editar" del usuario deseado.
Realiza las modificaciones necesarias (usuario o contraseña).
Haz clic en "Guardar usuario".
Eliminar Usuarios
Para eliminar un usuario:
En API Gateway, en la pestaña Usuarios, haz clic en "Eliminar" del usuario deseado.
En la ventana modal, escribe el nombre para confirmar y haz clic en "Eliminar" para finalizar la acción.
Puedes eliminar cualquier usuario, siempre que no esté actualmente asociado a una ruta. En caso de que lo esté, primero debes editar las rutas que incluyen al usuario y quitarlo de la casilla de selección "¿Esta ruta está protegida?".
Lea también: Parámetros de URL en el API Gateway
Last updated