Creación, Edición y Eliminación de Entornos

En la pantalla Environments, puede configurar nuevos entornos para implementar sus APIs.

Su Manager viene con un entorno predeterminado configurado. Si desea crear un nuevo entorno, primero debe registrar un nuevo host para su entorno en la página Inbound Address.

Puede utilizar el mismo host para múltiples entornos, complementando la dirección de cada entorno con una Inbound URL única, siguiendo las instrucciones de esta página. Entonces, todos sus entornos tendrán su propia URL.

Configurar una URL válida es fundamental para que el entorno funcione correctamente. Si configura una URL que reenvía la llamada a un dominio diferente, no se encontrará el recurso de API que se consumirá.

Creando un entorno

Puede configurar un nuevo entorno haciendo clic en el botón + en la esquina inferior derecha de la página Environments.

Hay dos secciones distintas para completar: los campos de datos obligatorios y el área de variables de entorno (environment variables).

Campos obligatorios

Debe completar los campos obligatorios, que comprenden información básica y permisos de visualización y despliegue.

new environment

Información básica

  • Name: nombre que identifica el entorno.

  • Description: descripción que ayuda a identificar el entorno.

  • Host + Inbound URL: comprenden la URL que representará el entorno y recibirá las solicitudes realizadas a las APIs implementadas en él.

    • El campo Host es obligatorio; debe seleccionar un dominio registrado en la pantalla Inbound Address.

    • Cuando selecciona un host, puede complementar la dirección en el campo Inbound URL, que es opcional. La URL se mostrará en el campo para que la complete (vea la imagen a continuación).
      host url

      No es necesario complementar el host con una inbound URL. Sin embargo, tenga en cuenta que cada entorno debe tener una URL única. Dado que es posible utilizar el mismo host para varios entornos, deberá agregar una inbound URL única a todos los entornos que comparten el mismo host.
      El tipo de seguridad que se muestra en la lista de entornos existentes (ninguna, TLS o mTLS) no se configura en la pantalla Environments, sino en Inbound Address. Ahí es donde puede configurar, entonces, si la URL contendrá http:// o https://.

  • Gateway Pool: campo para seleccionar qué grupo de puertas de enlace en su plan contratado atenderá el entorno.

    Siempre puede hablar con su Business Partner si desea contratar más grupos de puertas de enlace.
    Una vez que se ha seleccionado el gateway pool de un entorno, no es posible editar este gateway pool.

Permisos

El campo Environment Deployment Permission está relacionado con el permiso para desplegar API en el entorno. El campo Environment Trace Visibility, a su vez, permite restringir el acceso de visibilidad al Trace (que contiene la lista de llamadas a las APIs implementadas en el entorno en cuestión).

Las restricciones de visualización administradas aquí se aplican tanto al General Trace (que se refiere a todas las API) como al API Trace (haciendo referencia a una API específica y al que se accede a través de la tarjeta de una API).
Puede leer más sobre las reglas de visibilidad para los objetos del Manager aquí.

Para ambos campos, estas son las opciones de permisos:

  • Organization: permitirá el acceso a todos los usuarios de la empresa.

  • Teams: permitirá el acceso al equipo seleccionado. Obtenga más información sobre cómo crear equipos aquí.

  • Only me: permitirá el acceso sólo al usuario que creó el entorno.

El botón para agregar usuarios (Add Users) es habilitado cuando la opción Teams u Only me es seleccionada. A través de él, puede agregar usuarios individuales para darles acceso también (vea la imagen a continuación).

users

Environment Variables

Las variables de entorno (environment variables) son variables con valores únicos dentro de un entorno específico. Se utilizan como configuración adicional para cada entorno, lo que permite personalizar las peticiones para alternar fácilmente entre diferentes contextos. No son obligatorias, pero facilitan el proceso de diseño y gobierno de API.

El API Manager permite crear variables de entorno que se pueden utilizar en diversos puntos de nuestra plataforma, como en el Target o Timeout de la API Destination, al habilitar un Connector o en varios Interceptors (ver la tabla abajo).

Lista de interceptors que permiten el uso de variables de entorno:

Traffic

Security

Mediation

Transformation

Time allowed
Spike arrest
Rate limit
Payload size
Cache write
Billing hits

XML Threat protection
JSON Threat protection
Time Token
IP Filtering
Encrypt
Data Obfuscation
CSRF Token

Service mashup
Service callout
Internall API Call

Query param
Header
Destination

Un ejemplo práctico: imagine que varias APIs desplegadas en un entorno tienen el mismo destino (target destination) y que, en un momento dado, este destino cambia. Sería necesario modificar el destino de cada API individualmente. Sin embargo, si el destino se hubiera establecido como una variable de entorno, todo lo que se necesitaría es modificar el valor de la variable en el entorno en cuestión, y esto actualizaría el destino de las API.

Para registrar variables de entorno, debe crear un mapa de variables o importar uno existente de otro entorno.

Para agregar un mapa, haga clic en el botón ADD MAP. Aparecerá una pantalla como la imagen de abajo. Debe insertar un nombre en el mapa y puede agregar una descripción.

add map

Ahora puede crear variables de entorno como un par clave-valor donde ambos son cadenas de caracteres.

new variables

El campo Type permite cambiar el tipo de variable a las siguientes opciones:

  • DEFAULT: Este tipo es el por defecto de todas las variables, y no cambia nada en su comportamiento.

  • SECURED: Este tipo tiene su valor encriptado. El descifrado se realiza únicamente a través del flujo de un Connector, lo que añade más seguridad a la hora de almacenar sus credenciales, ya que el valor no es recuperable de ninguna otra manera.

También puede agregar un certificado, correspondiente a la comunicación entre el gateway y el backend, que se aplicará cuando se utilice la variable de entorno. Para hacer eso, haga clic en el icono icon certificate. Se abre una ventana modal para que seleccione el certificado, que debe haber sido registrado en la pantalla Certificates.

Para importar un mapa de otro entorno, haga clic en el botón IMPORT MAP. Cuando comience a escribir el nombre del entorno, el sistema cargará la información necesaria. Luego, seleccione el mapa deseado y haga clic en IMPORT MAP.

import map

Se cargarán las variables de entorno. Puede verlas haciendo clic en el icono para ampliar la pestaña junto al nombre del mapa. Puede editar o eliminar las variables haciendo clic en los iconos respectivos (icon edit o icon delete).

Para agregar más variables, haga clic en el icono icon more info y, cuando se abra la pestaña, haga clic en el icono +. En esta misma pestaña, puede hacer clic para editar el nombre y la descripción del mapa (icon edit) o eliminarlo por completo (icon delete).

map delete

Ejemplo de uso

Como mencionamos antes, una variable de entorno es un par clave-valor donde ambos son un cadenas de caracteres. En el siguiente ejemplo, se crearon dos variables: una denominada destination, con una dirección válida, y otra denominada rateLimit, con valor 2.

add variable

La variable de entorno $destination se puede utilizar, por ejemplo, como un endpoint de API. Luego, cuando se realiza una petición a esa API, el gateway dirigirá la llamada a la dirección informada.

Para configurar esto, sólo necesita hacer referencia a esta variable de entorno como el destino (Target Destination) de la API, como se muestra en la imagen a continuación.

El destino de una API se encuentra en la sección Flows del proceso de edición o creación de una API, haciendo clic en el botón icon backend en el diagrama que representa los flujos de request y response.
config destination variable
Todas las variables de entorno, cuando referenciadas en APIs o interceptores, deben estar precedidas por el símbolo $.

En la imagen a continuación, tenemos un ejemplo de la variable de entorno $rateLimit que se usa en el interceptor Rate Limit. En este escenario, cuando se realiza una petición a la API, el gateway reemplazará el número de llamadas con el valor configurado en la variable (en este caso, el valor 2).

rate limit

Edición de entorno

El botón de edición de entornos se encuentra en la lista de entornos existentes, en la columna Actions.

Para editar los datos, haga clic en el icono icon edit y será redirigido a la pantalla de edición.

Eliminación de entorno

Para eliminar un entorno, haga clic en en icono icon delete en la columna ACTIONS de la lista de entornos existentes y confirme la acción haciendo clic en el botón CONFIRM.

Si el entorno que desea eliminar tiene implementaciones de API (es decir, deploys activos), no será posible eliminar el entorno. Para eliminarlo, primero debe deshabilitar los deploys.

Undeploy revisions de un entorno

En la parte inferior de la pantalla de edición de Environments, se enumeran todas los deployments asociados con un entorno.

deployments actions

Haga clic en icon delete deploy, en la columna ACTIONS para realizar undeploy de una revision.

Al hacer clic, se mostrará el siguiente modal:

modal undeploy

Haga clic en el botón CONFIRM para confirmar la acción.

Al desasociar una revision, ya no aparecerá en la lista de deployments.
Si tiene habilitado el Adaptive Governance y ha realizado el undeploy utilizando el método anterior, será posible volver a habilitarlo a través de Despliegue de APIs en la pantalla Environments
Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]