PowerApps peut tirer parti d’API RESTful hébergées n’importe où. Ce didacticiel indique comment inscrire et utiliser une API personnalisée.

Conditions préalables

  • Un compte PowerApps.
  • Un fichier Swagger (JSON) OU l’URL d’une définition Swagger pour votre API personnalisée. Si vous n’en avez pas, nous allons vous montrer plusieurs options permettant de créer le fichier Swagger.
  • Une image à utiliser en tant qu’icône de votre API personnalisée (facultatif).

Authentification

Dans PowerApps, les API personnalisées peuvent utiliser plusieurs mécanismes d’authentification.

  • Clé API
  • Authentification de base
  • OAuth version 2.0 générique
  • OAuth 2.0 Les implémentations spécifiques détaillées ci-dessous sont actuellement prises en charge. D’autres devraient faire leur apparition prochainement.

    • Azure Active Directory
    • Box
    • Dropbox
    • Facebook
    • Google
    • Instagram
    • OneDrive
    • Salesforce
    • Slack
    • Yammer

La spécification OpenAPI explique comment spécifier l’authentification au sein du fichier Swagger.

Si votre point de terminaison d’API autorise un accès non authentifié, vous devez supprimer l’objet securityDefintions dans le fichier OpenAPI (Swagger). Dans l’exemple suivant, supprimez l’objet securityDefintions dans son ensemble :

  "securityDefinitions": {
    "AAD": {
      "type": "oauth2",
      "flow": "implicit",
      "authorizationUrl": "https://login.windows.net/common/oauth2/authorize",
      "scopes": {}
    }
  },

Exemples

Inscrire une API personnalisée

Étape 1 : créer un fichier Swagger

Vous pouvez créer un fichier Swagger à partir de n’importe quel point de terminaison d’API, y compris :

  • Les API mises à la disposition du public. Exemples : Spotify, Uber, Slack, Rackspace, etc.
  • Une API que vous créez et déployez sur n’importe quel fournisseur d’hébergement cloud, notamment Amazon Web Services (AWS), Heroku, Azure Web Apps, Google Cloud, etc.
  • Une API métier personnalisée déployée sur votre réseau, tant que l’API est exposée sur le réseau Internet public.

Lorsque vous créez le fichier Swagger, un fichier JSON est généré. Vous aurez besoin de ce fichier à l’étape 2.

Connexion à Azure App Service ou Azure Functions

Si votre API est générée avec Azure App Service ou Azure Functions, consultez la page Exportation d’une API hébergée sur Azure vers PowerApps et Microsoft Flow pour en savoir plus.

Obtenir de l’aide sur les fichiers Swagger

Étape 2 : Inscrire l’API personnalisée

Maintenant que le fichier Swagger (fichier JSON) est généré pour l’API personnalisée, inscrivez cette dernière dans PowerApps.

  1. Dans powerapps.com, dans le menu de gauche, cliquez sur Connections (Connexions). Ensuite, cliquez sur ... et sélectionnez l’option Manage custom APIs (Gérer les API personnalisées) dans l’angle supérieur droit de la fenêtre.

    Conseil :

    Si vous ne trouvez pas le menu, cela peut être dû au fait qu’il est masqué par un bouton hamburger situé dans l’angle supérieur gauche d’un navigateur mobile.

    Création d’une API personnalisée

  2. Sélectionnez New custom API (Nouvelle API personnalisée) :

    Propriétés de l’API personnalisée

    Vous êtes invité à indiquer les propriétés de votre API.

    Propriété Description
    Swagger URL OR Swagger API definition Collez l’URL à vers la définition Swagger, OU accédez au fichier JSON créé à partir de Swagger.
    Nom Saisissez le nom de votre API personnalisée.
    Upload API icon Permet d’accéder à un fichier image pour l’icône (facultatif).
    Description Saisissez la description de votre API personnalisée (facultatif).

    Sélectionnez Next (Suivant).

  3. Saisissez les éventuelles propriétés d’authentification. Si le fichier JSON utilise une authentification OAuth2 dans l’objet securityDefintions, vous êtes invité à saisir les valeurs suivantes :

    Propriété Description
    Client ID Un ID client est fourni via l’un des fournisseurs d’identité OAuth. Saisissez cet ID.
    Client secret Tapez la clé secrète client du fournisseur d’identité choisi.

    Consultez les exemples Azure Resource Manager et Azure WebApp pour savoir comment configurer les valeurs d’authentification AAD.

    Si le fichier JSON n’utilise pas l’objet securityDefintions, il se peut qu’aucune valeur supplémentaire ne soit requise.

  4. Sélectionnez Create (Créer).

    Votre API personnalisée est maintenant affichée sous Custom (Personnalisé).

    API disponibles

    Conseil :

    Si le fichier Swagger ne peut pas être validé, cela peut être lié à des caractères supplémentaires. Par exemple, la plupart des données doivent être placées entre guillemets, y compris les URL de site web.

  5. Maintenant que l’API personnalisée est enregistrée, vous devez créer une connexion à cette dernière, afin de pouvoir l’utiliser dans vos applications. Cliquez sur le signe + figurant à droite de la date de modification de l’API personnalisée, puis effectuez la procédure requise pour vous connecter à la source de données de votre API. Si vous utilisez l’authentification OAuth avec votre API, il se peut qu’un écran de connexion s’affiche. Pour l’authentification de clé d’API, vous pouvez être invité à indiquer une valeur de clé.

Étape 3 : ajouter l’API personnalisée à une application

Ajoutez l’API personnalisée à une application comme vous le feriez pour toute autre source de données, puis utilisez l’API dans la barre de fonction, une zone de texte, etc. Ainsi, dans la barre de fonction, vous pouvez commencer à saisir MySampleWebAPI pour afficher les fonctions disponibles. Office 365 Outlook est un exemple d’utilisation de l’API Office 365.

Partager une API personnalisée

Les utilisateurs peuvent également partager des API personnalisées les uns avec les autres.

  1. Dans powerapps.com, dans le menu de gauche, cliquez sur Connections (Connexions). Ensuite, cliquez sur ... et sélectionnez l’option Manage custom APIs (Gérer les API personnalisées) dans l’angle supérieur droit de la fenêtre.

    Option Nouvelle connexion

  2. Sélectionnez votre API, sélectionnez Share (Partager), puis saisissez les utilisateurs ou les groupes auxquels vous souhaitez accorder l’accès à votre API.

    Partage d’une API personnalisée

  3. Sélectionnez Save (Enregistrer).

Remarque :

Vous pouvez uniquement partager des API personnalisées avec d’autres utilisateurs au sein de votre organisation.

Quotas et limitation

  • Consultez la page relative à la tarification PowerApps pour en savoir plus sur les quotas de création d’API personnalisée. Les API personnalisées partagées avec vous ne sont pas comptées dans ce quota.
  • Pour chaque connexion créée sur une API personnalisée, les utilisateurs peuvent générer jusqu’à 500 demandes par minute.
  • N’oubliez pas que la suppression d’une API personnalisée s’accompagne de celle de toutes les connexions créées pour l’API.
  • La taille de votre fichier Swagger doit être inférieure à 1 Mo.

Étapes suivantes

Découvrez plus d’informations sur les extensions Swagger personnalisées.

Découvrez comment utiliser une API web ASP.NET.

Découvrez comment inscrire une API Azure Resource Manager.