Parámetros de solicitud
- Última actualización2025/03/28
Utilice la pestaña Parámetros de solicitud para agregar diversos parámetros, como ruta y consulta, a sus solicitudes. Asegúrese de que los parámetros añadidos coincidan con los parámetros utilizados en la URL del punto de conexión.
Acciones
Las siguientes acciones de parámetros de solicitud están habilitadas:
- Agregar
- Para agregar parámetros a la solicitud.
- Editar
- Para editar los parámetros existentes que están disponibles en la solicitud.
- Eliminar
- Para eliminar los parámetros que están disponibles en la solicitud.
Tabla de parámetros
Vea los siguientes detalles de parámetros en la tabla.
Columna | Descripción |
---|---|
Tipo | Muestra el tipo de parámetro. El parámetro puede ser un parámetro de Consulta o un parámetro de Ruta. El usuario del paquete no puede ver el tipo de parámetro en el editor de Editor de bots o Tarea API. |
Clave | Muestra la clave del parámetro. El usuario del paquete no puede ver la clave en el editor de Editor de bots o Tarea API. La clave se envía como parte del encabezado. |
Valor | Muestra el valor del parámetro. El usuario del paquete puede ver y actualizar este valor en el editor de Editor de bots o Tarea API. |
Valor proporcionado por el usuario | Muestra el estado del valor.
|
Etiqueta | Muestra la etiqueta del parámetro para los valores Proporcionados por el usuario. El usuario del paquete puede ver la etiqueta del parámetro en el editor de Editor de bots o Tarea API. |
Descripción | Muestra la descripción del parámetro. El usuario del paquete puede ver la descripción del parámetro en el editor de Editor de bots o Tarea API. |
Agregar parámetros de solicitud
Siga estos pasos para agregar un parámetro de solicitud:
- Haga clic en la pestaña Parámetros de solicitud dentro del panel Configuración.
- Haga clic en Agregar parámetro o en el ícono más (+) en la parte superior de la tabla para agregar un parámetro.
- Realice lo siguiente en la ventana modal Agregar parámetro.
-
Tipo de parámetro: Seleccione una de las siguientes opciones:
- Consulta: Estos parámetros se agregan a la ruta de URL después de un carácter ?. Por ejemplo, /accounts?user_account=empresa.
- Ruta: Estos parámetros se agregan directamente a la ruta de URL. Por ejemplo, /accounts/{user_account}.
- Tecla: Introduzca un nombre de clave adecuado. El nombre de la clave no se muestra al usuario del paquete en el editor de Editor de bots o Tarea API. Este nombre se envía como parte del encabezado.
- Seleccione una de las siguientes opciones en la sección El valor será:
Tipo Descripción Preprogramado Introduzca un valor preprogramado para el parámetro. El usuario del paquete no puede ver este valor en el editor de Editor de bots o Tarea API. Este valor se envía como parte del encabezado. Proporcionado por el usuario - Tipo de entrada de valor: Habilite esta casilla de verificación si desea proteger el tipo de entrada de valor. Cuando habilite la casilla de verificación, podrá ingresar el parámetro a través de una credencial, una variable o una string insegura.
- ¿Este campo es obligatorio? Seleccione No o Sí según los requisitos del parámetro.
- Valor (opcional): Introduzca un valor. El usuario del paquete puede ver y actualizar este valor en el editor de Editor de bots o Tarea API.
- Etiqueta: Ingrese una etiqueta para el parámetro. El usuario del paquete puede ver la etiqueta del parámetro en el editor de Editor de bots o Tarea API.
- Descripción (opcional): Escriba una descripción para el parámetro. El usuario del paquete puede ver la descripción del parámetro en el editor de Editor de bots o Tarea API. La descripción aparece como texto de ayuda en el editor.
-
Tipo de parámetro: Seleccione una de las siguientes opciones:
- Haga clic en Añadir para agregar el parámetro a la solicitud.
El nuevo parámetro se muestra en la tabla de Parámetros, y el conteo de parámetros en el título de la tabla se actualiza de forma automática.
Repita los pasos para agregar más parámetros.