Exercice - Utiliser les extensions OpenAPI

Effectué

Dans cet exercice, vous allez configurer les extensions OpenAPI sur le connecteur personnalisé Contoso Invoicing. Vous allez implémenter les extensions suivantes :

  • Test de la connexion : pour valider que la clé API saisie est valide.

  • Valeurs dynamiques : pour faire de l’entrée pour ID type de facture une liste déroulante de valeurs de l’API.

  • Schéma dynamique : pour afficher uniquement les paramètres valides pour le type de facture sélectionné.

Important

Utilisez un environnement de test avec Microsoft Dataverse approvisionné. Si vous ne disposez pas d’un environnement de test, vous pouvez vous inscrire pour bénéficier de l’offre Communauté.

Remarque

Téléchargez le fichier suivant sur votre ordinateur local pour effectuer cet exercice Déclencheurs Contoso Invoicing. Cliquez sur le bouton Télécharger au milieu à droite de l’écran.

Tâche 1 : Importer une solution

Dans cette tâche, vous allez importer une solution non gérée qui contient un connecteur personnalisé Contoso Invoicing, puis tester le connecteur. Vous allez utiliser ce connecteur pour effectuer les tâches de cet exercice.

  1. Accédez à Power Apps Maker Portal et veillez à vous trouver dans l’environnement approprié.

  2. Cliquez sur Solutions > Importer.

  3. Cliquez sur Parcourir.

  4. Sélectionnez la solution ContosoInvoicingExtensions_1_0_0_0.zip, puis cliquez sur Ouvrir.

  5. Cliquez sur Suivant.

  6. Cliquez sur Importer, puis attendez la fin du processus d’importation. Une fois l’importation terminée, un message devrait vous indiquer que vous avez réussi.

  7. Cliquez sur Publier toutes les personnalisations et attendez la fin de la publication.

  8. Cliquez sur la solution Contoso Invoicing - Extensions que vous avez importée pour l’ouvrir.

    Vous devriez voir le composant de connecteur personnalisé Contoso Invoicing - Extensions.

  9. Sélectionnez le connecteur Contoso Invoicing - Extensions, puis cliquez sur Modifier.

    Screenshot of an arrow pointing to the Edit solution button.

  10. Ouvrez une nouvelle fenêtre de navigateur, puis accédez à Contoso Invoicing.

  11. Cliquez sur le lien Clé API.

  12. Copiez la clé API. Enregistrez cette clé dans un bloc-notes ; vous en aurez besoin pour de futures tâches.

  13. Revenez au connecteur, sélectionnez l’onglet Test, puis cliquez sur + Nouvelle connexion.

    Screenshot of the add new connection button.

  14. Collez la clé que vous avez copiée dans le champ Clé API, puis cliquez sur Créer une connexion.

  15. Cliquez sur Actualiser les connexions.

  16. Faites défiler vers le bas jusqu’à la section Opérations, sélectionnez ListInvoiceTypes, puis cliquez sur Tester l’opération.

    Screenshot of an arrow pointing to the Test operation button.

    Vous devriez obtenir une réponse contenant les types de factures. Plus tard, vous utiliserez cette opération pour implémenter l’extension Valeurs dynamiques pour le paramètre Type de facture.

    Screenshot of the response body content displayed.

  17. Ne quittez pas cette page.

Tâche 2 : Ajouter l’extension de test de la connexion

Dans cette tâche, vous allez ajouter l’extension de test de la connexion :

  1. Activez le bouton bascule Éditeur Swagger.

    Screenshot of the turn on swagger editor toggle button.

  2. Ajoutez le fragment suivant après la ligne 7 produces: [], puis cliquez sur Mettre à jour le connecteur. Assurez-vous que l’indentation du texte correspond à l’image suivante.

    x-ms-capabilities:

    testConnection:

    operationId: ListInvoices

    parameters: {}

    Screenshot of an arrow pointing to the Update connector button.

  3. Cliquez de nouveau sur + Nouvelle connexion.

    Screenshot of an arrow pointing to the add new connection button.

  4. Entrez votre nom ou une autre valeur aléatoire pour Clé API, puis cliquez sur Créer une connexion.

    La création de la connexion doit échouer.

    Screenshot of the connection failure message.

  5. Entrez la clé API que vous avez copiée à la Tâche 1 dans le champ Clé API, puis cliquez sur Créer une connexion.

    La création de la connexion doit à présent réussir.

  6. Ne quittez pas cette page.

Tâche 3 : Configurer des valeurs dynamiques pour l’ID type de facture

Dans cette tâche, vous allez configurer des valeurs dynamiques pour l’ID type de facture :

  1. Cliquez sur l’onglet Définition.

  2. Sélectionnez AddInvoice dans la section Actions.

  3. Faites défiler vers le bas, cliquez sur les points de suspension (...) du paramètre typeId, puis cliquez sur Modifier.

    Screenshot of an arrow pointing to the edit query parameter button.

  4. Entrez Type de facture pour Résumé et 1 pour Valeur par défaut, puis sélectionnez Oui pour Est requis.

    Screenshot of the query parameter properties.

  5. Faites défiler vers le bas et sélectionnez Dynamique pour Type de liste déroulante.

  6. Sélectionnez ListInvoiceTypes pour ID opération, typeId pour Valeur et Nom pour Nom d’affichage de la valeur.

    Screenshot of the properties of the query parameter.

  7. Cliquez sur Mettre à jour le connecteur.

  8. Activez le bouton bascule Éditeur Swagger.

  9. Si vous obtenez des erreurs de clé de hachage, fermez l’onglet du navigateur du connecteur, puis rouvrez-le en mode d’édition.

  10. Localisez AddInvoice et vérifiez si x-ms-dynamic-values a été ajouté.

    Screenshot of the added dynamic values.

  11. Ne quittez pas cette page.

Tâche 4 : Configurer l’extension de schéma dynamique

Dans cette tâche, vous allez configurer l’extension de schéma dynamique :

  1. Cliquez sur l’onglet Test.

  2. Sélectionnez l’opération GetInvoiceSchema, puis cliquez sur Tester l’opération.

    Screenshot of an arrow pointing to the test get invoice schema operation button.

  3. Vérifiez la réponse. Cette réponse correspond à ce qu’une API doit renvoyer pour permettre au schéma dynamique d’être configuré.

    Screenshot of the get invoice schema response.

  4. Activez le bouton bascule Éditeur Swagger.

  5. Localisez la ligne CreateInvoiceRequest et remplacez la ligne invoice par le texte Swagger suivant.

    Invoice:

    x-ms-dynamic-properties:

    operationId: GetInvoiceSchema

    parameters:

    typeId: {parameterReference: typeId}

    Avant :

    Screenshot of the Swagger text before editing.

    Après :

    Assurez-vous que les indentations correspondent à l’image suivante.

    Screenshot of the Swagger text after editing.

  6. Désactivez le bouton bascule Éditeur Swagger.

  7. Cliquez sur l’onglet Définition.

  8. Sélectionnez l’action GetInvoiceSchema, puis sélectionnez interne pour Visibilité.

    Screenshot of the get invoice schema action visibility.

  9. Cliquez sur Mettre à jour le connecteur.

Tâche 5 : Tester le connecteur

Dans cette tâche, vous allez tester le connecteur :

  1. Accédez à Power Automate et vérifiez que vous vous trouvez dans l’environnement approprié.

  2. Cliquez sur Solutions, puis ouvrez la solution Contoso Invoicing - Extensions.

  3. Cliquez sur + Nouveau, puis sélectionnez Flux de cloud.

    Screenshot of an arrow pointing to the create new cloud flow button.

  4. Sélectionnez le déclencheur Déclencher manuellement un flux.

  5. Cliquez sur + Nouvelle étape.

  6. Cliquez sur l’onglet Personnaliser, puis sélectionnez Contoso Invoicing - Extensions.

    Screenshot of an arrow pointing to the custom connector.

  7. Sélectionnez l’action AddInvoice.

  8. Entrez Ma connexion comme nom, saisissez votre nom pour Clé API, puis cliquez sur Créer.

    Le test de connexion doit échouer.

    Screenshot of the failed connection test.

  9. Entrez la clé API que vous avez copiée à la Tâche 1 dans le champ Clé API, puis cliquez de nouveau sur Créer.

    La création de la connexion doit réussir.

  10. Dans le menu déroulant Type de facture, sélectionnez Commande achat.

    Screenshot of an arrow pointing to the Purchase Order invoice type.

    Le champ Commande achat doit à présent être visible.

    Screenshot of the custom connector action with Purchase Order field visible.

  11. Modifiez le Type de facture sur Non-Commande achat.

    Le champ Commande achat ne doit plus être visible.

    Screenshot of the custom connector action with Purchase Order field hidden.

  12. Nommez le flux Métadonnées dynamiques, puis enregistrez-le.