REST API (tout service HTTP)

Rôle

Tout service HTTP : lire des enregistrements (JSON, XML, CSV/TSV, JSON Lines) et envoyer des lignes (JSON, XML, données de formulaire, CSV). Une connexion représente une ressource API et une méthode de requête ; créez une autre connexion pour une ressource ou une méthode différente.

Champs de connexion

Champ	Règle et valeur par défaut	Explication
Adresse de base de l’API `base_url`	Obligatoire	Définissez la valeur selon la configuration de votre service.
Authentification `auth`	Selon la configuration Par défaut : `none`	`none` — Sans authentification `basic` — Basic (nom d’utilisateur et mot de passe) `bearer` — Jeton Bearer `api_key` — Clé API dans un en-tête `oauth2` — OAuth 2.0 client credentials
Utilisateur `username`	Selon la configuration	Affiché lorsque : auth = basic
En-tête de la clé API `header_name`	Selon la configuration Par défaut : `X-API-Key`	Affiché lorsque : auth = api_key
Adresse du point de terminaison de jeton `token_url`	Selon la configuration	Affiché lorsque : auth = oauth2
Client ID `client_id`	Selon la configuration	Affiché lorsque : auth = oauth2
Scope (facultatif) `scope`	Selon la configuration	Affiché lorsque : auth = oauth2
En-têtes supplémentaires `headers`	Selon la configuration	Un par ligne : « Name: value ». Placez les secrets dans le champ secret, pas ici.
Délai de réponse, secondes `timeout`	Selon la configuration Par défaut : `60` Plage : 1–600	Définissez la valeur selon la configuration de votre service.
Chemin de la ressource `resource_path`	Selon la configuration	Relatif à l’adresse de base, sans paramètres de requête (? …). Pour les requêtes individuelles, un champ de ligne peut être inséré dans le chemin : /orders/{{Number}}.
Méthode de requête `method`	Selon la configuration Par défaut : `GET`	`GET` — GET — lecture `POST` — POST — lecture avec corps de requête ou envoi de lignes `PUT` — PUT — envoi de lignes (remplacement) `PATCH` — PATCH — envoi de lignes (mise à jour)
Paramètres de requête de base `query_params`	Selon la configuration	Ajoutés à chaque requête utilisant cette connexion. Un par ligne : « name=value » ou simplement « name » (par exemple, json). Les valeurs sont encodées automatiquement. Un bloc source peut ajouter ses propres paramètres.
Format du corps de requête `request_format`	Selon la configuration Par défaut : `json`	Pour l’envoi de lignes et le corps d’une requête de lecture POST. `json` — JSON `xml` — XML `form` — Formulaire (application/x-www-form-urlencoded) `csv` — CSV — texte délimité Affiché lorsque : method = POST, PUT, PATCH
Corps de requête `body`	Selon la configuration	Uniquement pour la lecture POST, dans le format de corps sélectionné (pour les données de formulaire, un « name=value » par ligne). Lors de l’envoi, les lignes de la table constituent le corps de requête et ce champ n’est pas utilisé. Affiché lorsque : method = POST
Élément XML de ligne `xml_record`	Selon la configuration Par défaut : `record`	Chaque ligne est envoyée comme élément portant ce nom ; les colonnes deviennent ses éléments enfants. Affiché lorsque : method = POST, PUT, PATCH, request_format = xml
Format de réponse `response_format`	Selon la configuration Par défaut : `auto`	`auto` — Détecter automatiquement (à partir de Content-Type) `json` — JSON `xml` — XML `csv` — CSV/TSV — texte délimité `jsonl` — JSON Lines (NDJSON) — un objet JSON par ligne Affiché lorsque : method = GET, POST
Encodage de la réponse `response_encoding`	Selon la configuration Par défaut : `auto`	Automatique : à partir de Content-Type ou de la déclaration XML ; sinon UTF-8. `auto` — Automatique `utf-8` — UTF-8 `windows-1251` — Windows-1251 `iso-8859-1` — ISO-8859-1 (Latin-1) Affiché lorsque : method = GET, POST
Séparateur CSV `csv_delimiter`	Selon la configuration Par défaut : `comma`	`comma` — Virgule ( , ) `semicolon` — Point-virgule ( ; ) `tab` — Tabulation (TSV) `pipe` — Barre verticale ( \| ) La disponibilité dépend de la méthode et du format de requête.
La première ligne CSV de la réponse contient les noms des colonnes `csv_header`	Selon la configuration Par défaut : `True`	Affiché lorsque : method = GET, POST, response_format = csv
Chemin des enregistrements dans la réponse `records_path`	Selon la configuration	JSON : chemin séparé par des points (data.items) ; vide signifie un tableau d’enregistrements ou un objet contenant un seul tableau. XML : chemin d’éléments depuis la racine (./item, ./data/item, .//item) ; vide signifie les éléments répétés, soit le plus grand groupe d’éléments identiques (pour une liste simple, les enfants de la racine). Les objets et éléments imbriqués deviennent des colonnes « a.b » ; les attributs XML deviennent « @name ». Affiché lorsque : method = GET, POST, response_format = auto, json, xml
Inclure les attributs des éléments parents dans les enregistrements XML `xml_ancestors`	Selon la configuration Par défaut : `True`	Chaque enregistrement reçoit les attributs des éléments situés entre la racine et cet enregistrement. Par exemple, dans les taux de change de la BCE, la date Cube.Cube.@time apparaît sur chaque ligne de devise. Le nom de colonne est le chemin de l’élément depuis la racine suivi de « @attribute » ; un champ présent sur l’enregistrement lui-même est prioritaire. Affiché lorsque : method = GET, POST, response_format = auto, xml
Pages de réponse `pagination`	Selon la configuration Par défaut : `none`	`none` — Une seule réponse `next_link` — Lien vers la page suivante dans le corps de réponse (JSON, XML) `link_header` — Lien vers la page suivante dans l’en-tête Link (rel="next") `page` — Numéro de page dans un paramètre `offset` — Décalage dans un paramètre Affiché lorsque : method = GET, POST
Chemin du lien vers la page suivante `next_link_path`	Selon la configuration Par défaut : `next`	JSON : chemin séparé par des points ; XML : chemin d’élément (texte de l’élément) ou « path@attribute ». Le lien doit viser le même serveur. Affiché lorsque : method = GET, POST, pagination = next_link
Paramètre de numéro de page ou de décalage `page_param`	Selon la configuration Par défaut : `page`	Affiché lorsque : method = GET, POST, pagination = page, offset
Paramètre de taille de page (facultatif) `size_param`	Selon la configuration	Affiché lorsque : method = GET, POST, pagination = page, offset
Taille de page `page_size`	Selon la configuration Par défaut : `100` Plage : 1–10000	Affiché lorsque : method = GET, POST, pagination = page, offset
Numéro de la première page `first_page`	Selon la configuration Par défaut : `1` Plage : 0–1	Affiché lorsque : method = GET, POST, pagination = page
Nombre maximal de pages `max_pages`	Selon la configuration Par défaut : `100` Plage : 1–10000	Affiché lorsque : method = GET, POST, pagination = next_link, link_header, page, offset
Mode d’envoi des lignes `send_mode`	Selon la configuration Par défaut : `row`	Pour les destinations. JSON : une ligne est un objet « colonne : valeur » et un lot est un tableau d’objets. XML : un élément de ligne, avec un lot contenu dans un élément racine. Données de formulaire : requêtes individuelles uniquement. CSV : une ligne d’en-tête suivie des lignes de valeurs. `row` — Une requête par ligne `batch` — Lots — plusieurs lignes dans une requête Affiché lorsque : method = POST, PUT, PATCH
Lignes par lot `batch_size`	Selon la configuration Par défaut : `100` Plage : 1–10000	Affiché lorsque : method = POST, PUT, PATCH, send_mode = batch
Clé du tableau dans le corps du lot JSON (facultative) `batch_key`	Selon la configuration	Affiché lorsque : method = POST, PUT, PATCH, send_mode = batch, request_format = json
Élément racine du lot XML `xml_root`	Selon la configuration Par défaut : `records`	Affiché lorsque : method = POST, PUT, PATCH, send_mode = batch, request_format = xml
Mot de passe, jeton, clé ou secret client `secret`	Champ protégé distinct	Le secret n’est plus affiché après enregistrement. Un champ vide dans une connexion existante conserve son secret actuel.

Configuration et validation

Créez une connexion et donnez-lui un nom explicite.
Renseignez les champs obligatoires et le champ secret distinct.
Exécutez « Test » et lisez le diagnostic.
Enregistrez la connexion et sélectionnez-la dans le bloc de flux approprié.

Un test réussi ne remplace pas la vérification de l’accès à l’objet nécessaire et du mode d’écriture précis.

Utilisation dans un flux

Les paramètres du serveur et du compte sont conservés dans la connexion. L’objet précis, les champs et le comportement du flux sont définis dans le bloc. Accéder aux règles de traitement des données →