Intégrer des API tierces existantes à l’aide de Teams Toolkit v4

Capture d’écran montrant la note de dépréciation du Kit de ressources Teams v4.

Teams Toolkit vous permet d’accéder et d’utiliser des API existantes pour créer des applications Teams. Votre organization ou un tiers a peut-être développé ces API. Lorsque vous utilisez Teams Toolkit pour vous connecter à une API existante, Teams Toolkit effectue les fonctions suivantes :

  • Générez un exemple de code dans le ./bot dossier ou ./api .
  • Ajoutez une référence au @microsoft/teamsfx package à package.json.
  • Ajoutez des paramètres d’application pour votre API dans .env.teamsfx.local qui configure le débogage local.

Teams Toolkit vous permet d’accéder à l’exemple de code de démarrage pour accéder aux API, si vous n’avez pas de sdk appropriés au langage pour accéder à ces API.

Configurer la connexion d’API

Vous pouvez ajouter une API tierce existante à votre application Teams à l’aide de :

Ajouter une connexion d’API à l’aide du Kit de ressources Teams

Ajoutez une connexion à une API tierce existante en procédant comme suit :

  1. Ouvrez votre projet d’application Teams dans Visual Studio Code.

  2. Sélectionnez Teams Toolkit dans la barre d’activité Visual Studio Code.

  3. Sélectionnez Ajouter des fonctionnalités dans la section DÉVELOPPEMENT .

    api ajouter des fonctionnalités

    La liste déroulante Ajouter une fonctionnalité s’affiche.

  4. Sélectionnez Connexion d’API.

    api select features

  5. Entrez point de terminaison pour l’API, puis appuyez sur Entrée.

    Vérifiez que le point de terminaison est une URL HTTP valide. Teams Toolkit ajoute le point de terminaison aux paramètres d’application locaux du projet, et il s’agit de l’URL de base pour les demandes d’API.

    Point de terminaison d’api

  6. Sélectionnez le composant qui doit se connecter à l’API, puis sélectionnez OK.

    appel d’api

  7. Entrez un alias pour l’API, puis appuyez sur Entrée.

    L’alias génère un nom de paramètre d’application pour l’API. Teams Toolkit ajoute l’alias au paramètre d’application locale du projet.

    alias d’api

  8. Sélectionnez l’authentification requise pour la demande d’API dans le type d’authentification d’API.

    Authentification api

    Teams Toolkit génère un exemple de code approprié et ajoute les paramètres d’application locaux correspondants en fonction de l’authentification que vous sélectionnez. Pour configurer l’authentification :

Pour implémenter l’authentification de base à l’aide du nom d’utilisateur et du mot de passe :

  • Sélectionnez De base.
  • Entrez le nom d’utilisateur de l’authentification de base.

Teams Toolkit génère l’exemple de code pour appeler votre API à bot\myAPI.js.

Vous avez correctement ajouté une connexion dans votre application Teams à une API existante.

Ajouter une connexion d’API à l’aide de l’interface CLI TeamsFx

La commande de base de cette fonctionnalité est teamsfx add api-connection [authentication type]. Le tableau suivant fournit la liste des différents types d’authentification et leurs exemples de commandes correspondants :

Conseil

Vous pouvez utiliser teamsfx add api-connection [authentication type] -h pour obtenir un document d’aide.

Type d’authentification type Exemple de commande
Basique teamsfx add api-connection basic---endpoint https://example.com --component bot--alias example--user--name example user--interactive false
Clé API teamsfx ajouter api-connection apikey--endpoint https://example.com --component bot--alias example--key-location header---key-name example-key-name--interactive false
Identifiant Microsoft Entra teamsfx ajouter api-connection aad--endpoint https://example.com --component bot--alias example---app-type custom--tenant-id your_tenant_id--app-id your_app_id--interactive false
Certificat teamsfx ajouter api-connection cert--endpoint https://example.com --component bot--alias example--interactive false
Personnalisé teamsfx ajouter api-connection custom--endpoint https://example.com --component bot--alias example--interactive false

Mises à jour de la structure de répertoires de votre projet

Le kit de ressources Teams modifie bot ou api dossier en fonction de votre sélection :

  1. Générer un {your_api_alias}.js\ts fichier. Le fichier initialise un client API pour votre API et exporte le client d’API.

  2. Ajoutez le @microsoft\teamsfx package à package.json. Le package prend en charge les méthodes d’authentification d’API courantes.

  3. Ajoutez des variables d’environnement à .env.teamsfx.local. Vous devez configurer des variables d’environnement pour le type d’authentification sélectionné. Le code généré lit les valeurs des variables d’environnement.

Voir aussi