Aller au contenu principal

Endpoint API

Appelle un endpoint API enregistre dans l'API Manager du workspace. Reutilise la configuration (auth, headers) definie dans le catalogue.

Parametres

ParametreTypeRequisVariableDescription
endpointIdtexteOuiOuiIdentifiant de l'endpoint API selectionne depuis le catalogue.
endpointPathtexteNonNonChemin de l'endpoint (ex: /api/queries/nodes). Rempli automatiquement lors de la selection.
methodchoix (GET, POST, PUT, PATCH, DELETE)OuiNonMethode HTTP de la requete.
categorytexteNonNonCategorie de l'endpoint (queries, commands, health, etc.).
descriptiontexteNonNonDescription de l'endpoint.
apiKeyConfigobjetNonNonConfiguration de la cle API pour l'authentification.
requestBodyvaleur dynamiqueNonOuiCorps de la requete (pour les methodes POST, PUT, PATCH). Peut etre une valeur fixe ou une variable.
headerslisteNonNonEn-tetes HTTP de la requete (paires cle/valeur dynamiques).
queryParamslisteNonNonParametres de requete URL (paires cle/valeur dynamiques).
pathParamslisteNonNonParametres de chemin extraits automatiquement des motifs :param dans l'URL.
timeoutnombreNonNonDelai d'expiration de la requete en millisecondes.
retryOnErroroui/nonNonNonRetenter automatiquement la requete en cas d'erreur. (Defaut: false)
maxRetriesnombreNonNonNombre maximum de tentatives en cas d'erreur. (Defaut: 1, min 1, max 10)

Les parametres marques Variable = Oui acceptent la syntaxe {{nomBloc.champ}}.

Sortie

Variable de sortie : apiEndpointResult

{
"success": false,
"statusCode": 0,
"headers": {},
"body": "...",
"rawBody": "...",
"responseTimeMs": 0,
"contentLength": 0,
"endpoint": {}
}

Exemple

Appeler un endpoint pre-configure.

Entree :

{"endpointId": "ep-crm-leads"}

Sortie :

{"success": true, "statusCode": 200, "headers": {"content-type": "application/json"}, "body": [{"id": 1, "name": "Acme"}], "rawBody": "[{\"id\":1,\"name\":\"Acme\"}]", "responseTimeMs": 245, "contentLength": 32, "endpoint": {"id": "ep-crm-leads", "name": "CRM Leads"}}
Astuce

Preferer ce bloc a http_request pour les APIs frequemment utilisees : la configuration d'authentification est centralisee dans l'API Manager.