Connectez-vous aux services avec OpenAPI

1. Accédez au service que vous souhaitez connecter à App Studio et recherchez un fichier JSON de spécification OpenAPI.

   Note

   App Studio prend en charge les fichiers de spécification OpenAPI conformes à la version 3.0.0 ou supérieure de la spécification OpenAPI.

2. Rassemblez les données nécessaires pour configurer le connecteur OpenAPI, notamment les suivantes :

   • URL de base pour la connexion au service.

   • Informations d'authentification, telles qu'un jeton ou un nom d'utilisateur/mot de passe.

   • Le cas échéant, tous les en-têtes.

   • Le cas échéant, tous les paramètres de requête.

Pour créer un connecteur pour OpenAPI

1. Accédez à App Studio.

2. Dans le volet de navigation de gauche, choisissez Connectors dans la section Gérer. Vous serez redirigé vers une page affichant une liste des connecteurs existants avec quelques détails sur chacun d'entre eux.

3. Choisissez + Créer un connecteur.

4. Choisissez OpenAPI Connector dans la liste des types de connecteurs. Configurez maintenant votre connecteur en remplissant les champs suivants.

5. Nom : entrez le nom de votre connecteur OpenAPI.

6. Description : Entrez une description pour votre connecteur OpenAPI.

7. URL de base : entrez l'URL de base pour la connexion au service.

8. Méthode d'authentification : choisissez la méthode d'authentification auprès du service cible.

   • Aucune : accédez au service cible sans authentification.

   • Basique : accédez au service cible à l'aide d'un nom d'utilisateur et d'un mot de passe obtenus auprès du service auquel vous êtes connecté.

   • Jeton porteur : accédez au service cible à l'aide de la valeur du jeton d'authentification obtenu à partir du compte utilisateur du service ou des paramètres de l'API.

   • OAuth 2.0 : Accédez au service cible à l'aide du protocole OAuth 2.0, qui permet à App Studio d'accéder au service et aux ressources sans partager d'informations d'identification ou d'identité. Pour utiliser la méthode d'authentification OAuth 2.0, vous devez d'abord créer une application à partir du service auquel vous êtes connecté et qui représente App Studio afin d'obtenir les informations nécessaires. À l'aide de ces informations, remplissez les champs suivants :

     1. Flux d'informations d'identification du client :

        1. Dans ID client, entrez l'ID du service cible.

        2. Dans Client secret, entrez le secret du service cible.

        3. Dans URL du jeton d'accès, entrez l'URL du jeton du service cible.

        4. Dans Étendue, entrez éventuellement les étendues de l'application dans Étendue. Les étendues sont des autorisations ou des niveaux d'accès requis par l'application. Reportez-vous à la documentation de l'API du service cible pour comprendre leur portée et configurer uniquement celles dont votre application App Studio a besoin.

        Ajoutez les variables à envoyer avec le service à chaque appel, puis choisissez Vérifier la connexion pour tester l'authentification et la connexion.

     2. Flux de code d'autorisation :

        1. Dans ID client, entrez l'ID du service cible.

        2. Dans Client secret, entrez le secret du service cible.

        3. Dans URL d'autorisation, entrez l'URL d'autorisation du service cible.

        4. Dans URL du jeton d'accès, entrez l'URL du jeton du service cible.

        5. Dans Étendue, entrez éventuellement les étendues de l'application dans Étendue. Les étendues sont des autorisations ou des niveaux d'accès requis par l'application. Reportez-vous à la documentation de l'API du service cible pour comprendre leur portée et configurer uniquement celles dont votre application App Studio a besoin.

9. Variables : ajoutez des variables à envoyer au service à chaque appel. Les variables ajoutées lors de la configuration sont stockées de manière sécurisée et accessibles uniquement pendant l'exécution des applications qui utilisent la connexion.

10. En-têtes : ajoutez des en-têtes HTTP utilisés pour fournir des métadonnées sur la demande ou la réponse. Vous pouvez ajouter à la fois des clés et des valeurs, ou fournir uniquement une clé à laquelle le générateur peut fournir une valeur dans l'application.

11. Paramètres de requête : ajoutez des paramètres de requête utilisés pour transmettre des options, des filtres ou des données dans le cadre de l'URL de demande. Comme pour les en-têtes, vous pouvez fournir à la fois une clé et une valeur, ou fournir uniquement une clé à laquelle le générateur peut fournir une valeur dans l'application.

12. Fichier de spécification OpenAPI : chargez un fichier JSON de spécification OpenAPI par glisser-déposer, ou en choisissant Sélectionnez un fichier pour naviguer dans votre système de fichiers local et choisissez le fichier à télécharger.

    Une fois ajouté, le fichier est traité et une liste des options disponibles s'affiche. Sélectionnez les opérations nécessaires pour votre connecteur.

13. Choisissez Créer. Le connecteur nouvellement créé apparaîtra dans la liste des connecteurs.