Exercice : utiliser les extensions OpenAPI

  • 8 minutes

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 Contoso Invoicing Triggers. Cliquez sur le bouton Télécharger au milieu de l’écran à droite.

Tâche 1 : Importer une solution

Dans cette tâche, vous allez importer une solution non gérée qui comporte 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 la solution.

  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. Ouvrez la solution Contoso Invoicing - Extensions que vous avez importée.

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

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

    Capture d’écran avec une flèche pointant vers le bouton de modification de la solution.

  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.

    Capture d’écran du bouton d’ajout d’une connexion.

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

  15. Sélectionnez Actualiser les connexions.

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

    Capture d’écran avec une flèche pointant vers le bouton Opération de test.

    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.

    Capture d’écran du contenu du corps de réponse affiché.

  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.

    Capture d’écran du bouton bascule d’activation de l’éditeur Swagger.

  2. Ajoutez le fragment suivant après 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: {}

    Assurez-vous que l’indentation ressemble à l’image ci-dessous.

    Capture d’écran avec une flèche pointant vers le bouton Mettre à jour le connecteur.

  3. Recliquez sur + Nouvelle connexion.

    Capture d’écran avec une flèche pointant vers le bouton d’ajout d’une nouvelle connexion.

  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.

    Capture d’écran du message d’échec de connexion.

  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. Sélectionnez 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 (Chevron) du paramètre typeId, puis cliquez sur Modifier.

    Capture d’écran avec une flèche pointant vers le bouton de modification du paramètre de requête.

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

    Capture d’écran des propriétés du paramètre de requête.

  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.

    Capture d’écran des propriétés du paramètre de requête.

  7. Sélectionnez 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. Recherchez AddInvoice et vérifiez si x-ms-dynamic-values a été ajouté.

    Capture d’écran des valeurs dynamiques ajoutées.

  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. Sélectionnez l’onglet Test.

  2. Sélectionnez l’opération GetInvoiceSchema, puis cliquez sur Opération de test.

    Capture d’écran avec une flèche pointant vers le bouton de test de l’opération pour obtenir le schéma de facture.

  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é.

    Capture d’écran de la réponse pour obtenir le schéma de facture.

  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 :

    Capture d’écran du texte Swagger avant modification.

    Après :

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

    Capture d’écran du texte Swagger après modification.

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

  7. Sélectionnez l’onglet Définition.

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

    Capture d’écran de la visibilité pour l’action obtenir le schéma de facture.

  9. Sélectionnez 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 Automatisation > Flux de cloud > Instantané.

    Capture d’écran d’une flèche pointant vers le bouton permettant de créer un flux de cloud.

  4. Saisissez Métadonnées dynamiques pour Nom de flux, sélectionnez Déclencher manuellement un flux pour le déclencheur, puis cliquez sur Créer.

  5. Cliquez sur + Nouvelle étape.

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

  7. Sélectionnez l’action AddInvoice.

  8. Saisissez Ma connexion comme nom, saisissez votre nom pour Clé API, puis cliquez sur Créer. Le test de connexion devrait échouer.

Capture d’écran avec une flèche pointant vers le connecteur personnalisé.

  1. Saisissez la clé API que vous avez copiée à la Tâche 1 dans le champ Clé API, puis recliquez sur Créer.

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

  2. Dans le menu déroulant Type de facture, sélectionnez Commande fournisseur.

    Capture d’écran avec une flèche pointant vers le type de facture Commande fournisseur.

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

    Capture d’écran de l’action du connecteur personnalisé avec le champ Commande fournisseur visible.

  3. Modifiez le Type de facture sur Non-Commande fournisseur.

    Le champ Commande fournisseur ne devrait plus être visible.

    Capture d’écran de l’action du connecteur personnalisé avec le champ Commande fournisseur masqué.

  4. Enregistrez le flux.