Crear tu conector a partir de una definición de API

Crear un nuevo conector

Si seleccionas Iniciar desde una definición de API, debes proporcionar la definición de API:
- Desde un archivo local: carga una colección Postman o Swagger.
- Desde una URL: introduce una URL de archivo, como https://petstore.swagger.io/v2/swagger.json.
Haz clic en Continuar.

Configura tu conector

En la ventana Confirmar importación, puedes:
- Cambia el nombre del proveedor, el nombre de la aplicación y el nombre del conector.
- Modifica los recursos que quieres utilizar en tu conector personalizado. Se seleccionan automáticamente todos los recursos disponibles; deselecciona los que quieres excluir.
  - Utiliza la barra de búsqueda para buscar un recurso específico.
- Haz clic en Crear.
Aparecerá la ventana Configuración.
En la pestaña Información puedes configurar los siguientes campos:
- Prefijo del conector - por ejemplo, documentation. Esto se refleja en su clave de conector.
- Nombre del proveedor: introduce un nombre de proveedor.
- Nombre de la aplicación: introduce un nombre de la aplicación.
- Tipo de API: este campo está deshabilitado por defecto, ya que actualmente solo se admite REST.
- Nombre para mostrar : este es el nombre del conector, tal como aparece en el catálogo de conectores.
- Descripción: introduce una descripción para tu conector.
- Icono : haz clic en Explorar para cargar una imagen desde tu ordenador.
La vista previa del catálogo muestra cómo aparecerá tu conector personalizado en el catálogo de conectores de Integration Service.
Haz clic en Guardar.

Configurar la API base

En la pestaña API base , se configura la URL base para la API y la paginación de la aplicación:

URL base : se rellena automáticamente con el valor declarado en la creación del conector.
Tipo de paginación: las opciones disponibles en el menú desplegable son: Inicio de página con 1, Inicio de página con 0, Desplazamiento, Personalizado. Si la documentación del proveedor no proporciona ningún detalle sobre la paginación, mantenga el valor predeterminado.
Paginación máxima : el valor predeterminado es 100. Si la documentación del proveedor no proporciona ningún detalle sobre la paginación, mantenga el valor predeterminado.
Encabezado de tipo de contenido : este campo está deshabilitado de forma predeterminada, ya que actualmente solo se admite application/json .
Aceptar encabezado : este campo está deshabilitado de forma predeterminada, ya que actualmente solo se admite application/json .

Establecer el método de autenticación

En la pestaña Autenticación , configuras el tipo de autenticación para tu conector. Consulta más información sobre las opciones compatibles en Tipos de autenticación.

Pruebe su conexión

Una vez que hayas completado la configuración de autenticación, selecciona Añadir conexión en el menú desplegable:

Si tu conexión es correcta, el estado se actualiza a Conectado.

Recursos

El Creador de conectores genera la lista de recursos en función de la definición de la API proporcionada. El menú de la izquierda muestra la lista de recursos disponibles, organizados en grupos.

Haz clic en Más opciones menú de botones para configurar aún más cada método. Puedes:
- Añadir método : abre la ventana Crear nuevo recurso .
- Permitir eliminación de método : activa un icono Eliminar para cada recurso del grupo.
- Editar ruta : edita la ruta del recurso. Por ejemplo: [BASE URL]/pet = https://petstore.swagger.io/v2/pet
- Eliminar : elimina un grupo de recursos. Un mensaje le advierte que la operación no se puede deshacer.
- Duplicar : abre la ventana de recurso Duplicar , donde puedes editar la ruta, elegir un nombre para mostrar y seleccionar métodos.
También puedes Crear un nuevo grupo de recursos de dos maneras:
- en blanco
- de cURL
Si eliges configurar un nuevo recurso desde el espacio en blanco, configura los siguientes campos:
- Ruta : [Base URL]/[path]
- Nombre para mostrar
- Seleccionar métodos: Obtener, Obtener por ID, Publicar, Poner, Parchear, Eliminar
Si elige configurar un nuevo recurso desde cURL, introduzca un comando cURL.

Configura tus recursos

Cuando seleccionas un recurso, se muestra la siguiente ventana:

Dependiendo del método de recurso que selecciones, estarán disponibles las siguientes pestañas de configuración: Parámetros, Campos de respuesta/solicitud, Paginación, Búsqueda.

Parámetros

Por ejemplo, las cuatro pestañas están disponibles para los métodos GET. Para los métodos POST, solo se pueden ver las pestañas Parámetros, Campos de solicitud y Campos de respuesta.

En Parámetros, puedes ver la lista de parámetros disponibles para el recurso seleccionado, añadir nuevos parámetros o importar parámetros desde un recurso existente.

Los parámetros enumerados en esta tabla son los que usará en Studio al crear automatizaciones con su conector personalizado.

El objeto mascota corresponde al grupo de recursos mascota, y los campos disponibles son los establecidos para el recurso GETBYID:

Campos de respuesta y solicitud

Los campos Respuesta y Solicitud para cada recurso se generan automáticamente al enviar una solicitud.

En cada pestaña respectiva, puede editar o eliminar cualquier campo. Si haces clic en el icono Editar , se muestra la siguiente ventana de configuración:

En la pestaña Campos de respuesta/solicitud , también están disponibles las siguientes opciones:

Casilla de verificación Sobrescribir al enviar solicitud : si se selecciona, al ejecutar una solicitud de envío, se vuelve a generar la lista de campos. No seleccione esta opción si ha agregado nuevos campos a su recurso.

Botón de opciones adicionales :

Opción	Lo que hace
Actualizar la clave raíz de respuesta	Defina la clave de respuesta cuando trabaje con matrices anidadas en la respuesta.
Eliminar todos los campos para el método	Elimina todos los campos del método seleccionado.
Generar a partir de carga útil	Utilice una carga útil de muestra de la documentación de servicio o una llamada a la API para generar los campos de recursos.

Botón Añadir fila : añade nuevos campos al recurso.

Haga clic en el icono de Columnas visibles para agregar o eliminar columnas en la tabla de campos.

Cada color de la columna Métodos corresponde a un método concreto: Obtener, Obtener por ID, Publicar, Colocar, Parchear, Eliminar.

Paginación

Habilita la paginación para un recurso si esperas una respuesta de lista. Si habilitas la paginación, también necesitarás definir la clave raíz de respuesta en la pestaña de configuración, para las listas anidadas.