Saltar a contenido

Crear una herramienta API

Al hacer clic en el botón Añadir en la página principal de "Herramientas" se abrirá un formulario para crear una herramienta API nueva. Para ello es necesario completar algunos campos obligatorios. A continuación te explicamos el proceso paso a paso, incluyendo qué información debes proporcionar para evitar errores durante la creación.

¡Campos obligatorios!

El nombre, la URL y la descripción son campos obligatorios para crear una herramienta de tipo API . Si no se completa alguno de estos cambios, aparecerá un mensaje de error y no podrás continuar.

Para configurar una nueva herramienta API, sigue los pasos que se detallan a continuación:

  1. Acceso al listado de herramientas API: Dirígete a la sección de herramientas API en el menú principal de la plataforma.

  2. Añadir una nueva herramienta API: Haz clic en el botón Añadir para iniciar el proceso de creación.

  3. Rellenar los campos del formulario:

    • Nombre de la herramienta: Introduce un nombre que identifique a la herramienta. Este nombre te permitirá reconocer fácilmente su función dentro del sistema.
    • URL: Es necesario especificar una URL válida a la que la herramienta realizará las solicitudes. Esta URL será el punto de entrada a la API externa con la que se interactuará.
    • Descripción: Añade una breve descripción que explique el propósito de la herramienta. Esto te ayudará a recordar para qué está diseñada la API, como por ejemplo, "Enviar correos", "Obtener datos de inventario", etc.
    • Parámetros: Algunas APIs pueden requerir parámetros adicionales en las solicitudes, tales como IDs, filtros o datos específicos que se pasarán en el cuerpo o la URL. Aunque este campo no es obligatorio, si la API que estás configurando necesita parámetros, deberás definirlos aquí.
    • Cabeceras (Headers): Dependiendo de la API con la que trabajes, puede ser necesario incluir cabeceras específicas, como autorización, tipo de contenido (Content-Type), o configuraciones adicionales como la cabecera "Accept-Language". Estas cabeceras le indican al servidor de la API cómo procesar la solicitud.
    • Variables: Si tu API utiliza variables dinámicas, deberás definirlas en esta sección. Las variables permiten que los datos en la solicitud sean personalizados según el contexto o la interacción. Por ejemplo, si necesitas enviar una ID específica o un dato variable, lo configuras como una variable aquí.
    • Body: El cuerpo de la solicitud es el contenido que se enviará a la API, por ejemplo, datos en formato JSON. Cada API puede requerir un cuerpo de solicitud diferente.

    Importante

    Destacar que los valores que van entre doble llave en el body: { "title": "test product", "price": {{ price }} } hacen referencia a una variable que debe añadirse obligatoriamente en el apartado de variables. Si no se configura correctamente, el modelo no funcionará como se espera.

  4. Guardar la nueva API: Una vez que hayas completado todos los campos obligatorios, haz clic en el botón Finalizar y guardar para crear la herramienta y en Cancelar si deseas salir del proceso de creación.

  5. Confirmación: Si todos los campos están completos y válidos, la herramienta se creará correctamente y aparecerá en el listado correspondiente.