Cómo configurar Variables de contexto

Cómo configurar Variables de contexto

Resumen

Las variables de contexto permiten asociar valores asignados a la cuenta, usuarios y aplicaciones a valores de parámetros de los métodos de las APIs.

Al configurar el método de la API puedes releacionar sus parámetros a variables de contexto. Cuando se realiza una solicitud al método, el gateway de Vor-Tex identifica a la aplicación y usuario que está realizando la solicitud, y completa los valores de los parámetros relacionados a variables de contexto que correspondan a esa aplicación o usuario.

Los parámetros relacionados a la variables de contexto no se exponen en la documentación de las APIs en el portal para desarrolladores. El usuario desarrollador que acceda al método desconocerá su existencia.






Variables de contexto predefinidas

Para conocer las variables de contexto predefinidas debes ir a APIs > Variables de contexto.

Las variables predefinidas son:
  1. Id de usuario
  2. Nombre de usuario
  3. Email de usuario
  4. Rol de usuario
  5. Id de Aplicacion
  6. Nombre de aplicacion
  7. Timestamp (fecha de la solicitud en formato UNIX Timestamp, ej.: 1661351547)
  8. Epoch Date (fecha de la solicitud en formato Epoch, ej.: 2022-07-20T17:24:00.000Z)



Al acceder a cada variable puedes conocer su detalle.




Agregar variables de contexto

Para agregar nuevas variables de contexto debes ir a APIs > Variables de contexto.

Luego, debes hacer clic sobre el botón Nueva variable y completar el formulario.


  1. Nombre: es el nombre con el que identificarás a la variable.
  2. Descripción: puedes agregar una descripción para dar más contexto sobre el contenido o uso de la variables.
  3. Contexto de uso: las variables pueden aplicar sobre valores predefinidos, asociados a usuarios o asociados a aplicaciones.
    1. Todas las APIs: permite establecer un valor fijo o primitiva (ej.: timestamp(), epoch(), today() ).
    2. Usuarios: deberás asignar valores a cada uno de los usuarios registrados.
    3. Aplicaciones: deberás asignar valores a cada una de las aplicaciones registradas
Una vez creada la variable de contexto, si has seleccionado Usuarios o Aplicaciones, se mostrará el botón Agregar valor que permite buscar a los desarrolladores o aplicaciones registradas e ingresar el valor que deseas aplicar sobre el parámetro relacionado cuando se ejecute la solicitud al método.

Variables generales 

Las variables generales permiten utilizar valores fijos o valores dinámicos, sin asignar valores específicos a usuarios o aplicaciones.

Por ejemplo, la siguiente variable llamada JWT username contiene el valor id_token(username).

Al asignar ese valor, la variable buscará el valor del atributo username del token utilizado en la solicitud al método de la API.


Una vez creada la variable de este tipo podemos visualizar su detalle y comenzar a relacionarlas a los parámetros de un método.


Estas variables generales son útiles también para definir fechas u otros valores.


Variables asignadas a usuarios

Esta opción permite crear variables y asignar valores a cada uno de los usuarios desarrolladores registrados.

Por ejemplo, este caso se crea una variable llamada Company.


Una vez guardada la variable, debe hacer clic sobre el botón Asignar nuevo valor.



Se abrirá esta ventana donde podrás buscar y seleccionar usuarios, y asignarles un valor para esa variable.




En la pestaña Valores asignados puedes conocer los valores asignados a los usuarios, editarlos o borrarlos.



Variables asignadas a aplicaciones

Los pasos para asignar los valores a las aplicaciones son iguales a los de asignación a los desarrolladores.

Configurar parámetros del método

Una vez que hayas creado las variables a utilizar, en la configuración del método de la API puedes configurar los parámetros para relacionarlos a variables de contexto.

Debes hacer clic sobre el botón Configurar debajo del listado de parámetros.


Se mostrará una ventana donde podrás relacionar los parámetros del método a las variables de contexto.



¿Qué sucede si no asignas valores a usuarios o aplicaciones?

Cuando no se hayan asignado un valor para el usuario o aplicación y se realiza una solicitud al método de la API, los parámetros tendrán el siguiente comportamiento:
  1. Si el parámetro es obligatorio se rechazará la solicitud.
  2. Si el parámetro no es obligatorio se utilizará el valor por defecto definido en la vista de datos.




OriginalRemove

    • Related Articles

    • Crear métodos de APIs

      Resumen En el articulo Crear y gestionar versiones de APIs se mostraron los primeros pasos necearios para crear APIs. Los métodos definen la acción que se realizará sobre un determinado recurso. Como primer paso debe seleccionar la opción de Agregar ...

    • Crear y configurar API

      Resumen Las APIs serán expuestas en el portal para desarrolladores. Una API puede contener múltiples versiones, y cada una de las versiones mútiples métodos. Para crear una API debe ir a APIs > Nueva API. Configurar API Al crear una nueva API deberá ...

    • Probar un método

      Resumen El portal para desarrolladores permite probar los métodos de lectura (GET) en el mismo portal. Probar método Ingrese a una API en el Catálogo de APIs de la página de inicio del portal. Luego, seleccione un método y haga clic en el botón ...

    • Orígenes de datos desde servicios web REST/json

      Resumen El conector a servicios web REST/JSON ofrece todas las capacidades necesarias para conectarse a este tipo de orígenes. Esta opción permite recolectar datos desde servicios web REST/JSON o configurar acciones de escritura, para luego crear ...

    • Qué es una vista de datos

      Resumen La plataforma no requiere de un proceso ETL off-line para extraer los datos desde los orígenes, sino que asociadas a la vista se encuentran un conjunto de reglas que el motor de datos interpreta para consultar la fuente a demanda o ...