Skip to main content

Export API

Envoie le flux d'entrée vers une API REST, en requêtes individuelles (une requête par ligne) ou par lot (batch). Utile pour pousser des enregistrements vers un CRM, un webhook ou tout service HTTP.

Connexion et authentification​

Comme la brick REST API, elle utilise de préférence une connexion REST API du projet (connection_id) ; à défaut, base_url et authentification se saisissent sur la brick :

ParamètreDescription
auth_typenone (défaut), clé API, token Bearer ou Basic.
api_key, api_key_location, api_key_nameClé API en header (défaut X-API-Key) ou en query string.
bearer_tokenToken Bearer.
basic_username, basic_passwordIdentifiants Basic.
timeoutTimeout par requête (30 s par défaut).
verify_sslVérification du certificat TLS (activée par défaut).

Requête​

ParamètreDéfautDescription
endpoint/Chemin de l'endpoint. Supporte les valeurs dynamiques par ligne : /users/{{id}} injecte la colonne id.
http_methodPOSTPOST (créer), PUT (remplacer), PATCH (mettre à jour), DELETE (supprimer).
request_modeindividualindividual : une requête par ligne ; batch : toutes les lignes d'un lot dans une requête.
batch_size100Nombre de lignes par requête en mode batch.
request_headers—Headers HTTP additionnels.

Construction du corps​

ParamètreDescription
body_templateTemplate Jinja2 du corps : {{ row.nom_colonne }} injecte la valeur de la ligne. Vide = la ligne (ou le lot) est envoyée telle quelle en JSON.
data_wrapperClé enveloppant les données (ex. items produit un objet avec la clé items contenant le tableau). Vide = pas de wrapper.
include_columnsColonnes à inclure (vide = toutes).
exclude_columnsColonnes à exclure.

Exemple de template en mode individuel :

{
"name": "{{ row.nom }}",
"email": "{{ row.email }}",
"source": "fluhoms"
}

Gestion des erreurs et débit​

ParamètreDéfautDescription
success_status_codes200, 201, 202, 204Codes HTTP considérés comme succès.
error_handlingstopstop : arrêter à la première erreur ; continue : continuer malgré les erreurs ; retry : réessayer puis continuer.
max_retries3Nombre de tentatives par requête (mode retry).
retry_delay1.0Délai entre tentatives, en secondes.
parallel_requests1Requêtes parallèles (mode individuel, 1 à 20).
rate_limit0Requêtes par seconde maximum (0 = illimité).

Sorties par statut HTTP​

La brick expose des sorties dynamiques routées par code de statut, comme la brick REST API :

  • status_outputs : règles nom de sortie / motif, où le motif est un code exact (200), un wildcard (2xx) ou default ;
  • status_default_enabled : conserve la sortie out par défaut ;
  • swagger_url : spec OpenAPI pour auto-détecter les sorties à partir des codes documentés.
tip

En mode individuel, routez les lignes refusées (4xx) vers une Écriture fichier pour rejouer les échecs plus tard.