Las variables de contexto permiten asociar valores asignados a la cuenta, a los usuarios o a las aplicaciones con los parámetros de los métodos de las APIs. Al configurar un método puede relacionar sus parámetros a variables de contexto: cuando llega una solicitud, el gateway identifica a la aplicación y al usuario que la realizan y completa esos parámetros con los valores que les corresponden. En este video se muestra cómo crear una variable, vincularla a un parámetro y cambiar su valor sin tocar la API.
Los parámetros relacionados a variables de contexto no se exponen en la documentación de las APIs en el portal para desarrolladores: el desarrollador que accede al método no conoce su existencia.
Para conocerlas, vaya a APIs > Variables de contexto. Las variables predefinidas son: Id de usuario, Nombre de usuario, Email de usuario, Rol de usuario, Id de aplicación, Nombre de aplicación, Timestamp (fecha de la solicitud en formato UNIX, por ejemplo 1661351547), Epoch Date (por ejemplo 2022-07-20T17:24:00.000Z), Id y slug de la cuenta e IP de la solicitud. Al acceder a cada variable puede conocer su detalle.
En APIs > Variables de contexto, haga clic en Nueva variable y complete el formulario:
timestamp(), epoch() o today(); A los usuarios y A las aplicaciones permiten asignar un valor a cada usuario o aplicación registrados.Las variables generales usan valores fijos o dinámicos, sin asignar valores específicos a usuarios o aplicaciones. En el video, demo_region vale Norte. Otro ejemplo: una variable llamada JWT username con el valor id_token(username) toma el atributo username del token usado en la solicitud al método.
Si eligió usuarios o aplicaciones, la ficha de la variable muestra el botón Asignar nuevo valor. Se abre una ventana donde puede buscar y seleccionar usuarios o aplicaciones y asignarles un valor para esa variable. En la pestaña Valores asignados puede ver, editar o borrar esos valores.
Una vez creada la variable, en la configuración del método haga clic en el botón Configurar debajo del listado de parámetros. Se muestra una ventana donde se relaciona cada parámetro del método con una variable de contexto, y donde también puede marcar que el parámetro se envíe como cabecera. Confirme con Listo, guarde el método y publique la versión.
Desde entonces el gateway completa el parámetro con el valor de la variable. Si edita la variable, por ejemplo de Norte a Sur, la misma URL responde con los nuevos datos sin republicar la API.
Cuando un usuario o aplicación no tiene valor asignado y realiza una solicitud al método, si el parámetro es obligatorio la solicitud se rechaza; si no lo es, se usa el valor por defecto definido en la vista de datos.
La variable aparece en el listado de Variables de contexto con su contexto de uso. En el método, el parámetro muestra la variable en la columna Variables de contexto y deja de figurar en la documentación del portal. Las respuestas del gateway aplican el valor de la variable.