Parámetros de solicitud

Utilice la sección Parámetros de solicitud para agregar diversos parámetros, como ruta y consulta, a sus solicitudes. Asegúrese de que estos parámetros 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
Haga clic para agregar un parámetro.
Editar
Pase el mouse sobre el ícono de tres puntos del parámetro que desea editar y haga clic en el ícono Editar.
Eliminar
Elimine los parámetros seleccionados.

Tabla de parámetros

Vea los siguientes detalles de parámetros en la tabla.

Elemento de tabla Descripción
Tipo Muestra si el parámetro es un parámetro de consulta o un parámetro de tipo. El tipo de parámetro no se muestra al usuario del paquete en el editor de Editor de bots o Tarea API.
Valor proporcionado por el usuario Muestra si el valor lo proporciona el usuario.
  • Muestra Sí si el valor lo proporciona el usuario. El usuario del paquete deberá proporcionar un valor apropiado al configurar este parámetro en el editor de Editor de bots o Tarea API.
  • Muestra No si el valor está preprogramado. El usuario del paquete no podrá ver este valor en el editor de Editor de bots o Tarea API. Este valor se envía como parte del encabezado.
Clave Muestra el nombre de la clave. 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.
Valor Muestra el valor del parámetro. El usuario del paquete podrá ver y actualizar este valor en el editor de Editor de bots o Tarea API.
Etiqueta Muestra la etiqueta del parámetro. El usuario del paquete podrá ver esta etiqueta para el 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 podrá ver esta descripción del parámetro en el editor de Editor de bots o Tarea API.

Agregar parámetros de solicitud

  1. Haga clic en la pestaña Parámetros de solicitud.
  2. Haga clic en Agregar parámetro o en el ícono más (+) en la parte superior de la tabla para agregar un parámetro.
  3. En la ventana Agregar parámetro, seleccione uno de los siguientes tipos de parámetros:
    • 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}.
  4. En el campo Clave, ingrese 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.
  5. Seleccione una de las siguientes opciones:
    Preprogramado Introduzca un valor preprogramado para el parámetro. El usuario del paquete no podrá 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
    1. Seleccione si este campo es obligatorio.
    2. Introduzca un valor. El usuario del paquete podrá ver y actualizar este valor en el editor de Editor de bots o Tarea API.
    3. Introduzca una etiqueta. El usuario del paquete podrá ver esta etiqueta para el parámetro en el editor de Editor de bots o Tarea API.
    4. Ingrese una descripción. El usuario del paquete podrá ver esta descripción del parámetro en el editor de Editor de bots o Tarea API.