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.
Haga clic en el ícono Agregar para agregar un parámetro. El conteo de parámetros mostrado en el título de la tabla Parámetros se actualiza de forma automática.
Editar
Para editar los parámetros existentes que están disponibles en la solicitud.
En la tabla de parámetros, pase el cursor sobre el icono de puntos suspensivos verticales del parámetro correspondiente y haga clic en el icono Editar para modificar el Tipo de parámetro, Clave, Valor o Tipo de valor.
Habilitar/inhabilitar
Para habilitar o deshabilitar los parámetros que están disponibles en la solicitud. Puede desactivar un parámetro en los siguientes escenarios:
  • Cuando la solicitud de API utiliza valores predeterminados.
  • Al introducir una nueva capacidad en un despliegue controlado de paquetes de conectores.
  • Al probar e iterar nuevas capacidades en un paquete de conectores.
  • Al solucionar problemas de un paquete de conectores que contiene parámetros con errores.
En la tabla Parámetros, pase el cursor sobre el ícono de puntos suspensivos verticales del parámetro que desea habilitar o deshabilitar y luego haga clic en el botón de cambio Habilitar/Deshabilitar. El estado del parámetro se actualiza en consecuencia en la tabla Parámetros. Los parámetros deshabilitados no se incluyen en el paquete de conectores publicado.
Copiar
Para replicar los parámetros existentes que están disponibles en la solicitud.
En la tabla Parámetros, pase el cursor sobre el icono de puntos suspensivos verticales del parámetro correspondiente y haga clic en el icono Copiar para duplicar el parámetro seleccionado. Asegúrese de ingresar una nueva clave en el modal de Copiar. Todos los demás atributos del parámetro original se copian al nuevo parámetro. Una vez copiado, el nuevo parámetro se habilita de forma predeterminada. Si es necesario, use el interruptor Habilitar/deshabilitar para deshabilitar el parámetro manualmente. El conteo de parámetros en el título de la tabla Parámetros se actualiza automáticamente cuando se crea un nuevo parámetro utilizando la opción Copiar.
Puede cambiar el Tipo de parámetro, Valor o Tipo de valor del parámetro duplicado en el modal de Copia.
Eliminar
Para eliminar los parámetros que están disponibles en la solicitud.
Realice una de las siguientes acciones para eliminar parámetros:
  • Haga clic en la casilla de verificación Seleccionar todo en el encabezado de la tabla y luego haga clic en el icono Eliminar, que está disponible encima de la tabla para eliminar múltiples parámetros.
  • Pase el cursor sobre el menú de puntos suspensivos verticales de cada parámetro y luego haga clic en el icono Eliminar para eliminar el parámetro individualmente.

Tabla de parámetros

La tabla de Parámetros muestra el número total de parámetros de solicitud en una acción. Este número incluye tanto los parámetros habilitados como los deshabilitados.

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 Bot editor o API Task.
Clave Muestra la clave del parámetro. El usuario del paquete no puede ver la clave en el editor de Bot editor o API Task. 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 Bot editor o API Task.
Valor proporcionado por el usuario Muestra el estado del valor.
  • Sí: Si el valor lo proporciona el usuario. El usuario del paquete debe proporcionar un valor apropiado al configurar este parámetro en Bot editor o en el editor de API Task.
  • No: Si el valor está preprogramado. El usuario del paquete no puede ver este valor en el editor de Bot editor o API Task. Este valor se envía como parte del encabezado.
Estado Muestra el estado del parámetro.
  • Habilitado: Si el parámetro está habilitado.
  • Deshabilitado: Si el parámetro está deshabilitado.
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 Bot editor o API Task.
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 Bot editor o API Task.

Agregar parámetros de solicitud

Siga estos pasos para agregar un parámetro de solicitud:

  1. Haga clic en la pestaña Parámetros de solicitud dentro del panel Configuración.
  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. Realice lo siguiente en la ventana modal Agregar parámetro.
    1. 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=company.
      • Ruta: Estos parámetros se agregan directamente a la ruta de URL. Por ejemplo, /accounts/{user_account}.
    2. Tecla: Introduzca un nombre de clave adecuado. El nombre de la clave no se muestra al usuario del paquete en el editor de Bot editor o API Task. Este nombre se envía como parte del encabezado.

      Puede incluir caracteres especiales como . y @ en la clave del parámetro de solicitud.

    3. 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 Bot editor o API Task. Este valor se envía como parte del encabezado.
      Proporcionado por el usuario
      1. 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.
      2. ¿Este campo es obligatorio? Seleccione No o Sí según los requisitos del parámetro.
      3. Valor (opcional): Introduzca un valor. El usuario del paquete puede ver y actualizar este valor en el editor de Bot editor o API Task.
      4. Etiqueta: Ingrese una etiqueta para el parámetro. El usuario del paquete puede ver la etiqueta del parámetro en el editor de Bot editor o API Task.
      5. 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 Bot editor o API Task. La descripción aparece como texto de ayuda en el editor.
  4. 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.