Construire votre connecteur à partir d'une définition d'API

Créer un nouveau connecteur

Si vous sélectionnez Démarrer à partir d'une définition d'API (Start from an API definition), vous devez fournir la définition d'API :
- À partir d'un fichier local - Téléchargez une collection Postman ou Swagger.
- À partir d'une URL (From a URL) : saisissez une URL de fichier, telle que https://petstore.swagger.io/v2/swagger.json.
Cliquez sur Continuer (Continue).

Configurez votre connecteur

Dans la fenêtre Confirmer l'importation (Confirm import), vous pouvez :
- Modifiez le Nom du fournisseur ( Provider name), le Nom de l'application ( Application name) et le Nom du connecteur ( Connector name).
- Modifiez les ressources que vous souhaitez utiliser dans votre connecteur personnalisé. Toutes les ressources disponibles sont automatiquement sélectionnées ; désélectionnez celles que vous voulez exclure.
  - utiliser la barre de Recherche pour rechercher une ressource spécifique.
- Cliquez sur Créer (Create).
La fenêtre Paramètres (Settings) est maintenant affichée.
Dans l'onglet Info, vous pouvez configurer les champs suivants :
- Préfixe du connecteur (Connector prefix) : par exemple, documentation. Cela se reflète dans votre clé de connecteur.
- Nom du fournisseur (Provider name) : permet de saisir un nom de fournisseur.
- Nom de l'application : saisissez un nom d'application.
- Type d'API (API type) : ce champ est désactivé par défaut, car seul REST est actuellement pris en charge.
- Nom affiché ( Display name ) : il s'agit du nom de votre connecteur, tel qu'il apparaîtra dans le catalogue des connecteurs.
- Description : saisissez une description pour votre connecteur.
- Icône (Icon) : cliquez sur Parcourir ( Browse ) pour télécharger une image depuis votre ordinateur.
L'aperçu du catalogue (Catalog preview) vous montre comment votre connecteur personnalisé apparaîtra dans le catalogue de connecteurs Integration Service.
Cliquez sur Enregistrer (Save).

Configurer l'API de base

Dans l'onglet API de base , configurez l'URL de base pour l'API de l'application et la pagination :

URL de base ( Base URL) : automatiquement remplie avec la valeur déclarée lors de la création du connecteur.
Type de pagination : les options disponibles dans le menu déroulant sont : Début de page par 1, Début de page par 0, Décalage, Personnalisé. Si la documentation du fournisseur ne fournit aucun détail sur la pagination, conservez la valeur par défaut.
Pagination max – La valeur par défaut est 100. Si la documentation du fournisseur ne fournit aucun détail sur la pagination, conservez la valeur par défaut.
En -tête Content-Type : ce champ est désactivé par défaut, car seul application/json est actuellement pris en charge.
Accepter l'en-tête : ce champ est désactivé par défaut, car seul application/json est actuellement pris en charge.

Définir la méthode d’authentification

Dans l'onglet Authentification , vous configurez le type d'authentification pour votre connecteur. Pour plus d'informations sur les options prises en charge, consultez les Types d'authentification.

Testez votre connexion

Une fois que vous avez terminé la configuration de l'authentification, sélectionnez Ajouter une connexion (Add connection ) dans le menu déroulant :

Si votre connexion est réussie, le statut est mis à jour sur Connecté(Connected) .

Ressources

Le générateur de connecteurs génère la liste des ressources en fonction de la définition d'API fournie. Le menu de gauche affiche la liste des ressources disponibles, organisées en groupes.

Cliquez sur Plus d’options (More Options) menu à boutons pour configurer davantage chaque méthode. Vous pouvez :
- Ajouter une méthode (Add method ) : ouvre la fenêtre Créer une nouvelle ressource (Create new resource).
- Autoriser la suppression de la méthode ( Allow method suppression ) : active une icône Supprimer (Delete) pour chaque ressource du groupe.
- Modifier le chemin ( Edit path ) – Modifiez le chemin de la ressource. Par exemple : [BASE URL]/pet = https://petstore.swagger.io/v2/pet
- Supprimer ( Delete ) – Supprime un groupe de ressources. Un message vous avertit que l'opération ne peut pas être annulée.
- Dupliquer (Duplicate) : ouvre la fenêtre Dupliquer la ressource (Duplicate resource), dans laquelle vous pouvez modifier le chemin d'accès, choisir un nom d'affichage et sélectionner des méthodes.
Vous pouvez également Créer un nouveau groupe de ressources (Create new resource group) de deux manières :
- À partir du blanc
- à partir de cURL
Si vous choisissez de configurer une nouvelle ressource à partir de Vide, configurez les champs suivants :
- Chemin - [Base URL]/[path]
- Nom affiché
- Sélectionnez les méthodes: Get, Get By Id, Post, Put, Patch, Delete
Si vous choisissez de configurer une nouvelle ressource à partir de cURL, entrez une commande cURL.

Configurez vos ressources

Lorsque vous sélectionnez une ressource, la fenêtre suivante s'affiche :

Selon la méthode de ressource que vous sélectionnez, les onglets de configuration suivants sont disponibles : Paramètres(Parameters), Champs de réponse/demande ( Response/Request Fields), Pagination, Rechercher(Search).

Paramètres

Par exemple, les quatre onglets sont disponibles pour les méthodes GET. Pour les méthodes POST, vous ne pouvez voir que les onglets Paramètres (Parameters), Champs de requête (Request Fields) et Champs de réponse (Response Fields).

Dans Paramètres ( Parameters), vous pouvez afficher la liste des paramètres disponibles pour la ressource sélectionnée, ajouter de nouveaux paramètres ou importer des paramètres à partir d'une ressource existante.

Les paramètres répertoriés dans ce tableau sont ceux que vous utiliserez dans Studio lors de la création d'automatisations à l'aide de votre connecteur personnalisé.

L'objet Pet correspond au groupe de ressources Pet, et les champs disponibles sont ceux définis pour la ressource GETBYID :

Champs de réponse et de demande

Les champs Réponse et Demande de chaque ressource sont générés automatiquement lors de l'envoi d'une demande.

Dans chaque onglet respectif, vous pouvez modifier ou supprimer n'importe quel champ. Si vous cliquez sur l'icône Modifier (Edit), la fenêtre de configuration suivante s'affiche :

Dans l'onglet Champs de réponse/demande ( Response/Request fields), les options suivantes sont également disponibles :

Case à cocher Écraser sur la demande d'envoi ( Overwrite on send request ) : si cette option est sélectionnée, lorsque vous exécutez une demande d'envoi, la liste des champs est régénérée. Ne sélectionnez pas cette option si vous avez ajouté de nouveaux champs à votre ressource.

Bouton d'options supplémentaires :

Option	Ce qu’il fait
Mettre à jour la clé racine de la réponse	Définissez la clé de réponse lorsque vous traitez des tableaux imbriqués dans la réponse.
Supprimer tous les champs de la méthode	Supprime tous les champs de la méthode sélectionnée.
Générer à partir de la charge utile	Utilisez un exemple de charge utile de la documentation du service ou un appel d'API pour générer les champs de ressource.

Bouton Ajouter une ligne (Add row ) : ajoute de nouveaux champs à la ressource.

Cliquez sur l'icône Colonnes visibles ( Visible columns ) pour ajouter ou supprimer des colonnes dans la table des champs.

Chaque couleur sous la colonne Méthodes correspond à une certaine méthode : Get, Get by ID, Post, Put, Patch, Delete.

Pagination

Activez la pagination pour une ressource si vous attendez une réponse sous forme de liste. Si vous activez la pagination, vous devez également définir la clé racine de la réponse dans l'onglet de configuration, pour les listes imbriquées.