Conéctese a los servicios con OpenAPI

1. Ve al servicio al que quieres conectar a App Studio y busca un archivo JSON de especificación de OpenAPI.

   nota

   App Studio admite archivos de especificación de OpenAPI que cumplan con la versión 3.0.0 o superior de la especificación de OpenAPI.

2. Recopile los datos necesarios para configurar el conector de OpenAPI, incluidos los siguientes:

   • La URL base para conectarse al servicio.

   • Credenciales de autenticación, como un token o username/password.

   • Si corresponde, cualquier encabezado.

   • Si procede, cualquier parámetro de consulta.

Para crear un conector para OpenAPI

1. Navega hasta App Studio.

2. En el panel de navegación de la izquierda, selecciona Conectores en la sección Administrar. Accederá a una página que muestra una lista de los conectores existentes con algunos detalles sobre cada uno de ellos.

3. Seleccione + Crear conector.

4. Seleccione OpenAPI Connector en la lista de tipos de conectores. Ahora, configure su conector rellenando los siguientes campos.

5. Nombre: Introduzca un nombre para su conector OpenAPI.

6. Descripción: Introduzca una descripción para su conector de OpenAPI.

7. URL base: introduzca la URL base para conectarse al servicio.

8. Método de autenticación: elija el método para autenticarse con el servicio de destino.

   • Ninguno: acceda al servicio de destino sin autenticación.

   • Básico: acceda al servicio de destino con un nombre de usuario y una contraseña obtenidos del servicio al que se está conectando.

   • Token portador: acceda al servicio de destino utilizando el valor de token de un token de autenticación obtenido de la cuenta de usuario o de la configuración de la API del servicio.

   • OAuth 2.0: accede al servicio de destino mediante el protocolo OAuth 2.0, que otorga a App Studio acceso al servicio y a los recursos sin compartir ninguna credencial o identidad. Para usar el método de autenticación OAuth 2.0, primero debes crear una aplicación a partir del servicio al que te estás conectando que represente a App Studio para obtener la información necesaria. Con esa información, rellena los siguientes campos:

     1. Flujo de credenciales de cliente:

        1. En ID de cliente, introduzca el ID del servicio de destino.

        2. En Secreto del cliente, introduce el secreto del servicio de destino.

        3. En URL del token de acceso, introduce la URL del token del servicio de destino.

        4. Si lo desea, en Ámbitos, introduzca los ámbitos de la aplicación. Los ámbitos son los permisos o niveles de acceso que requiere la aplicación. Consulta la documentación de la API del servicio de destino para conocer sus alcances y configurar solo aquellos que tu aplicación de App Studio necesite.

        Agrega las variables que quieras enviar con el servicio en cada llamada y elige Verificar la conexión para probar la autenticación y la conexión.

     2. Flujo de código de autorización:

        1. En ID de cliente, introduzca el ID del servicio de destino.

        2. En Secreto del cliente, introduce el secreto del servicio de destino.

        3. En URL de autorización, introduzca la URL de autorización del servicio de destino.

        4. En URL del token de acceso, introduce la URL del token del servicio de destino.

        5. Si lo desea, en Ámbitos, introduzca los ámbitos de la aplicación. Los ámbitos son los permisos o niveles de acceso que requiere la aplicación. Consulta la documentación de la API del servicio de destino para conocer sus alcances y configurar solo aquellos que tu aplicación de App Studio necesite.

9. Variables: agrega variables para enviarlas al servicio con cada llamada. Las variables agregadas durante la configuración se almacenan de forma segura y solo se accede a ellas durante el tiempo de ejecución de las aplicaciones que utilizan la conexión.

10. Encabezados: añada encabezados HTTP que se utilizan para proporcionar metadatos sobre la solicitud o la respuesta. Puedes agregar tanto claves como valores, o solo proporcionar una clave a la que el generador pueda proporcionar un valor en la aplicación.

11. Parámetros de consulta: añada parámetros de consulta que se utilizan para pasar opciones, filtros o datos como parte de la URL de la solicitud. Al igual que los encabezados, puedes proporcionar tanto una clave como un valor, o solo una clave a la que el creador pueda proporcionar un valor en la aplicación.

12. Archivo de especificaciones de OpenAPI: cargue un archivo JSON de especificación de OpenAPI arrastrándolo y soltándolo o seleccionando Seleccionar un archivo para navegar por su sistema de archivos local y elegir el archivo que desea cargar.

    Una vez agregado, el archivo se procesa y se muestra una lista de las opciones disponibles. Seleccione las operaciones necesarias para su conector.

13. Seleccione Crear. El conector recién creado aparecerá en la lista de conectores.