Connexion REST générique

La connexion REST générique relie PlaidCloud à n’importe quel service HTTP/REST qui n’a pas de connecteur dédié. Elle prend en charge les schémas d’authentification courants (None, Basic, API Key, jeton Bearer, OAuth 2.0), les en-têtes de requête par défaut, une gestion fine des redirections et du transport, ainsi qu’un testeur de requêtes intégré au formulaire.

Les convertisseurs, comme l’importeur Savant, peuvent créer des connexions REST qui contiennent des valeurs secrètes chiffrées. Les étapes qu’ils convertissent utilisent ces valeurs à l’exécution.

Configuration

Le formulaire comporte quatre onglets.

Détails de la connexion

Champ	Type	Description
Nom de la connexion	Texte	Nom d’affichage de cette connexion.
Mémo	Texte (multiligne)	Remarques facultatives sur la connexion.
Hôte ou adresse IP	Texte	Hôte de base ciblé par les requêtes.
Actif (autoriser l’accès)	Interrupteur	Indique si la connexion est activée. Désactivez-la pour la mettre en pause sans la supprimer.
Type d’authentification	Sélection	None, Basic, API Key, Bearer Token, OAuth 2.0, Azure Cosmos DB (Master Key) ou Azure Cosmos DB (Microsoft Entra ID). Le choix d’un type active le groupe correspondant dans l’onglet Authentification.
Modèle de sécurité	Sélection	Qui peut utiliser la connexion : Privé, Membres spécifiques, Groupes de sécurité spécifiques ou Tous les membres de l’espace de travail.

Paramètres de la connexion

Paramètre	Par défaut	Description
Activer la vérification des certificats SSL	Désactivé	Vérifie les certificats SSL lors de l’envoi d’une requête. Un échec de vérification interrompt la requête.
Suivre automatiquement les redirections	Activé	Traite les réponses HTTP 3xx comme des redirections à suivre.
Conserver la méthode HTTP d’origine	Désactivé	Redirige avec la méthode HTTP d’origine au lieu de rediriger par défaut avec GET.
Conserver l’en-tête Authorization	Désactivé	Conserve l’en-tête d’autorisation lors d’une redirection.
Supprimer l’en-tête referer lors d’une redirection	Désactivé	Supprime l’en-tête referer lors d’une redirection.
Analyseur HTTP strict activé	Désactivé	Rejette les réponses dont les en-têtes HTTP sont invalides.
Encoder l’URL automatiquement	Activé	Encode le chemin de l’URL, les paramètres de requête et les champs d’authentification.
Désactiver le stockage des cookies	Désactivé	Ne stocke pas les cookies de cette requête dans le stockage des cookies et n’envoie pas les cookies stockés sous forme d’en-têtes.
Utiliser la suite de chiffrement du serveur lors de la négociation	Désactivé	Utilise l’ordre des suites de chiffrement du serveur plutôt que celui du client lors de la négociation.
Nombre maximal de redirections	10	Limite le nombre de redirections à suivre.

Définition de l’API

Facultatif. Joignez à la connexion la définition OpenAPI 3.x ou Swagger 2.0 de l’API, et toute étape Requête REST qui l’utilise peut lister les points de terminaison de l’API (avec leurs méthodes, paramètres et corps de requête préremplis) sans qu’il soit nécessaire de répéter la définition dans chaque étape.

Champ	Type	Description
Définition	Sélection	None, OpenAPI / Swagger URL ou OpenAPI / Swagger file.
URL de la définition	Texte	Adresse à laquelle la spécification est publiée, par exemple https://api.example.com/openapi.json. Affiché lorsque vous choisissez l’URL.
Fichier de définition	Fichier	Une spécification .json ou .yaml stockée dans un compte de documents. Affiché lorsque vous choisissez le fichier.

Dans une étape Requête REST, choisissez cette connexion, définissez Source du point de terminaison sur À partir de la définition d’API de la connexion, puis choisissez Charger le catalogue.

Note

L’URL d’une définition doit être accessible depuis Internet. Si la spécification n’est publiée qu’à l’intérieur de votre propre réseau, téléversez-la dans un compte de documents et sélectionnez-la comme fichier.

Authentification

Seul le groupe correspondant au Authentication Type sélectionné est affiché. Avec None, l’onglet est désactivé.

Basique

Champ	Type	Description
Utilisateur	Texte	Nom d’utilisateur de l’authentification Basic.
Mot de passe	Mot de passe	Mot de passe de l’authentification Basic (en écriture seule).

Clé API

Champ	Type	Description
Clé	Texte	Nom du champ de la clé d’API.
Valeur	Texte	Valeur de la clé d’API.

Jeton Bearer

Champ	Type	Description
Jeton	Mot de passe	Jeton Bearer (en écriture seule).

OAuth 2.0

Champ	Type	Description
Ajouter les données d’authentification à	Sélection	Envoie les données d’authentification dans les Request Headers ou dans la Request URL.
Préfixe de l’en-tête	Texte	Préfixe de la valeur de l’en-tête d’autorisation (Bearer par défaut).
URL d’authentification	Texte	Point de terminaison d’autorisation.
URL du jeton d’accès	Texte	Point de terminaison du jeton.
ID client	Texte	Identifiant client OAuth.
Secret client	Texte	Secret client OAuth.
URL du jeton d’actualisation	Texte	Point de terminaison utilisé pour actualiser le jeton.
Jeton d’actualisation initial	Texte	Jeton d’actualisation d’amorçage pour le premier échange.
Paramètres supplémentaires de la requête de jeton	Table	Paramètres de corps supplémentaires envoyés dans les requêtes de jeton (Activé, Nom, Valeur, Description).
En-têtes supplémentaires de la requête de jeton	Table	En-têtes supplémentaires envoyés dans les requêtes de jeton (Activé, Nom, Valeur, Description).

Azure Cosmos DB (Clé principale)

Champ	Type	Description
Clé principale	Mot de passe	La clé principale du compte Cosmos DB (en écriture seule). Chaque requête est signée avec cette clé, comme l’exige l’API REST de Cosmos DB.

Azure Cosmos DB (Microsoft Entra ID)

Champ	Type	Description
URL du jeton d’accès	Texte	Le point de terminaison de jeton de votre locataire, par exemple https://login.microsoftonline.com/<tenant>/oauth2/v2.0/token.
ID client	Texte	L’ID client de l’application Entra.
Secret client	Mot de passe	Le secret client de l’application Entra (en écriture seule).

Utilisez une connexion Cosmos DB avec l’étape Requête REST pour interroger les documents d’un conteneur et y écrire. Définissez l’URL de base de la connexion sur le point de terminaison du compte Cosmos DB.

En-têtes par défaut

Un tableau d’en-têtes envoyés à chaque requête effectuée via cette connexion. Chaque ligne comporte Enabled, Header Name, Value et Description. Utilisez les boutons de ligne pour ajouter, insérer et supprimer des en-têtes. Ces en-têtes sont envoyés avec chaque requête de la connexion, y compris chaque page d’une lecture paginée et chaque requête d’une démultiplication par ligne  ; un en-tête défini sur une étape donnée prévaut sur un en-tête de même nom défini ici.

Test

Envoyez une requête ad hoc via la connexion enregistrée pour vérifier qu’elle fonctionne.

Champ	Type	Description
Point de terminaison de test	Texte	URL complète à appeler (par exemple https://example.com/rest/test/validate).
Méthode	Sélection	GET, PUT, POST, DELETE, HEAD ou OPTIONS.
Charge utile	Code	Corps de la requête. Prend en charge les jetons de modèle de style Django/Jinja.
Envoyer une requête de test	Bouton	Envoie la requête et affiche la réponse (ou l’erreur).

Attention

Enregistrez la connexion avant d’envoyer une requête de test : le test s’exécute avec la configuration enregistrée, donc une connexion non enregistrée est rejetée.

Note

Les champs de mot de passe et de jeton sont en écriture seule. Ils s’affichent vides lorsque vous rouvrez une connexion enregistrée, et les laisser vides lors de l’enregistrement conserve le secret stocké. Ne saisissez à nouveau une valeur que pour la modifier.

Voir aussi

• Connecteurs REST — connecteurs dédiés pour Salesforce, NetSuite, Workday et d’autres services REST.
• Importer des données Samsara — une recette à copier-coller pour une API qui utilise la pagination par curseur.
• Créer et gérer une connexion
• Étape de workflow Requête REST