Ejercicio: Usar extensiones de OpenAPI

  • 8 minutos

En este ejercicio, configurará extensiones de OpenAPI en el conector personalizado de facturación de Contoso. Deberá implementar las siguientes extensiones:

  • Conexión de prueba: para validar que la clave de API introducida sea válida.

  • Valores dinámicos: para introducir Id. de tipo de factura, una lista desplegable de valores de la API.

  • Esquema dinámico: para mostrar solo los parámetros que son válidos para el tipo de factura seleccionado.

Importante

Utilice un entorno de prueba con Microsoft Dataverse aprovisionado. Si no dispone de ninguno, puede suscribirse al plan de la comunidad.

Nota

Para completar este ejercicio, descargue el siguiente archivo en su equipo local: Desencadenadores de Contoso Invoicing. Seleccione el botón de descarga en la parte central derecha de la pantalla.

Tarea 1: Importar solución

En esta tarea, importará una solución no administrada que contiene un conector personalizado de facturación de Contoso y luego probará el conector. Usará este conector para completar las tareas de este ejercicio.

  1. Vaya a Power Apps Maker Portal y asegúrese de que se encuentra en el entorno correcto.

  2. Seleccione Soluciones > Importar solución.

  3. Seleccione Examinar.

  4. Seleccione la solución ContosoInvoicingExtensions_1_0_0_0.zip y luego elija Abrir.

  5. Seleccione Siguiente.

  6. Seleccione Importar y espere a que se complete la importación. Una vez que se complete la importación, debería recibir un mensaje para indicar que se ha realizado correctamente.

  7. Seleccione Publicar todas las personalizaciones y espere a que se complete la publicación.

  8. Abra la solución Contoso Invoicing - Extensions que ha importado.

    Debería ver el componente de conector personalizado Facturación de Contoso: extensiones.

  9. Seleccione el conector Facturación de Contoso: extensiones y luego elija Editar.

    Captura de pantalla de una flecha que apunta al botón de la solución Editar.

  10. Inicie una nueva ventana del navegador y luego vaya a Contoso Invoicing.

  11. Seleccione el vínculo de la Clave de API.

  12. Copie la Clave de API. Guarde esta clave en un bloc de notas; lo necesitará para futuras tareas.

  13. Vuelva al conector, seleccione la pestaña Prueba y, a continuación, + Nueva conexión.

    Captura de pantalla del botón de agregar una nueva conexión.

  14. Pegue la clave que ha copiado en el campo Clave de API y luego seleccione Crear conexión.

  15. Seleccione Actualizar conexiones.

  16. Desplácese hacia abajo, hasta la sección Operaciones, seleccione ListInvoiceTypes y luego elija Probar operación.

    Captura de pantalla de una flecha que apunta al botón Probar operación

    Debería obtener una respuesta que contenga los tipos de factura. Más tarde, usará esta operación para implementar la extensión Valores dinámicos para el parámetro Tipo de factura.

    Captura de pantalla del contenido del cuerpo de la respuesta mostrado.

  17. No se vaya de esta página.

Tarea 2: Agregar la extensión de conexión de prueba

En esta tarea, agregará la extensión de conexión de prueba:

  1. Active el conmutador Editor de Swagger.

    Captura de pantalla del botón conmutador del editor de Swagger

  2. Agregue el siguiente fragmento después de produces: [] y seleccione Actualizar conector. Asegúrese de que la sangría del texto coincida con la siguiente imagen.

    x-ms-capabilities:
   testConnection:
     operationId: ListInvoices
     parameters: {}

    Asegúrese de que la sangría tenga el mismo aspecto que en la siguiente imagen.

    Captura de pantalla de una flecha que apunta al botón Actualizar conector

  3. Seleccione de nuevo + Nueva conexión.

    Captura de pantalla de una flecha que apunta al botón para agregar una nueva conexión.

  4. Introduzca su nombre u otro valor aleatorio para la Clave de API y luego seleccione Crear conexión.

    La creación de la conexión debería presentar errores.

    Captura de pantalla del mensaje de error de conexión.

  5. Introduzca la clave de API que copió en la tarea 1 en el campo Clave de API y luego seleccione Crear conexión.

    Ahora, la creación de la conexión debería ser correcta.

  6. No se vaya de esta página.

Tarea 3: Configurar valores dinámicos para el id. de tipo de factura

En esta tarea, configurará valores dinámicos para el id. de tipo de factura:

  1. Seleccione la pestaña Definición.

  2. Seleccione AddInvoice en la sección Acciones.

  3. Desplácese hacia abajo, seleccione el botón de puntos suspensivos (contenido adicional) del parámetro typeId y luego elija Editar.

    Captura de pantalla de una flecha que apunta al botón para editar el parámetro de consulta

  4. Introduzca Tipo de factura en Resumen, introduzca 1 como Valor predeterminado y luego seleccione Sí para Se requiere.

    Captura de pantalla de las propiedades del parámetro de consulta.

  5. Desplácese hacia abajo y seleccione Dinámico como Tipo de lista desplegable.

  6. Seleccione ListInvoiceTypes para Id. de operación, elija typeId para Valor y, finalmente, name para Nombre para mostrar del valor.

    Captura de pantalla de las propiedades del parámetro de consulta.

  7. Seleccione Actualizar conector.

  8. Active el conmutador Editor de Swagger.

  9. Si obtiene errores de clave hash, cierre la pestaña del navegador del conector y luego vuelva a abrirla en modo de edición.

  10. Busque AddInvoice y vea si se agregó x-ms-dynamic-values.

    Captura de pantalla de los valores dinámicos agregados.

  11. No se vaya de esta página.

Tarea 4: Configurar la extensión de esquema dinámico

En esta tarea, configurará la extensión de esquema dinámico:

  1. Seleccione la pestaña Prueba.

  2. Seleccione la operación GetInvoiceSchema y luego seleccione Probar operación.

    Captura de pantalla de una flecha que apunta al botón de prueba de operación de esquema de obtención de factura.

  3. Revise la respuesta. Esta respuesta es lo que una API debe devolver para permitir que se configure el Esquema dinámico.

    Captura de pantalla de la respuesta del esquema de obtención de factura.

  4. Active el conmutador Editor de Swagger.

  5. Localice la línea CreateInvoiceRequest y reemplace la línea factura con el siguiente texto Swagger.

    Factura:

    x-ms-dynamic-properties:

    operationId: GetInvoiceSchema

    parameters:

    typeId: {parameterReference: typeId}

    Antes:

    Captura de pantalla del texto Swagger antes de editarlo.

    Después:

    Asegúrese de que las sangrías coincidan con la siguiente imagen.

    Captura de pantalla del texto Swagger después de editarlo.

  6. Desactive el conmutador Editor de Swagger.

  7. Seleccione la pestaña Definición.

  8. Seleccione la acción GetInvoiceSchema y luego elija interna como Visibilidad.

    Captura de pantalla de la visibilidad de la acción del esquema de obtención de factura.

  9. Seleccione Actualizar conector.

Tarea 5: Probar el conector

En esta tarea, probará el conector:

  1. Vaya a Power Automate y asegúrese de que está en el entorno correcto.

  2. Seleccione Soluciones y abra la solución Contoso Invoicing - Extensions.

  3. Seleccione + Nuevo y luego seleccione Automatización > Flujo de nube > Instantáneo.

    Captura de pantalla de una flecha que apunta al botón para crear un nuevo flujo de nube

  4. Introduzca Metadatos dinámicos y el nombre del flujo; seleccione Desencadenar un flujo manualmente para el desencadenador y seleccione Crear.

  5. Seleccione+ Nuevo paso.

  6. Seleccione la pestaña Personalizado y luego elija Contoso Invoicing - Extensions.

  7. Seleccione AddInvoice como acción.

  8. Introduzca Mi conexión como nombre, introduzca su nombre para la Clave de API y luego seleccione Crear. La prueba de la conexión debería presentar errores.

Captura de pantalla de una flecha que apunta al conector personalizado

  1. Introduzca la clave de API que copió en la tarea 1 en el campo Clave de API y luego seleccione de nuevo Crear conexión.

    La conexión debería crearse correctamente.

  2. En el menú desplegable Tipo de factura, seleccione Pedido de compra.

    Captura de pantalla de una flecha que apunta al tipo de factura Pedido de compra.

    El campo Pedido debería ser visible ahora.

    Captura de pantalla de la acción del conector personalizado con el campo Pedido de compra visible.

  3. Cambie el Tipo de factura a Pedido no de compra.

    El campo Pedido de compra ya no debería ser visible.

    Captura de pantalla de la acción del conector personalizado con el campo Pedido de compra oculto

  4. Guarde el flujo.