Skip to main content

Chiamata REST

Chiamata REST | Sybot Documentation

CHIAMATA REST

Il Task Chiamata REST consente al Workflow di interagire con sistemi esterni tramite API REST. Permette di inviare richieste HTTP e di gestire le risposte dei servizi web, abilitando l’integrazione con applicazioni esterne.

E' lo strumento principale per comunicare con altre piattaforme, come ServiceNow, Salesforce, sistemi di ticketing, database cloud e innumerevoli altri servizi, sia per recuperare dati (GET) che per inviare o modificare informazioni (POST, PUT).

Configurazione

La configurazione del Task definisce ogni aspetto della richiesta HTTP che verrà inviata. I campi di configurazione del Task possono essere valorizzati manualmente o tramite parametri e variabili del workflow.

Connessione SSL​

Specifica se la chiamata deve utilizzare il protocollo SSL (si/ no).

Proxy

Definisce l'instradamento della connessione tramite le seguenti opzioni:

  • Impostazione di sistema: utilizza il proxy configurato a livello globale.
  • No Proxy: la chiamata viene effettuata direttamente senza passare per un proxy.
  • Proxy personalizzato: abilita il campo Indirizzo Proxy per l'inserimento manuale di un server dedicato.

URL​

In questo campo va inserito l'indirizzo completo dell'endpoint a cui inviare la richiesta. È possibile costruire l'URL in modo dinamico utilizzando parametri.

Autenticazione​

Un menu per selezionare il metodo di autenticazione richiesto dall'API di destinazione. Le opzioni sono:

  • Nessuna: Per API pubbliche che non richiedono credenziali.
  • Basic: Autenticazione standard tramite nome utente e password.
  • Bearer: Autenticazione tramite un token di sicurezza (Bearer Token) che va inserito nell'header della richiesta.

Utente​

Il nome utente per l'autenticazione di tipo Basic.

Password​

La password associata all'utente per l'autenticazione Basic.

Token​

Il campo dove inserire il token di sicurezza quando si utilizza l'autenticazione di tipo Bearer.

Metodo​

Il metodo HTTP da utilizzare per la richiesta, che definisce il tipo di operazione da eseguire

  • GET: Per recuperare dati da una risorsa.
  • POST: Per creare una nuova risorsa.
  • PUT: Per aggiornare completamente una risorsa esistente.

Header​

  • Area di testo dedicata alla definizione degli header HTTP da includere nella richiesta. Gli header devono essere specificati come array di stringhe, in cui ogni elemento rappresenta un header nel formato:
  • Formato richiesto: ["Chiave: Valore", "Chiave2: Valore2"]
  • Esempio base: ["Content-Type:application/json;charset=utf-8"] - chiave*: Content-Type e* valore*: application/json;charset=utf-8*
  • Esempio Contenuto e Lingua: ["Content-Type:application/json;charset=utf-8", "Accept: application/json", "Accept-Language: it-IT, it;q=0.9"]

Body​

Un'area di testo per inserire il corpo (payload) della richiesta. Questo campo è utilizzato principalmente con metodi come POST e PUT per inviare i dati da creare o modificare. Per garantire che il contenuto del JSON venga interpretato correttamente, è necessario utilizzare la direttiva “string:”.

Esempio:

string:{
 "state": "#>state<#",
 "work_notes": "#>work notes<#"
}

Esempio d'uso

Parametri di Output

Una volta che il servizio esterno ha risposto alla chiamata, il Task espone i seguenti parametri di output, che sono cruciali per elaborare il risultato della richiesta:

  • headers: Contiene gli header della risposta inviati dal server.
  • response: Contiene il corpo (body) della risposta inviata dal server.
  • result: Indica lo stato complessivo dell'esecuzione del Task.
  • resultJson: rappresenta il risultato dell’esecuzione del task in formato JSON, includendo informazioni generali, configurazioni e dettagli sull’esecuzione.
  • httpCode: Restituisce il codice di stato HTTP della risposta.
  • 200 (OK), 201 (Created): La richiesta ha avuto successo.
  • 400 (Bad Request), 401 (Unauthorized), 404 (Not Found): Errore lato client.
  • 500 (Internal Server Error): Errore lato server.

Esempio parametro resultJson​

{
 "id": 18672,
 "name": "REST Call",
 "description": "",
 "type": "auth-url",
 "type_name": "Chiamata REST",
 "type_description": "Chiamate REST",
 "config": {
 "ssl": "no",
 "body": "",
 "proxy": "system",
 "header": "",
 "method": "GET",
 "output_links": [
 {
 "to": "[TASK 1401_18682_48]",
 "from": "[TASK 1401_18672_1]",
 "text": "Condizione 14",
 "color": "green",
 "toPort": "left3",
 "fromPort": "port_1401_18672_1",
 "isTraversed": true
 }
 ],
 "proxy_address": ""
 },
 "run_info": {
 "run_id": 1451812,
 "start_datetime": "2026-03-16 11:44:56",
 "end_datetime": "2026-03-16 11:44:56",
 "status": "Completed",
 "run_result": "Success",
 "result_text": "Request URL: https://jsonplaceholder.typicode.com/posts/1 - Method: GET - Status: 200"
 },
 "output_parameters": {
 "headers": "{\"Date\":[\"Mon, 16 Mar 2026 10:44:56 GMT\"],\"Content-Type\":[\"application\\/json; charset=utf-8\"]}",
 "httpCode": "200",
 "response": "{\n \"userId\": 1,\n \"id\": 1,\n \"title\": \"sunt aut facere...\",\n \"body\": \"quia et suscipit...\"\n}"
 }
}