Editar herramienta API

La edición de una herramienta API te permite modificar su configuración, lo cual puede ser necesario si necesitas ajustar algún detalle o cambiar parámetros específicos previamente establecidos. El proceso de edición es similar al de la creación.

Para editar una herramienta API, sigue estos pasos:

  1. En la lista de herramientas API haz clic sobre el nombre de la herramienta o sobre la fila correspondiente.

  2. Serás redirigido a la página de configuración de la herramienta, donde podrás modificar los campos del formulario. Este formulario es el mismo que se utiliza al momento de crear una nueva herramienta.

    • Campos obligatorios:

      • Nombre: Puedes cambiar el nombre de la herramienta clicando sobre el submenú ..., en la opción Cambiar nombre.
      • URL: El endpoint de la API con la que se interactuará. Asegúrate de que la URL sea válida y esté correctamente escrita.
      • Descripción: Breve descripción del propósito o características de la herramienta. Esto te ayudará a recordar su función.
      • Método de la solicitud (POST, GET, etc.): Asegúrate de que el método HTTP seleccionado sea el adecuado para la API con la que interactúa la herramienta.

    • Campos opcionales:

      • Parámetros: Algunas APIs pueden requerir parámetros adicionales para su configuración. Si la herramienta que editas necesita parámetros, deberás definirlos en esta sección.
      • Cabeceras (Headers): Según la API, puede requerirse una cabecera específica, como la cabecera de autorización o de tipo de contenido. Estas cabeceras pueden incluir información que la API necesita para procesar correctamente la solicitud.
      • Variables: Si tu herramienta API utiliza variables para personalizar dinámicamente la solicitud, deberás definirlas aquí. Las variables permiten adaptar las solicitudes según el contexto o los datos disponibles.
      • Body: Modifica el cuerpo de la solicitud según sea necesario. Asegúrate de incluir los datos correctos en el formato adecuado (por ejemplo, JSON). Si utilizas variables en el cuerpo de la solicitud, como {{ variable }}, estas deben estar definidas en la sección de variables.

      Importante

      Si utilizas variables en el cuerpo de la solicitud, asegúrate de que estén correctamente definidas en el apartado de variables. Si no se configuran adecuadamente, la herramienta API no funcionará como se espera.

  3. Guardar o descartar cambios: Haz clic en el botón Actualizar Herramienta API para aplicar los cambios. Si no, selecciona Cancelar para cancelar todos los cambios y mantener la configuración anterior de la herramienta.